Skip to content
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

Fix heading remove variable #6242

Merged
merged 2 commits into from
Jan 25, 2024

Conversation

clayton-cornell
Copy link
Contributor

PR Description

This PR removes the {{< param "PRODUCT_NAME" >}} Hugo shortcode from headings. If we use this shortcode in the heading text Hugo rewrites the anchor to say #hahahugoshortcodes3hbhb wherever the shortcode is used.

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 type/docs Docs Squad label across all Grafana Labs repos backport release-v0.39 labels Jan 25, 2024
@clayton-cornell clayton-cornell requested a review from a team January 25, 2024 18:03
@clayton-cornell clayton-cornell enabled auto-merge (squash) January 25, 2024 18:04
@clayton-cornell clayton-cornell merged commit e1986b0 into main Jan 25, 2024
10 checks passed
@clayton-cornell clayton-cornell deleted the docs/update-headings-remove-variable-name branch January 25, 2024 18:09
grafanabot pushed a commit that referenced this pull request Jan 25, 2024
(cherry picked from commit e1986b0)
@jdbaldry
Copy link
Member

I thought this worked with {{% which happens pre rendering?

(https://grafana.com/docs/writers-toolkit/write/shortcodes/#param)

@jdbaldry
Copy link
Member

Yeah in https://grafana.com/docs/agent/v0.39/flow/#grafana-agent-flow, the first heading is working and the second isn't.

The difference is the use of {{% vs. {{<

@clayton-cornell
Copy link
Contributor Author

Yeah, you're right... I forgot the fix even though I recently documented the fix in the Writer's Toolkit :-(

clayton-cornell added a commit that referenced this pull request Jan 25, 2024
(cherry picked from commit e1986b0)

Co-authored-by: Clayton Cornell <131809008+clayton-cornell@users.noreply.github.com>
BarunKGP pushed a commit to BarunKGP/grafana-agent that referenced this pull request Feb 20, 2024
@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 25, 2024
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Feb 25, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
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.

None yet

3 participants