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

Add index.md #1850

Merged
merged 11 commits into from
Sep 13, 2024
Merged

Add index.md #1850

merged 11 commits into from
Sep 13, 2024

Conversation

erinecon
Copy link
Contributor

@erinecon erinecon commented Sep 11, 2024

Overview

Add index.md page

Rationale

This page was the output of documentation practice work for standardising Charmhub documentation. Specifically, the repo-policy-compliance charm was pinpointed as a small charm existing within the larger context of another documentation set (the GitHub runners). Therefore, it's an ideal candidate for a single-page Charmhub doc that covers the bare minimum of the charm and points to the larger doc set.

The page follows a template produced by the Canonical technical authors. Thanks to Christopher for help with filling in the necessary technical details!

Module Changes

None

Checklist

  • The contributing guide was applied
  • The documentation is generated using src-docs
  • The PR is tagged with appropriate label (urgent, trivial, complex)
  • Version has been incremented on pyproject.toml and rockcraft.yaml

@erinecon erinecon added documentation Improvements or additions to documentation trivial labels Sep 11, 2024
@erinecon erinecon requested a review from a team as a code owner September 11, 2024 19:19
amandahla
amandahla previously approved these changes Sep 11, 2024
Copy link
Contributor

@amandahla amandahla left a comment

Choose a reason for hiding this comment

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

Nice!

arturo-seijas
arturo-seijas previously approved these changes Sep 12, 2024
Copy link
Collaborator

@cbartz cbartz left a comment

Choose a reason for hiding this comment

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

Thank you Erin. I have a few comments. You are also right that since there is no code change, a version bump is not required, but I think it would still be good practice to bump it (so that basically every commit on the main maps is to a different version.) Could you bump it from 1.10.1 to 1.10.2?

charm/docs/index.md Outdated Show resolved Hide resolved
charm/docs/index.md Outdated Show resolved Hide resolved
charm/docs/index.md Outdated Show resolved Hide resolved
Co-authored-by: Christopher Bartz <[email protected]>
@erinecon erinecon merged commit 94793e8 into main Sep 13, 2024
9 checks passed
@erinecon erinecon deleted the ISD-2374-index-page branch September 13, 2024 12:57
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 trivial
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants