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

Update docs #281

Merged
merged 7 commits into from
Aug 28, 2024
Merged

Update docs #281

merged 7 commits into from
Aug 28, 2024

Conversation

erinecon
Copy link
Contributor

Overview

Smaller documentation changes that are specific to the Discourse charm

Rationale

  • Index page: Fixed outdated link
  • Tutorial: Reformatted one sentence as a note; split up the first block of commands into smaller steps to improve readability (especially for novice users)
  • How-to guides: Capitalising non-code references to Juju and Discourse; updated an outdated link; some small grammar changes

Juju Events Changes

None

Module Changes

None

Library Changes

None

Checklist

Formatted the note about the PostgreSQL extensions as a note

Split up the first block of code into smaller steps
Capitalise Discourse and Juju where appropriate
Capitalise Discourse
Changed a comma to a semicolon
Add a comma
Capitalise Discourse
Update outdated link
@erinecon erinecon added documentation Improvements or additions to documentation trivial labels Aug 27, 2024
@erinecon erinecon requested a review from a team as a code owner August 27, 2024 14:39
Copy link
Contributor

Test coverage for bb80b5b

Name              Stmts   Miss Branch BrPart  Cover   Missing
-------------------------------------------------------------
src/charm.py        371     41     94     15    88%   184, 192-193, 205, 337->345, 378->383, 395, 577-579, 584-585, 597-599, 604-605, 617-619, 642-644, 686->exit, 696->exit, 745-748, 758-759, 783-784, 796-797, 824-826, 828->833, 830-831, 873-874, 890-891, 901->exit, 915
src/database.py      29      1      8      1    95%   56
-------------------------------------------------------------
TOTAL               400     42    102     16    88%

Static code analysis report

Run started:2024-08-27 14:41:41.409650

Test results:
  No issues identified.

Code scanned:
  Total lines of code: 2337
  Total lines skipped (#nosec): 2
  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):

@erinecon erinecon merged commit be8357c into main Aug 28, 2024
19 checks passed
@erinecon erinecon deleted the update-docs branch August 28, 2024 11:37
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 Libraries: OK trivial
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants