Skip to content

docs: link pyroscope docs from charm metadata - #444

Open
geekyNads wants to merge 1 commit into
canonical:mainfrom
geekyNads:docs/link-pyroscope-docs
Open

geekyNads wants to merge 1 commit into
canonical:mainfrom
geekyNads:docs/link-pyroscope-docs

Conversation

@geekyNads

Copy link
Copy Markdown

Fixes #443

Update the documentation links in both Pyroscope charm metadata files to point directly to the Charmed Pyroscope HA documentation instead of the generic Observability documentation landing page.

This makes the Pyroscope documentation directly discoverable from Charmhub for both:

  • pyroscope-coordinator-k8s
  • pyroscope-worker-k8s

Issue

The Pyroscope documentation is not directly discoverable from Charmhub or the Observability documentation. The charm metadata currently links to the generic Observability documentation instead of the Pyroscope documentation.

Solution

Updated the documentation links in the coordinator and worker charm metadata to point directly to the Charmed Pyroscope HA documentation.

Context

Charmed Pyroscope consists of the coordinator and worker charms, which work together as part of the Pyroscope solution. Linking directly to the solution documentation makes the relevant deployment and operational information easier to find from Charmhub.

Testing Instructions

Verify that the documentation links in both coordinator/charmcraft.yaml and worker/charmcraft.yaml point to the Charmed Pyroscope HA documentation and that the URL is accessible.

Upgrade Notes

No upgrade steps are required. This change only updates documentation links and does not affect charm functionality or deployment behaviour.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

docs: link pyroscope docs to COS docs or charmhub.io docs

1 participant