Update Agent documentation to use doc/reference instead of relrefs #5555
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
erikbaranowski
approved these changes
Oct 24, 2023
docs/sources/flow/getting-started/configure-agent-clustering.md
Outdated
Show resolved
Hide resolved
docs/sources/flow/getting-started/distribute-prometheus-scrape-load.md
Outdated
Show resolved
Hide resolved
docs/sources/flow/getting-started/opentelemetry-to-lgtm-stack.md
Outdated
Show resolved
Hide resolved
grafanabot
pushed a commit
that referenced
this pull request
Oct 24, 2023
…5555) * Update migrate from static to use doc reference * Update links in opentelemetry topic * Update refernces in Promtail topic * Add full URL to link * Update Prometheus scrape relrefs * Update clustering topic references * More reference updates * Fix a build error * Small correction update * Small text update * Fix syntax for links in blockquotes * Remove redundant relref definition * Fix typos and links in notes * Correct GrafanaCloud to Grafana Cloud * Fix link syntax * Fix some bad link text (cherry picked from commit 1647713)
clayton-cornell
added a commit
that referenced
this pull request
Oct 24, 2023
…5555) (#5591) * Update migrate from static to use doc reference * Update links in opentelemetry topic * Update refernces in Promtail topic * Add full URL to link * Update Prometheus scrape relrefs * Update clustering topic references * More reference updates * Fix a build error * Small correction update * Small text update * Fix syntax for links in blockquotes * Remove redundant relref definition * Fix typos and links in notes * Correct GrafanaCloud to Grafana Cloud * Fix link syntax * Fix some bad link text (cherry picked from commit 1647713) 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/referenceshortcode. 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 starts the process of migrating the Flow documentation to use the
docs/referenceshortcodes as preparation for mounting Flow topics into the Cloud docs.Which issue(s) this PR fixes
Notes to the Reviewer
This PR just covers a small section of the changes required to prep for adding Flow to Cloud. I'm splitting it into multiple PRs to reduce the volume of changes in each PR.
PR Checklist