Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore(docs): Set up Charmhub docs and update tutorial. #74

Merged
merged 3 commits into from
Oct 11, 2024

Conversation

alithethird
Copy link
Contributor

@alithethird alithethird commented Oct 11, 2024

Applicable specs: ISD-2284, ISD-2303, ISD-2317

Overview

Created the Discourse topics for documents and tied it up to Charmhub.

Rationale

Module Changes

Checklist

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

@alithethird alithethird added the documentation Improvements or additions to documentation label Oct 11, 2024
@alithethird alithethird requested a review from a team as a code owner October 11, 2024 11:16
arturo-seijas
arturo-seijas previously approved these changes Oct 11, 2024
Copy link
Contributor

@erinecon erinecon left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hi, thanks for updating the docs!

Could you also update the docs/reference/actions.md file to add the following line at the end:

Read more about actions in the Juju docs: Action

charm/docs/index.md Outdated Show resolved Hide resolved
amandahla
amandahla previously approved these changes Oct 11, 2024
Copy link

@amandahla amandahla left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

Copy link

Test coverage for 75b216a

Name                                                              Stmts   Miss Branch BrPart  Cover   Missing
-------------------------------------------------------------------------------------------------------------
httprequest_lego_provider/__init__.py                                 0      0      0      0   100%
httprequest_lego_provider/apps.py                                     4      0      0      0   100%
httprequest_lego_provider/dns.py                                     68      0      4      0   100%
httprequest_lego_provider/forms.py                                   21      0      2      0   100%
httprequest_lego_provider/management/__init__.py                      0      0      0      0   100%
httprequest_lego_provider/management/commands/__init__.py             0      0      0      0   100%
httprequest_lego_provider/management/commands/allow_domains.py       21      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        22      0      4      0   100%
httprequest_lego_provider/management/commands/revoke_domains.py      21      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                                   9      0      0      0   100%
httprequest_lego_provider/serializers.py                             24      0      0      0   100%
httprequest_lego_provider/urls.py                                     8      0      0      0   100%
httprequest_lego_provider/views.py                                   74      0     16      0   100%
-------------------------------------------------------------------------------------------------------------
TOTAL                                                               294      0     30      0   100%

Static code analysis report

Run started:2024-10-11 13:16:17.088231

Test results:
  No issues identified.

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

Copy link
Contributor

@erinecon erinecon left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good -- thanks so much!

@alithethird alithethird merged commit 175728f into main Oct 11, 2024
17 checks passed
@alithethird alithethird deleted the update-docs branch October 11, 2024 13:45
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants