-
Notifications
You must be signed in to change notification settings - Fork 3
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
Add index.md #1850
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Nice!
There was a problem hiding this 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
?
Co-authored-by: Christopher Bartz <[email protected]>
341c1d4
Co-authored-by: Christopher Bartz <[email protected]>
Co-authored-by: Christopher Bartz <[email protected]>
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
src-docs
urgent
,trivial
,complex
)pyproject.toml
androckcraft.yaml