Replace relrefs with docrefs in Agent install and start topics #5572
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
clayton-cornell
added
type/docs
clayton-cornell
changed the title
erikbaranowski
approved these changes
Oct 24, 2023
clayton-cornell
deleted the
docs/replace-relrefs-with-docrefs-second-patch
branch
grafanabot
pushed a commit
that referenced
this pull request
Oct 24, 2023
* Update links in macOS install topic * Update links in binary install topic * Update ref links on Windows and Kubernetes * Remove start agent from Kubernetes install * Update relrefs in Linux install topic * Update relrefs in docker install topic * Update relrefs in windoows config * Update relrefs in configure linux topic * Update relrefs in start and macos topics * Fix typo in docker topic * Remove extra blank line * Remove redundant info (cherry picked from commit 10cf125)
clayton-cornell
added a commit
that referenced
this pull request
Oct 24, 2023
#5592) * Update links in macOS install topic * Update links in binary install topic * Update ref links on Windows and Kubernetes * Remove start agent from Kubernetes install * Update relrefs in Linux install topic * Update relrefs in docker install topic * Update relrefs in windoows config * Update relrefs in configure linux topic * Update relrefs in start and macos topics * Fix typo in docker topic * Remove extra blank line * Remove redundant info (cherry picked from commit 10cf125) Co-authored-by: Clayton Cornell <[email protected]>
github-actions
bot
added
the
frozen-due-to-age
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
PR Description
The relref shortcode is being deprecated in favour of the docs/reference shortcode. The new shortcode allows us to have more control over the references and links and makes sure that topics mounted into more than one project can have working links within that project.
This PR continues the process of migrating the Flow documentation to use the docs/reference shortcodes as preparation for mounting Flow topics into the Cloud docs
Which issue(s) this PR fixes
Notes to the Reviewer
I removed the Start Agent link from the Deploy Kubernetes topic - seemed to be redundant since the deployment doesn't need a start step (if I understand the K8s install correctly)
A couple of Notes were converted to block quote styled notes to allow doc/reference links within the Note. The doc/reference links do not work when embedded into other shortcodes. The linking works properly in a block quote and the published result is the same.
PR Checklist