Update cross reference syntax in Agent static mode documentation - #4814
Conversation
Allows interpoloation of the `<GRAFANA VERSION>` variable used in the `docs/reference` shortcode. Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
cb0a2ff to
98403d7
Compare
Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
f1a8f94 to
a1a08a8
Compare
rfratto
left a comment
There was a problem hiding this comment.
When do we have to use this new syntax? The syntax is pretty intense.
I've asked for clarification... |
|
Merging. I'll test in Cloud once it's live. Next step is to migrate Flow docs to the same doc/reference format. |
|
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-4814-to-release-v0.33 origin/release-v0.33
# Cherry-pick the merged commit of this pull request and resolve the conflicts
git cherry-pick -x 0cd4d262ed65f1999f5d142fd5470ac1fdcc0e38
# Push it to GitHub
git push --set-upstream origin backport-4814-to-release-v0.33
git switch main
# Remove the local backport branch
git branch -D backport-4814-to-release-v0.33Then, create a pull request where the |
|
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-4814-to-release-v0.34 origin/release-v0.34
# Cherry-pick the merged commit of this pull request and resolve the conflicts
git cherry-pick -x 0cd4d262ed65f1999f5d142fd5470ac1fdcc0e38
# Push it to GitHub
git push --set-upstream origin backport-4814-to-release-v0.34
git switch main
# Remove the local backport branch
git branch -D backport-4814-to-release-v0.34Then, create a pull request where the |
|
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-4814-to-release-v0.35 origin/release-v0.35
# Cherry-pick the merged commit of this pull request and resolve the conflicts
git cherry-pick -x 0cd4d262ed65f1999f5d142fd5470ac1fdcc0e38
# Push it to GitHub
git push --set-upstream origin backport-4814-to-release-v0.35
git switch main
# Remove the local backport branch
git branch -D backport-4814-to-release-v0.35Then, create a pull request where the |
…tation The PR CI was already fixed in #4814 but I neglected to update the CD pipelines. Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
* First pass at updating references * Remove note admonition * Adjust ref syntax * Trying different syntax * Restory syntax to documented style * Ensure that Hugo knows the documentation is versioned Allows interpoloation of the `<GRAFANA VERSION>` variable used in the `docs/reference` shortcode. Signed-off-by: Jack Baldry <jack.baldry@grafana.com> * Use more appropriate version variable Signed-off-by: Jack Baldry <jack.baldry@grafana.com> * Update cross references in setup * Update install cross references * Update cross refs in api and operations * First pass at updating conf refs * Fix remaining cross refs * Convert to relative links for cloud * Fix URL sytnax --------- Signed-off-by: Jack Baldry <jack.baldry@grafana.com> Co-authored-by: Jack Baldry <jack.baldry@grafana.com> (cherry picked from commit 0cd4d26)
* First pass at updating references * Remove note admonition * Adjust ref syntax * Trying different syntax * Restory syntax to documented style * Ensure that Hugo knows the documentation is versioned Allows interpoloation of the `<GRAFANA VERSION>` variable used in the `docs/reference` shortcode. Signed-off-by: Jack Baldry <jack.baldry@grafana.com> * Use more appropriate version variable Signed-off-by: Jack Baldry <jack.baldry@grafana.com> * Update cross references in setup * Update install cross references * Update cross refs in api and operations * First pass at updating conf refs * Fix remaining cross refs * Convert to relative links for cloud * Fix URL sytnax --------- Signed-off-by: Jack Baldry <jack.baldry@grafana.com> Co-authored-by: Jack Baldry <jack.baldry@grafana.com> (cherry picked from commit 0cd4d26)
* First pass at updating references * Remove note admonition * Adjust ref syntax * Trying different syntax * Restory syntax to documented style * Ensure that Hugo knows the documentation is versioned Allows interpoloation of the `<GRAFANA VERSION>` variable used in the `docs/reference` shortcode. Signed-off-by: Jack Baldry <jack.baldry@grafana.com> * Use more appropriate version variable Signed-off-by: Jack Baldry <jack.baldry@grafana.com> * Update cross references in setup * Update install cross references * Update cross refs in api and operations * First pass at updating conf refs * Fix remaining cross refs * Convert to relative links for cloud * Fix URL sytnax --------- Signed-off-by: Jack Baldry <jack.baldry@grafana.com> Co-authored-by: Jack Baldry <jack.baldry@grafana.com> (cherry picked from commit 0cd4d26)
…) (#4903) * First pass at updating references * Remove note admonition * Adjust ref syntax * Trying different syntax * Restory syntax to documented style * Ensure that Hugo knows the documentation is versioned Allows interpoloation of the `<GRAFANA VERSION>` variable used in the `docs/reference` shortcode. Signed-off-by: Jack Baldry <jack.baldry@grafana.com> * Use more appropriate version variable Signed-off-by: Jack Baldry <jack.baldry@grafana.com> * Update cross references in setup * Update install cross references * Update cross refs in api and operations * First pass at updating conf refs * Fix remaining cross refs * Convert to relative links for cloud * Fix URL sytnax --------- Signed-off-by: Jack Baldry <jack.baldry@grafana.com> Co-authored-by: Jack Baldry <jack.baldry@grafana.com> (cherry picked from commit 0cd4d26)
…) (#4904) * First pass at updating references * Remove note admonition * Adjust ref syntax * Trying different syntax * Restory syntax to documented style * Ensure that Hugo knows the documentation is versioned Allows interpoloation of the `<GRAFANA VERSION>` variable used in the `docs/reference` shortcode. Signed-off-by: Jack Baldry <jack.baldry@grafana.com> * Use more appropriate version variable Signed-off-by: Jack Baldry <jack.baldry@grafana.com> * Update cross references in setup * Update install cross references * Update cross refs in api and operations * First pass at updating conf refs * Fix remaining cross refs * Convert to relative links for cloud * Fix URL sytnax --------- Signed-off-by: Jack Baldry <jack.baldry@grafana.com> Co-authored-by: Jack Baldry <jack.baldry@grafana.com> (cherry picked from commit 0cd4d26)
…) (#4905) * Update cross reference syntax in Agent static mode documentation (#4814) * First pass at updating references * Remove note admonition * Adjust ref syntax * Trying different syntax * Restory syntax to documented style * Ensure that Hugo knows the documentation is versioned Allows interpoloation of the `<GRAFANA VERSION>` variable used in the `docs/reference` shortcode. Signed-off-by: Jack Baldry <jack.baldry@grafana.com> * Use more appropriate version variable Signed-off-by: Jack Baldry <jack.baldry@grafana.com> * Update cross references in setup * Update install cross references * Update cross refs in api and operations * First pass at updating conf refs * Fix remaining cross refs * Convert to relative links for cloud * Fix URL sytnax --------- Signed-off-by: Jack Baldry <jack.baldry@grafana.com> Co-authored-by: Jack Baldry <jack.baldry@grafana.com> (cherry picked from commit 0cd4d26) * Apply suggestions from code review
…fana-cold-storage#4814) * First pass at updating references * Remove note admonition * Adjust ref syntax * Trying different syntax * Restory syntax to documented style * Ensure that Hugo knows the documentation is versioned Allows interpoloation of the `<GRAFANA VERSION>` variable used in the `docs/reference` shortcode. Signed-off-by: Jack Baldry <jack.baldry@grafana.com> * Use more appropriate version variable Signed-off-by: Jack Baldry <jack.baldry@grafana.com> * Update cross references in setup * Update install cross references * Update cross refs in api and operations * First pass at updating conf refs * Fix remaining cross refs * Convert to relative links for cloud * Fix URL sytnax --------- Signed-off-by: Jack Baldry <jack.baldry@grafana.com> Co-authored-by: Jack Baldry <jack.baldry@grafana.com>
…tation (grafana-cold-storage#4893) The PR CI was already fixed in grafana-cold-storage#4814 but I neglected to update the CD pipelines. Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
PR Description
Topic cross references need to be updated to allow for the fact that the Agent documentation is being reused in the Grafana Cloud documentation.
See https://grafana.com/docs/writers-toolkit/write/shortcodes/#docsreference-shortcode for details of the shortcode used to accomplish this cross referencing from different documentation trees.
Which issue(s) this PR fixes
Notes to the Reviewer
PR Checklist