canonical / wordpress-k8s-operator

wordpress-k8s-operator - charm repository.
Apache License 2.0
13 stars 7 forks source link

Update the tutorial #240

Closed erinecon closed 1 month ago

erinecon commented 1 month ago

Overview

Three changes to the tutorial for standardisation among all IS charms. In addition, some smaller changes to fix capitalisation and update the headers.

Rationale

  1. Update the title to move away from "Quick start"/"Getting started" and follow the convention "Deploy X charm for the first time". (ISD-2256)
  2. Update the Prerequisites section to be named Requirements (ISD-2262)
  3. Add instructions to check juju status and example terminal output from that command. (ISD-2277)

Juju Events Changes

None

Module Changes

None

Library Changes

None

Checklist

github-actions[bot] commented 1 month ago

Test coverage for 440333f3815d11dad8b96082d1c7f7c6d73e5b47

Name                Stmts   Miss Branch BrPart  Cover   Missing
---------------------------------------------------------------
src/charm.py          556     35    190     34    91%   162, 204-207, 299->302, 414, 473->477, 626, 657, 663, 680-684, 714, 749-750, 808, 817, 921->934, 933, 935, 940-941, 1001, 1021, 1028, 1118, 1127, 1139, 1160, 1169, 1188, 1192, 1221, 1262, 1394, 1416, 1423->1425, 1468->exit, 1480, 1490, 1528
src/cos.py             20      0      0      0   100%
src/exceptions.py      16      1      2      1    89%   41
src/state.py           33      0      4      0   100%
src/types_.py          15      0      0      0   100%
---------------------------------------------------------------
TOTAL                 640     36    196     35    92%

Static code analysis report

Run started:2024-09-17 14:51:38.633283

Test results:
    No issues identified.

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