Skip to content
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

Merged
merged 21 commits into from
Nov 30, 2023

Conversation

clayton-cornell
Copy link
Contributor

@clayton-cornell clayton-cornell commented Nov 28, 2023

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 Flow
  • PRODUCT_ROOT_NAME = Grafana Agent

I 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:

  • Update top level topics
  • Update Concepts
  • Update Configuration Language
  • Update Getting Started
  • Update Monitoring
  • Update Reference
  • Update Setup
  • Update Tutorials
  • Update shared content
  • Search for and fix any missed Grafana Agent, Grafana Agent Flow, Grafana Agent in Flow mode, Flow mode, Flow and other variations on the product name. There are MANY cases where agent is used as a general term for Grafana Agent Static/Operator/Flow (sometimes one of these, sometimes combinations of these)
  • Validate/check/review changes to make sure the wording still makes sense and the correct form of the product name is used

Which issue(s) this PR fixes

Notes to the Reviewer

PR Checklist

  • CHANGELOG.md updated
  • Documentation added
  • Tests updated
  • Config converters updated

@clayton-cornell clayton-cornell marked this pull request as ready for review November 30, 2023 00:44
@clayton-cornell clayton-cornell requested a review from a team November 30, 2023 00:45
@clayton-cornell clayton-cornell added the type/docs Docs Squad label across all Grafana Labs repos label Nov 30, 2023
docs/sources/flow/config-language/_index.md Outdated Show resolved Hide resolved
docs/sources/flow/config-language/syntax.md Outdated Show resolved Hide resolved
docs/sources/flow/monitoring/debugging.md Outdated Show resolved Hide resolved
docs/sources/flow/reference/components/_index.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.
Copy link
Contributor

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.

Copy link
Contributor Author

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/release-notes.md Outdated Show resolved Hide resolved
Copy link
Member

@jdbaldry jdbaldry left a 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.

@clayton-cornell
Copy link
Contributor Author

clayton-cornell commented Nov 30, 2023

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.

doc-validator in the Agent repo needs a big update anyway. I'm using it, but it generates a lot of false positives right now. A thing for a separate PR. :-)

@clayton-cornell clayton-cornell merged commit af8bced into main Nov 30, 2023
9 checks passed
@clayton-cornell clayton-cornell deleted the docs/use-cascade-var-product-name branch November 30, 2023 13:58
@grafanabot
Copy link
Contributor

The backport to release-v0.38 failed:

The process '/usr/bin/git' failed with exit code 1

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 base branch is release-v0.38 and the compare/head branch is backport-5879-to-release-v0.38.

clayton-cornell added a commit that referenced this pull request Nov 30, 2023
* 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)
clayton-cornell added a commit that referenced this pull request Nov 30, 2023
* 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)
BarunKGP pushed a commit to BarunKGP/grafana-agent that referenced this pull request Feb 20, 2024
* 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]>
@github-actions github-actions bot added the frozen-due-to-age Locked due to a period of inactivity. Please open new issues or PRs if more discussion is needed. label Feb 21, 2024
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Feb 21, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
backport release-v0.38 frozen-due-to-age Locked due to a period of inactivity. Please open new issues or PRs if more discussion is needed. type/docs Docs Squad label across all Grafana Labs repos
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants