Skip to content
This repository was archived by the owner on Jul 28, 2026. It is now read-only.

Update cross reference syntax in Agent static mode documentation - #4814

Merged
clayton-cornell merged 20 commits into
mainfrom
docs/update-reference-styles
Aug 22, 2023
Merged

Update cross reference syntax in Agent static mode documentation#4814
clayton-cornell merged 20 commits into
mainfrom
docs/update-reference-styles

Conversation

@clayton-cornell

Copy link
Copy Markdown
Contributor

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

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

@clayton-cornell clayton-cornell added the type/docs Docs Squad label across all Grafana Labs repos label Aug 15, 2023
clayton-cornell and others added 6 commits August 15, 2023 10:09
@jdbaldry
jdbaldry force-pushed the docs/update-reference-styles branch from cb0a2ff to 98403d7 Compare August 16, 2023 08:31
Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
@jdbaldry
jdbaldry force-pushed the docs/update-reference-styles branch from f1a8f94 to a1a08a8 Compare August 16, 2023 08:49
@clayton-cornell clayton-cornell changed the title Update cross reference syntax in Agent documentation Update cross reference syntax in Agent static mode documentation Aug 17, 2023
@clayton-cornell
clayton-cornell marked this pull request as ready for review August 17, 2023 18:31
@clayton-cornell
clayton-cornell requested a review from a team as a code owner August 17, 2023 18:31
@clayton-cornell
clayton-cornell requested review from a team and removed request for a team August 17, 2023 18:31

@rfratto rfratto left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

When do we have to use this new syntax? The syntax is pretty intense.

@rfratto rfratto left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Rubber stamp :)

@clayton-cornell

Copy link
Copy Markdown
Contributor Author

When do we have to use this new syntax? The syntax is pretty intense.

I've asked for clarification...

@clayton-cornell

Copy link
Copy Markdown
Contributor Author

Merging. I'll test in Cloud once it's live. Next step is to migrate Flow docs to the same doc/reference format.

@clayton-cornell
clayton-cornell merged commit 0cd4d26 into main Aug 22, 2023
@clayton-cornell
clayton-cornell deleted the docs/update-reference-styles branch August 22, 2023 19:20
@grafanabot

Copy link
Copy Markdown
Contributor

The backport to release-v0.33 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-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.33

Then, create a pull request where the base branch is release-v0.33 and the compare/head branch is backport-4814-to-release-v0.33.

@grafanabot

Copy link
Copy Markdown
Contributor

The backport to release-v0.34 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-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.34

Then, create a pull request where the base branch is release-v0.34 and the compare/head branch is backport-4814-to-release-v0.34.

@grafanabot

Copy link
Copy Markdown
Contributor

The backport to release-v0.35 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-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.35

Then, create a pull request where the base branch is release-v0.35 and the compare/head branch is backport-4814-to-release-v0.35.

jdbaldry added a commit that referenced this pull request Aug 23, 2023
…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>
jdbaldry added a commit that referenced this pull request Aug 23, 2023
…tation (#4893)

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>
clayton-cornell added a commit that referenced this pull request Aug 23, 2023
* 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)
clayton-cornell added a commit that referenced this pull request Aug 23, 2023
* 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)
clayton-cornell added a commit that referenced this pull request Aug 23, 2023
* 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)
clayton-cornell added a commit that referenced this pull request Aug 23, 2023
…) (#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)
grafanabot pushed a commit that referenced this pull request Aug 24, 2023
…tation (#4893)

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>
(cherry picked from commit fa82088)
grafanabot pushed a commit that referenced this pull request Aug 24, 2023
…tation (#4893)

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>
(cherry picked from commit fa82088)
grafanabot pushed a commit that referenced this pull request Aug 24, 2023
…tation (#4893)

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>
(cherry picked from commit fa82088)
jdbaldry added a commit that referenced this pull request Aug 24, 2023
…tation (#4893) (#4924)

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>
(cherry picked from commit fa82088)

Co-authored-by: Jack Baldry <jack.baldry@grafana.com>
clayton-cornell pushed a commit that referenced this pull request Aug 24, 2023
…tation (#4893) (#4923)

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>
(cherry picked from commit fa82088)

Co-authored-by: Jack Baldry <jack.baldry@grafana.com>
clayton-cornell pushed a commit that referenced this pull request Aug 24, 2023
…tation (#4893) (#4922)

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>
(cherry picked from commit fa82088)

Co-authored-by: Jack Baldry <jack.baldry@grafana.com>
clayton-cornell added a commit that referenced this pull request Aug 24, 2023
…) (#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)
clayton-cornell added a commit that referenced this pull request Aug 24, 2023
…) (#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
megumish pushed a commit to megumish/agent that referenced this pull request Aug 25, 2023
…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>
megumish pushed a commit to megumish/agent that referenced this pull request Aug 25, 2023
…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>
grafanabot pushed a commit that referenced this pull request Aug 30, 2023
…tation (#4893)

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>
(cherry picked from commit fa82088)
@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 22, 2024
@github-actions github-actions Bot locked as resolved and limited conversation to collaborators Feb 22, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

backport release-v0.33 backport release-v0.34 backport release-v0.35 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.

4 participants