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

Merged
merged 13 commits into from
Sep 9, 2024
Merged

Update docs #189

merged 13 commits into from
Sep 9, 2024

Conversation

erinecon
Copy link
Contributor

@erinecon erinecon commented Sep 6, 2024

Overview

Small changes to the documentation that are specific to the jenkins-k8s charm.

Rationale

  • Index: Fixed outdated links
  • Tutorial: Fixed outdated commands, removed broken links, capitalised Juju and MicroK8s where appropriate, grammatical changes
  • How-to guides: Fixed outdated commands, updated links, grammatical changes, fixed headers and capitalisation
  • Reference: Grammatical changes

Juju Events Changes

None

Module Changes

None

Library Changes

None

Checklist

- Capitalise Juju and MicroK8s where appropriate
- Update outdated commands
- Remove broken links in the "What you'll do" section
- Remove words for conciseness
- Capitalise Pebble where appropriate
- Update list items to contain the same grammatical structure.
- Moved the code block higher in the section (I think it makes more sense for the `update-status` text to appear after the code block; please let me know if you disagree!)
- Fixed a fragmented sentence
- Other grammatical changes
- Capitalise Juju where appropriate
- Change the "considerations" header to be one level lower than the "how to" header
I removed the `--wait` flag because it now requires an argument. I'm not opposed to adding it back, but I would need guidance on an appropriate value to include.
Made "Networking considerations" heading one level lower than the "how to" heading.
Removed the second section and moved text around for conciseness. Also updated the steps to have the same grammatical structure.
Fix broken links; small grammatical changes
Updated an outdated command (removed the `--wait` flag, but not opposed to putting it back in); explicitly labeled the password as new
Fixed a fragmented sentence; grammatical change in last sentence
@erinecon erinecon added documentation Improvements or additions to documentation trivial This is a trivial PR labels Sep 6, 2024
@erinecon erinecon requested a review from a team as a code owner September 6, 2024 18:19
Copy link
Contributor

github-actions bot commented Sep 6, 2024

Test coverage for 6dd3551

Name                Stmts   Miss Branch BrPart  Cover   Missing
---------------------------------------------------------------
src/actions.py         29      0      4      0   100%
src/agent.py          119      0     20      0   100%
src/auth_proxy.py      52      0      8      0   100%
src/charm.py           89      0     14      0   100%
src/cos.py             20      0      0      0   100%
src/ingress.py         16      0      4      0   100%
src/jenkins.py        376      0     60      0   100%
src/pebble.py          25      0      2      0   100%
src/state.py          109      0     24      0   100%
src/timerange.py       30      0      6      0   100%
---------------------------------------------------------------
TOTAL                 865      0    142      0   100%

Static code analysis report

Run started:2024-09-06 18:21:25.767799

Test results:
  No issues identified.

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

Copy link
Collaborator

@yanksyoon yanksyoon 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 0c8772a into main Sep 9, 2024
26 checks passed
@erinecon erinecon deleted the update-docs branch September 9, 2024 17: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 trivial This is a trivial PR
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants