-
Notifications
You must be signed in to change notification settings - Fork 487
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
Use cascade variable for Grafana Agent Flow name #5879
Conversation
docs/sources/flow/getting-started/configure-agent-clustering.md
Outdated
Show resolved
Hide resolved
docs/sources/flow/getting-started/distribute-prometheus-scrape-load.md
Outdated
Show resolved
Hide resolved
|
||
1. Discover Probe resources from your Kubernetes cluster. | ||
2. Discover targets or ingresses that match those Probes. | ||
3. Scrape metrics from those endpoints, and forward them to a receiver. | ||
1. Discover targets or ingresses that match those Probes. |
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.
Similar to previous comment (so feel free to ignore if this is intended), but looks like the numbers were all set to 1.
in this ordered list.
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.
Markdown ignores the numbers.. most of the time :-) and numbers the list in sequential order. We suggest to use lazy numbering. I update to lazy when I pass over topics. It's not a must...
docs/sources/flow/reference/components/prometheus.operator.servicemonitors.md
Show resolved
Hide resolved
Co-authored-by: Mischa Thompson <[email protected]>
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.
Cool stuff!
Didn't see anything odd at a scan. Let me know if you want a more in-depth check.
If we start running doc-validator
on these docs, we'll need to make that tool front matter aware because it would understand the H1s to be the literal string.
|
The backport to
To backport manually, run these commands in your terminal: # Fetch latest updates from GitHub
git fetch
# Create a new branch
git switch --create backport-5879-to-release-v0.38 origin/release-v0.38
# Cherry-pick the merged commit of this pull request and resolve the conflicts
git cherry-pick -x af8bced391c91505d6962c44463aced76edbd4cd
# Push it to GitHub
git push --set-upstream origin backport-5879-to-release-v0.38
git switch main
# Remove the local backport branch
git branch -D backport-5879-to-release-v0.38 Then, create a pull request where the |
* Test cascade var for Agent name * Update test cascade * Add more topics using cascade variable * More updates to use cascade * Update concepts topics * Update config language topics * Update getting started part one * Update getting started topics part 2 * Update monitoring topics * Update tutorial topics * Update setup topics * Update reference topics * Updates to various topics * Corrections and fixes * Additional edits and corrections * Fix a conflict * More cleanup for conflict * Apply suggestions from code review Co-authored-by: Mischa Thompson <[email protected]> * Fix the heading text --------- Co-authored-by: Mischa Thompson <[email protected]> (cherry picked from commit af8bced)
* Test cascade var for Agent name * Update test cascade * Add more topics using cascade variable * More updates to use cascade * Update concepts topics * Update config language topics * Update getting started part one * Update getting started topics part 2 * Update monitoring topics * Update tutorial topics * Update setup topics * Update reference topics * Updates to various topics * Corrections and fixes * Additional edits and corrections * Fix a conflict * More cleanup for conflict * Apply suggestions from code review Co-authored-by: Mischa Thompson <[email protected]> * Fix the heading text --------- Co-authored-by: Mischa Thompson <[email protected]> (cherry picked from commit af8bced)
* Test cascade var for Agent name * Update test cascade * Add more topics using cascade variable * More updates to use cascade * Update concepts topics * Update config language topics * Update getting started part one * Update getting started topics part 2 * Update monitoring topics * Update tutorial topics * Update setup topics * Update reference topics * Updates to various topics * Corrections and fixes * Additional edits and corrections * Fix a conflict * More cleanup for conflict * Apply suggestions from code review Co-authored-by: Mischa Thompson <[email protected]> * Fix the heading text --------- Co-authored-by: Mischa Thompson <[email protected]>
PR Description
This PR adds in a cascade variable for the Grafana Agent Flow product name in the documentation.
Two cascade variables are declared:
PRODUCT_NAME
= Grafana Agent FlowPRODUCT_ROOT_NAME
= Grafana AgentI used two variables here because there is crossover between Static, Flow, and Operator. Some of the text refers to Grafana Agent in general, and some refers to Grafana Agent Flow (content that is specific to Flow). Using
PRODUCT_ROOT_NAME
is an easy future proofing way to deal with this without rewriting the text. When the time comes to only use a single product name, it will be easy to grep for the variable and update the topics.ToDo:
agent
is used as a general term for Grafana Agent Static/Operator/Flow (sometimes one of these, sometimes combinations of these)Which issue(s) this PR fixes
Notes to the Reviewer
PR Checklist