-
Notifications
You must be signed in to change notification settings - Fork 486
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
Replace relrefs with docrefs in Agent concepts and Agent monitoring topics #5603
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.
I'm rubber stamping the PR, but I have a few concerns regarding content duplication:
- Are the Grafana Cloud docs page just a copy pasted version of the Agent docs? Or are they imported from the Agent repo?
- If the GC docs are copy pasted, how do we keep them in sync?
- How does GC decide which version of the Agent to use for docs?
- I don't see a Flow section in the GC Agent docs? I'm not sure why we are adding GC links even though they don't exist? Is it for future proofing?
I personally really think GC should just link to the Agent docs instead of duplicating the content... I can't see an advantage in duplication. Maybe the intent is to make it easier for GC users to find. But I think it's even confusing to the users because when they search our docs they see duplicate pages with the same information.
@ptodev Some answers
The intent is to provide a Cloud-specific doc set (since Cloud is a collection ot things presented as a single solution) vs a scattered set of docs. |
…opics (#5603) * Update relrefs in component metrics topic * Update relrefs in controller metrics topic * Update relrefs in debugging topic * Update relrefs in modules topic * Update relrefs in clustering topic * Update relrefs in component controller topic * Update relrefs in config-language topic (cherry picked from commit 5960333)
…opics (#5603) (#5622) * Update relrefs in component metrics topic * Update relrefs in controller metrics topic * Update relrefs in debugging topic * Update relrefs in modules topic * Update relrefs in clustering topic * Update relrefs in component controller topic * Update relrefs in config-language topic (cherry picked from commit 5960333) Co-authored-by: Clayton Cornell <[email protected]>
@clayton-cornell thank you for clarifying! IMO the approach of always using the latest version works well for Mimir/Loki/Tempo, but it doesn't work so well for the Agent. It's because the databases on the Cloud are naturally always on the latest version, but the Agent runs on the client's machines and the clients may run any version of it. |
PR Description
Which issue(s) this PR fixes
Notes to the Reviewer
PR Checklist