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

Merged
merged 3 commits into from
Sep 10, 2024
Merged

Update docs #48

merged 3 commits into from
Sep 10, 2024

Conversation

erinecon
Copy link
Contributor

@erinecon erinecon commented Sep 6, 2024

Overview

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

Rationale

  • Tutorial: Fixed outdated commands, updated headings to have consistent grammar, formatted two items as notes
  • How-to guide: Fixed a fragmented sentence, capitalised Jenkins where appropriate, "arch" --> "architecture", removed the assumption about x86_64 arch and turned it into an example
  • Explanation: Capitalised Jenkins where appropriate

Juju Events Changes

None

Module Changes

None

Library Changes

None

Checklist

- Fixed outdated commands
- Updated headings to have consistent grammar
- Formatted two items as notes
- Fixed a fragmented sentence
- Capitalised Jenkins where appropriate 
- "arch" --> "architecture" 
- Removed the assumption about x86_64 arch and turned it into an example
@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:53
Copy link
Contributor

github-actions bot commented Sep 6, 2024

Test coverage for 6060275

Name                    Stmts   Miss Branch BrPart  Cover   Missing
-------------------------------------------------------------------
src/agent_observer.py      41      0      4      0   100%
src/charm.py               62      0     10      0   100%
src/charm_state.py         58      4      8      1    92%   114, 172-174
src/service.py             98      5     14      5    91%   94-96, 108->120, 135, 167, 204->208, 206->204
-------------------------------------------------------------------
TOTAL                     259      9     36      6    95%

Static code analysis report

Run started:2024-09-06 18:55:12.837641

Test results:
  No issues identified.

Code scanned:
  Total lines of code: 1140
  Total lines skipped (#nosec): 0
  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 200158b into main Sep 10, 2024
16 checks passed
@erinecon erinecon deleted the update-docs branch September 10, 2024 11:05
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: OK trivial This is a trivial PR
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants