[discourse-gatekeeper] Migrate charm docs

[github-actions]

This pull request was autogenerated by discourse-gatekeeper to migrate existing documentation from server to the git repository.

[merkata]

I see this notably adds a Contents section, the rest of the changes seem to remove and add the same thing...

[jdkandersson]

I see this notably adds a Contents section, the rest of the changes seem to remove and add the same thing...

@merkata the change is related to whether there is a final new line or not. On discourse, trailing and leading new lines are removed so in our documentation files we shouldn't add trailing new lines if we want to avoid these kind of changes. It is hard to know in the action whether the trailing lines are or aren't intended so if we add them back in then we could equally get PRs adding them when they are not intended by the maintainers on GitHub

[github-actions]

Test coverage for dc3c8e3

Name                         Stmts   Miss Branch BrPart  Cover   Missing
------------------------------------------------------------------------
src/charm.py                   433     98    107     25    75%   79-80, 86-88, 112-113, 117-119, 155-157, 168->180, 178, 221-229, 241-245, 276, 356-361, 384, 401-402, 411-434, 452-454, 462-465, 472, 475-476, 492, 496-501, 546->549, 562-563, 565-566, 600-607, 631-632, 644-646, 661-662, 690-691, 693-694, 696-697, 771->773, 834-835, 851, 869-871, 875
src/charm_state.py              75      6     10      0    91%   90-97
src/errors.py                   38      0      0      0   100%
src/event_timer.py              42      8      4      0    74%   94-97, 117-120
src/firewall.py                 43     25     10      0    38%   38-42, 64-67, 75-149
src/github_client.py            68      6     32      3    87%   124, 146, 158-165, 183->216
src/github_metrics.py           14      0      0      0   100%
src/github_type.py              50      0      0      0   100%
src/lxd_type.py                 37      0      2      0   100%
src/metrics.py                  73      2     10      1    96%   61->64, 170-171
src/metrics_type.py              6      0      0      0   100%
src/runner.py                  320     70     96     24    73%   44->46, 125, 252-253, 294-303, 327-332, 337, 357, 361-371, 420->423, 426-428, 435, 449, 459, 463, 465, 480, 506-511, 527-540, 551-590, 595, 633, 679-681, 685, 703, 738, 764, 769-781, 795, 800->802, 805-807
src/runner_logs.py              35      2      6      1    93%   62->61, 66-67
src/runner_manager.py          271     45     90      8    83%   122, 167-169, 182-183, 195-197, 203-208, 212-213, 223-224, 243, 321-323, 388, 407-411, 436, 488-491, 527, 633-646, 656, 661-672
src/runner_manager_type.py      33      0      6      0   100%
src/runner_metrics.py          123      8     20      2    93%   147-148, 160, 191-192, 307-311
src/runner_type.py              45      0     10      0   100%
src/shared_fs.py                80     10     12      0    89%   73-74, 160-161, 166-167, 173-174, 196-197
src/utilities.py                68      6     20      8    84%   74->76, 78->84, 89-91, 121, 135, 173, 226
------------------------------------------------------------------------
TOTAL                         1854    286    435     72    82%

Static code analysis report

Run started:2024-01-12 10:42:05.500606

Test results:
  No issues identified.

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

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):