Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
Updates repository documentation to better explain the repo’s purpose/structure and adds a reference page documenting Grafana dashboard locations and conventions.
Changes:
- Refresh
README.mdto describe the repo and provide an updated directory layout. - Add new reference doc for Grafana dashboards and link it from the reference index.
- Update
docs/reference/index.rstto include the new reference page in the toctree.
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 4 comments.
| File | Description |
|---|---|
README.md |
Replaces WIP README content with a purpose statement, updated repo layout, and pointer to docs/. |
docs/reference/index.rst |
Adds grafana-dashboards to the reference toctree. |
docs/reference/grafana-dashboards.md |
New reference page describing dashboard directories and JSON conventions. |
cbartz
commented
Apr 30, 2026
cbartz
requested review from
florentianayuwono,
javierdelapuente,
weiiwang01,
yanksyoon and
yhaliaw
as code owners
florentianayuwono
approved these changes
Apr 30, 2026
yanksyoon
approved these changes
Apr 30, 2026
Adds a Charms section with role-level descriptions of planner-operator and webhook-gateway-operator, and a Documentation section linking to the Read the Docs site, following the Canonical starter pack template.
The changelog already contains entries beyond the two charms (e.g. the enable-log-forwarding GitHub Action). Update the preamble to reflect that the changelog tracks user-relevant changes across charms, applications, actions, and dashboards.
Replace inline charm descriptions with a link to the RTD reference page to avoid duplication, and reference the community Go project layout to clarify the cmd/ and internal/ convention.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What this PR does
Update the README with purpose and structure of the repo, and move Grafana dashboard conventions to a new reference doc page.
Why we need it
The README is not providing a lot of information and is still marking the repo as WIP, though the charms are already used in production.
Checklist
CONTRIBUTING.mdhas been updated upon changes to the contribution/development process (e.g. changes to the way tests are run)docs/changelog.mdwith user-relevant changes(e.g., in
.github/workflows/integration_tests.yaml, ensure themoduleslist is correct)terraform fmtpasses andtflintreports no errors