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 the tutorial #240

Merged
merged 8 commits into from
Sep 17, 2024
Merged

Update the tutorial #240

merged 8 commits into from
Sep 17, 2024

Conversation

erinecon
Copy link
Contributor

@erinecon erinecon commented Sep 17, 2024

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

Changed "Prerequisites" section to H2 heading
Added a "Steps" H2 heading
Include proper linking for the "What you'll do" section
Update headers to be consistent in grammar
Capitalise Juju where appropriate
Small text edits
Added a call for `juju status` and example output.
@erinecon erinecon added documentation Improvements or additions to documentation trivial This is a trivial PR labels Sep 17, 2024
@erinecon erinecon requested a review from a team as a code owner September 17, 2024 14:49
Copy link
Contributor

@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
Contributor

Test coverage for 440333f

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):

@erinecon erinecon merged commit 4e38dd4 into main Sep 17, 2024
31 checks passed
@erinecon erinecon deleted the tutorial-updates branch September 17, 2024 18:14
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 trivial This is a trivial PR
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants