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

Docs: How-to landing and organization #257

Merged
merged 9 commits into from
Mar 10, 2025
Merged

Docs: How-to landing and organization #257

merged 9 commits into from
Mar 10, 2025

Conversation

erinecon
Copy link
Contributor

@erinecon erinecon commented Mar 4, 2025

Applicable spec: ISD-3048

Overview

Add structure to the WordPress charm how-to guides.

Rationale

Presently, the WordPress charm contains 13 separate how-to guides. This number justifies the establishment of a coherent structure to the guides.

The change is manifested in two ways:

  1. Added a landing page, how-to/index.md, that establishes an order and attempts to tell a coherent story.
  2. Reordered the how-to guides in the overview navigation table so the sidebar on Charmhub will tell the same story.

Juju Events Changes

None

Module Changes

None

Library Changes

None

Checklist

The documentation on Charmhub will be updated once the PR is approved.

@erinecon erinecon added the documentation Improvements or additions to documentation label Mar 4, 2025
@erinecon erinecon requested a review from a team as a code owner March 4, 2025 19:27
@erinecon erinecon requested review from DeeKay3 and alithethird March 4, 2025 19:27
Copy link
Contributor

Test results for commit a7985e1

Test coverage for a7985e1

Name                Stmts   Miss Branch BrPart  Cover   Missing
---------------------------------------------------------------
src/charm.py          576     39    178     35    90%   163, 205-208, 300->303, 415, 474->478, 628, 659, 665, 682-686, 716, 751-752, 812, 821, 888, 930-932, 964->977, 976, 978, 983-984, 1044, 1064, 1071, 1161, 1170, 1182, 1203, 1212, 1231, 1235, 1264, 1305, 1437, 1459, 1466->1468, 1511->exit, 1523, 1533, 1571
src/cos.py             20      0      0      0   100%
src/exceptions.py      16      1      2      1    89%   41
src/state.py           33      0      2      0   100%
src/types_.py          15      0      0      0   100%
---------------------------------------------------------------
TOTAL                 660     40    182     36    91%

Static code analysis report

Run started:2025-03-10 12:11:22.216074

Test results:
  No issues identified.

Code scanned:
  Total lines of code: 4721
  Total lines skipped (#nosec): 1
  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 01e2a2b into main Mar 10, 2025
32 checks passed
@erinecon erinecon deleted the how-to-landing branch March 10, 2025 13:06
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: Out of sync
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants