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

Standardise how-to guides and reference pages #291

Merged
merged 5 commits into from
Sep 23, 2024
Merged

Conversation

erinecon
Copy link
Contributor

@erinecon erinecon commented Sep 20, 2024

Overview

Changes to the how-to titles and reference pages to help standardise docs among the IS charms.

Rationale

  • How-to guides (ISD-2296): To follow the convention set in the style guide, change the titles that appear in the table of contents (and left-hand menu on Charmhub) from "How to XYZ" to "XYZ". The titles on the pages were correct and therefore were not changed.
  • Reference "Actions" page (ISD-2302): Added a link to the Juju docs to make the page slightly more useful to new users.
  • Reference "Configurations" page (ISD-2302): Change "Configure" to "Configurations" to match the Charmhub tab; added a link to the Juju docs.
  • Reference "Integrations" page (ISD-2316): Formatting change for all the commands to appear in command blocks; split up the "Interface" and "Supported charms" information onto separate lines

Juju Events Changes

None

Module Changes

None

Library Changes

None

Checklist

@erinecon erinecon added documentation Improvements or additions to documentation trivial labels Sep 20, 2024
@erinecon erinecon requested a review from a team as a code owner September 20, 2024 19:13
Copy link

@yhaliaw yhaliaw left a comment

Choose a reason for hiding this comment

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

Minor formatting comment

docs/reference/configurations.md Show resolved Hide resolved
docs/reference/actions.md Show resolved Hide resolved
For consistency between actions.md and configurations.md
Copy link
Contributor

Test coverage for 4415a67

Name              Stmts   Miss Branch BrPart  Cover   Missing
-------------------------------------------------------------
src/charm.py        373     41     94     15    88%   184, 192-193, 205, 337->345, 378->383, 395, 583-585, 590-591, 603-605, 610-611, 623-625, 648-650, 692->exit, 702->exit, 751-754, 764-765, 789-790, 802-803, 830-832, 834->839, 836-837, 879-880, 896-897, 907->exit, 921
src/database.py      29      1      8      1    95%   56
-------------------------------------------------------------
TOTAL               402     42    102     16    88%

Static code analysis report

Run started:2024-09-23 12:39:35.734219

Test results:
  No issues identified.

Code scanned:
  Total lines of code: 2360
  Total lines skipped (#nosec): 2
  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 50e229a into main Sep 23, 2024
19 checks passed
@erinecon erinecon deleted the standardise-docs branch September 23, 2024 15: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: OK trivial
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants