Update cross reference syntax in Agent static mode documentation (#4814) - #4903
Conversation
* 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
type/docs
| endpoint. | ||
|
|
||
| Static mode is [configured][] with a YAML file. | ||
| Static mode is [configured][configure] with a YAML file. |
There was a problem hiding this comment.
How does this work? What is shown to the user?
There was a problem hiding this comment.
How does this work? What is shown to the user?
It's in the format [link text][label]. The link text is what's shown to the reader, and the label is what Hugo uses to connect the link text with a URL. So, you can use different link text throughout the topic if you reuse the link destination (defined by the label). This syntax was always possible with the relref shortcode syntax and is reused for docs/reference shortcode.
In this specific case, the reader sees Static mode is configured with a YAML file. and the link under configured is defined on line 89 of this file as [configure]: "/docs/agent/ -> /docs/agent/<AGENT VERSION>/static/configuration" Line 90 defines the link for use in Grafana Cloud docs.
https://grafana.com/docs/writers-toolkit/write/shortcodes/#docsreference-shortcode
github-actions
Bot
added
the
frozen-due-to-age
2 participants
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 thedocs/referenceshortcode.Signed-off-by: Jack Baldry jack.baldry@grafana.com
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)
PR Description
Which issue(s) this PR fixes
Notes to the Reviewer
PR Checklist