Create template index.md

[erinecon]

Overview

Include a template for the landing page (index.md) for the charm's documentation. (ISD-2197)

Rationale

Including a template directly in this repo will help maintain consistency between the IS charms, and hopefully the template will save devs some time when they start to put together documentation for the charm.

The page contains some generic text that will likely be applicable to many of the charms created from this template repo, but there are pieces that will obviously need to be changed to match the specifics of the new charm. I tried to include comments to guide the missing pieces.

Note that some text on the landing pages has been copied over from charm to charm, and I did reuse some of that text. However, I made an attempt to cut out jargon (like "day N"). I also tried to keep the template text as concise as possible.

Juju Events Changes

None

Module Changes

None

Library Changes

None

Checklist

• The charm style guide was applied
• The contributing guide was applied
• The changes are compliant with ISD054 - Managing Charm Complexity
• The documentation is generated using src-docs
• The documentation for charmhub is updated
• The PR is tagged with appropriate label (urgent, trivial, complex)

[github-actions]

Test coverage for 463749b

Name           Stmts   Miss Branch BrPart  Cover   Missing
----------------------------------------------------------
src/charm.py      31      0      4      0   100%
----------------------------------------------------------
TOTAL             31      0      4      0   100%

Static code analysis report

Run started:2024-09-20 18:40:00.085946

Test results:
  No issues identified.

Code scanned:
  Total lines of code: 151
  Total lines skipped (#nosec): 0
  Total potential issues skipped due to specifically being disabled (e.g., #nosec BXXX): 0

Run metrics:
  Total issues (by severity):
  	Undefined: 0
  	Low: 0
  	Medium: 0
  	High: 0
  Total issues (by confidence):
  	Undefined: 0
  	Low: 0
  	Medium: 0
  	High: 0
Files skipped (0):