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 #376

Merged
merged 20 commits into from
Sep 17, 2024
Merged

Update docs #376

merged 20 commits into from
Sep 17, 2024

Conversation

erinecon
Copy link
Contributor

Overview

Smaller doc changes after completing the deep dive into the GitHub runner charms.

Rationale

  • Landing page: Fix broken/outdated links
  • Tutorial: Formatting notes; capitalise Juju
  • How-to guides: Grammatical changes; update spelling to British English; fix broken links; reformat notes + words as code; change "Prerequisites" to "Requirements"; update header leveling; capitalisation
  • Reference: Capitalisation; update lists to have consistent grammar in all items
  • Explanation: Update spelling to British English; capitalisation; update lists to have consistent grammar in all items; grammar

Juju Events Changes

None

Module Changes

None

Library Changes

None

Checklist

Reformat a note
Capitalise Juju where appropriate
Add a semicolon
Change "organization" to British spelling
Reformat link in the first sentence
Link repo-policy-compliance README
Format workplace_dispatch, push, and schedule as code
Rewording
Capitalise Juju where appropriate
Add "the" in the first sentence
Prerequisites --> Requirements 
Update the header levels
Prerequisites --> Requirements
Update header levels
Capitalisation
Update broken link 
Reformat a note
Capitalisation
Update spelling to British English
Add commas
Capitalise Juju
Reformat a note
Change last item to match the others in the list
Update to British English
Add "be"
Capitalise Juju where appropriate
Update last item in "GitHub API usage" list to be consistent with the other items
@erinecon erinecon added documentation Improvements or additions to documentation trivial labels Sep 16, 2024
@erinecon erinecon requested a review from a team as a code owner September 16, 2024 15:06
arturo-seijas
arturo-seijas previously approved these changes Sep 17, 2024
amandahla
amandahla previously approved these changes Sep 17, 2024
Copy link
Contributor

Test coverage for 40e92d9

Name                         Stmts   Miss Branch BrPart  Cover   Missing
------------------------------------------------------------------------
src/charm.py                   588    148    149     26    72%   237-239, 305-324, 342-344, 345->349, 375-379, 452, 459-461, 488-493, 510-516, 537, 549-555, 570-571, 584, 589, 619-620, 622->631, 626->631, 636-642, 676, 680-685, 736-741, 750->753, 776-788, 792-793, 821-848, 861-866, 885-895, 909-911, 958-959, 961-962, 964-965, 1044->1046, 1111-1112, 1150-1152, 1160-1166, 1244-1297, 1301
src/charm_state.py             452     17     96      5    95%   271-283, 508-512, 634-635, 690-691, 1126->1129, 1133-1134, 1181
src/errors.py                   25      0      0      0   100%
src/event_timer.py              52      6      0      0    88%   105-106, 143-144, 160-161
src/firewall.py                 51     18     20      0    61%   42-43, 66-69, 111-185
src/github_client.py            23      2      6      1    90%   66->exit, 71-72
src/logrotate.py                43      0      2      0   100%
src/lxd_type.py                 35      0      2      0   100%
src/runner_manager_type.py      51      0      8      0   100%
src/runner_type.py              38      0     10      0   100%
src/shared_fs.py                93     17     10      1    83%   52-53, 120-121, 146-147, 155-156, 162-163, 181, 184-185, 197-198, 241-242
src/utilities.py                32      4      6      2    79%   66-69, 111
------------------------------------------------------------------------
TOTAL                         1483    212    309     35    83%

Static code analysis report

Run started:2024-09-17 13:31:01.959860

Test results:
  No issues identified.

Code scanned:
  Total lines of code: 4953
  Total lines skipped (#nosec): 2
  Total potential issues skipped due to specifically being disabled (e.g., #nosec BXXX): 6

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
Collaborator

@cbartz cbartz left a comment

Choose a reason for hiding this comment

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

LGTM, minor question

docs/how-to/openstack-runner.md Show resolved Hide resolved
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

@erinecon erinecon merged commit e3858e3 into main Sep 17, 2024
40 checks passed
@erinecon erinecon deleted the update-docs branch September 17, 2024 18:03
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
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants