[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.

[jdkandersson]

Note that this documentation is not the intended final documentation, it is just copying in the documentation from discourse

[github-actions]

Test coverage for 9e030ac

Name                    Stmts   Miss Branch BrPart  Cover   Missing
-------------------------------------------------------------------
src/charm.py              429     98    107     25    75%   79-80, 86-88, 112-113, 117-119, 155-157, 167->179, 177, 220-228, 240-244, 275, 352-357, 378, 395-396, 405-428, 446-448, 456-459, 466, 469-470, 486, 491-496, 541->544, 557-558, 560-561, 595-602, 626-627, 639-641, 656-657, 682-683, 685-686, 688-689, 763->765, 826-827, 843, 861-863, 867
src/charm_state.py         50      6      6      0    86%   76-83
src/errors.py              34      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_type.py         36      0      0      0   100%
src/lxd_type.py            37      0      2      0   100%
src/metrics.py             68      2     10      1    96%   60->63, 152-153
src/runner.py             334     70    108     26    74%   49->51, 115, 220-227, 233-239, 266-267, 311-320, 344-349, 354, 374, 378-388, 437->440, 443-445, 452, 466, 476, 480, 482, 497, 545-550, 566-579, 590-622, 627, 665, 711-713, 717, 735, 770, 796, 801-813, 827, 847, 863
src/runner_manager.py     268     26    100      9    89%   166, 223-225, 238-239, 251-253, 259-264, 268-269, 279-280, 299, 411, 430-434, 459, 542, 691, 711
src/runner_metrics.py     112      5     22      2    95%   133-134, 146, 215-216
src/runner_type.py         55      0     12      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                    1656    256    413     71    82%

Static code analysis report

Run started:2023-12-01 03:00:10.448634

Test results:
  No issues identified.

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

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