Skip to content

Update landing pages for reference and how-to - #29

Merged
erinecon merged 2 commits into
mainfrom
docs/landing-page
Oct 8, 2026
Merged

erinecon merged 2 commits into
mainfrom
docs/landing-page

Conversation

@weiiwang01

Copy link
Copy Markdown
Collaborator

What this PR does

Update the landing pages for the reference and how-to guide documentations based on our new standard for landing pages.

Why we need it

Checklist

  • I followed the contributing guide
  • I added or updated the documentation (if applicable)
  • I updated docs/changelog.md with user-relevant changes
  • I added a change artifact for user-relevant changes in docs/release-notes/artifacts. If no change artifact is necessary, I tagged the PR with the label no-release-note.
  • I used AI to assist with preparing this PR
  • I added or updated tests as needed (unit and integration)
  • If integration test modules are used: I updated the workflow configuration
    (e.g., in .github/workflows/integration_tests.yaml, ensure the modules list is correct)
  • If this is a Grafana dashboard: I added a screenshot of the dashboard
  • If this is Terraform: terraform fmt passes and tflint reports no errors
  • If this is Rockcraft: I updated the version

@weiiwang01
weiiwang01 requested a review from a team as a code owner October 8, 2026 17:01
@weiiwang01 weiiwang01 added documentation Improvements or additions to documentation no-release-note This PR does not require a change artifact labels Oct 8, 2026
@weiiwang01
weiiwang01 requested a review from erinecon October 8, 2026 17:01

@erinecon erinecon left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Thanks so much for updating the landing pages!

Comment thread docs/how-to/index.rst Outdated
Comment thread docs/reference/index.rst Outdated
Comment thread docs/reference/index.rst Outdated
Comment thread docs/reference/cryptographic-overview.rst Outdated
Comment thread docs/how-to/index.rst Outdated
Co-authored-by: Erin Conley <erin.conley@canonical.com>
@github-actions

github-actions Bot commented Oct 8, 2026

Copy link
Copy Markdown
Contributor

Test results for commit e3a3db5

Test coverage for e3a3db5

Name           Stmts   Miss Branch BrPart  Cover   Missing
----------------------------------------------------------
src/charm.py      69      0     20      0   100%
----------------------------------------------------------
TOTAL             69      0     20      0   100%

Static code analysis report

Run started:2026-10-08 18:19:16.849428+00:00

Test results:
  No issues identified.

Code scanned:
  Total lines of code: 509
  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):

@github-actions

github-actions Bot commented Oct 8, 2026

Copy link
Copy Markdown
Contributor

Test results for commit e3a3db5

Test coverage for e3a3db5

Name           Stmts   Miss Branch BrPart  Cover   Missing
----------------------------------------------------------
src/charm.py     159     62     52      5    57%   88-89, 112->114, 117-156, 164, 176-185, 212, 221-226, 234-247, 256-266, 283-293, 303-306, 325
----------------------------------------------------------
TOTAL            159     62     52      5    57%

Static code analysis report

Run started:2026-10-08 18:19:14.177208+00:00

Test results:
  No issues identified.

Code scanned:
  Total lines of code: 800
  Total lines skipped (#nosec): 7
  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 left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Thanks 🎉

@erinecon
erinecon merged commit 11f7d87 into main Oct 8, 2026
37 checks passed
@erinecon
erinecon deleted the docs/landing-page branch October 8, 2026 19:58
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 no-release-note This PR does not require a change artifact

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants