-
Notifications
You must be signed in to change notification settings - Fork 487
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Replace < with % in var references in headings #5975
Merged
Merged
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
Docs Squad label across all Grafana Labs repos
backport release-v0.38
labels
Dec 13, 2023
jdbaldry
approved these changes
Dec 14, 2023
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
❤️
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-5975-to-release-v0.38 origin/release-v0.38
# Cherry-pick the merged commit of this pull request and resolve the conflicts
git cherry-pick -x 7e0bf25ed090a92d235b506aa021605be7f25e0f
# Push it to GitHub
git push --set-upstream origin backport-5975-to-release-v0.38
git switch main
# Remove the local backport branch
git branch -D backport-5975-to-release-v0.38 Then, create a pull request where the |
clayton-cornell
added a commit
that referenced
this pull request
Dec 14, 2023
(cherry picked from commit 7e0bf25)
clayton-cornell
added a commit
that referenced
this pull request
Dec 14, 2023
(cherry picked from commit 7e0bf25)
clayton-cornell
added a commit
that referenced
this pull request
Dec 15, 2023
BarunKGP
pushed a commit
to BarunKGP/grafana-agent
that referenced
this pull request
Feb 20, 2024
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 21, 2024
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Labels
backport release-v0.38
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
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 table of contents is generated during Markdown processing and shortcodes with
{{< VAR_NAME >}}
syntax haven't been rendered at that point.Recent changes to use a cascading variable for the Grafana Agent Flow product name use the
{{< VAR_NAME >}}
shortcode in many of the headings. The result is the heading anchor link URLs containhahahugoshortcodes0hbhb
in place ofGrafana Agent Flow
To fix this we have to use
{{% VAR_NAME %}}
shortcode syntax in the headings only. This tells Hugo to render the shortcode before the markdown... and... anchor link URLs look normal.Which issue(s) this PR fixes
Notes to the Reviewer
PR Checklist