Add charm documentation

[arturo-seijas]

Applicable spec: N/A

Overview

Charm documentation

Rationale

N/A

Module Changes

N/A

Checklist

• The contributing guide was applied
• The PR is tagged with appropriate label (urgent, trivial, complex)

[mthaddon]

One minor comment inline, and also, should we maybe put the docs in the charms directory, as these are specific to the charm rather than the application?

[cbartz]

Looks good. Got a few nitpicks.

[yanksyoon]

LGTM, minor nitpicks, thank you!

[yanksyoon]

LGTM!

[yanksyoon]

El gee tee em

[github-actions]

Test coverage for 3943adb

Name                                                              Stmts   Miss Branch BrPart  Cover   Missing
-------------------------------------------------------------------------------------------------------------
httprequest_lego_provider/__init__.py                                 1      0      0      0   100%
httprequest_lego_provider/apps.py                                     5      0      0      0   100%
httprequest_lego_provider/dns.py                                     69      0      8      0   100%
httprequest_lego_provider/forms.py                                   22      0      2      0   100%
httprequest_lego_provider/management/__init__.py                      1      0      0      0   100%
httprequest_lego_provider/management/commands/__init__.py             1      0      0      0   100%
httprequest_lego_provider/management/commands/allow_domains.py       22      0      2      0   100%
httprequest_lego_provider/management/commands/create_user.py         14      0      0      0   100%
httprequest_lego_provider/management/commands/list_domains.py        16      0      2      0   100%
httprequest_lego_provider/management/commands/revoke_domains.py      22      0      2      0   100%
httprequest_lego_provider/migrations/0001_initial.py                  8      0      0      0   100%
httprequest_lego_provider/migrations/__init__.py                      0      0      0      0   100%
httprequest_lego_provider/models.py                                  10      0      0      0   100%
httprequest_lego_provider/serializers.py                             11      0      0      0   100%
httprequest_lego_provider/urls.py                                     8      0      0      0   100%
httprequest_lego_provider/views.py                                   49      0      8      0   100%
-------------------------------------------------------------------------------------------------------------
TOTAL                                                               259      0     24      0   100%

Static code analysis report

Run started:2024-03-06 09:57:11.572382

Test results:
  No issues identified.

Code scanned:
  Total lines of code: 1385
  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):