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

Merged
merged 8 commits into from
Oct 7, 2024
Merged

Update docs #241

merged 8 commits into from
Oct 7, 2024

Conversation

erinecon
Copy link
Contributor

@erinecon erinecon commented Oct 2, 2024

Overview

Changes to the index page and reference pages to establish consistent standards among the IS charms.

Rationale

  • ISD-2294: Adopted template landing page (added title, removed jargon, updated contribute link)
  • ISD-2307: Updated actions and configurations reference page (configure --> configurations, added links to Juju docs)
  • ISD-2321: Updated integrations reference page (relate --> integrate, put commands into command blocks, updated formatting)

Juju Events Changes

None

Module Changes

None

Library Changes

None

Checklist

Adopted template landing page:
- Added title
- Removed jargon
- Updated contribute link
Added link to Juju docs
Added link to Juju docs
- Update formatting of "Interface" and "Supported charms" lines
- Put commands into command blocks
- Change relate to integrate
@erinecon erinecon added documentation Improvements or additions to documentation trivial This is a trivial PR labels Oct 2, 2024
@erinecon erinecon requested a review from a team as a code owner October 2, 2024 18:39
arturo-seijas
arturo-seijas previously approved these changes Oct 3, 2024
Update _run_cli function so it doesn't throw a too-many-positional-arguments error
Update connect, exec and push functions so they don't throw a too-many-positional-arguments error
docs/index.md Outdated Show resolved Hide resolved
Copy link
Contributor

github-actions bot commented Oct 4, 2024

Test coverage for 3adc3ff

Name                Stmts   Miss Branch BrPart  Cover   Missing
---------------------------------------------------------------
src/charm.py          557     35    190     34    91%   162, 204-207, 299->302, 414, 473->477, 627, 658, 664, 681-685, 715, 750-751, 811, 820, 924->937, 936, 938, 943-944, 1004, 1024, 1031, 1121, 1130, 1142, 1163, 1172, 1191, 1195, 1224, 1265, 1397, 1419, 1426->1428, 1471->exit, 1483, 1493, 1531
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                 641     36    196     35    92%

Static code analysis report

Run started:2024-10-04 19:22:26.511712

Test results:
  No issues identified.

Code scanned:
  Total lines of code: 4647
  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 093c6c5 into main Oct 7, 2024
31 checks passed
@erinecon erinecon deleted the update-docs branch October 7, 2024 13:34
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.

5 participants