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(doc): render index.md's admonition link #5478

Merged
merged 7 commits into from
Oct 17, 2023

Conversation

hainenber
Copy link
Contributor

PR Description

Which issue(s) this PR fixes

Fixes issue shown in following screenshot. Captured in https://grafana.com/docs/agent/latest/

image

Notes to the Reviewer

PR Checklist

@clayton-cornell
Copy link
Contributor

clayton-cornell commented Oct 16, 2023

@jdbaldry Can you take a quick look at this. I should have done a make doc build test before I merged the last PR that was raised to fix this link. The <AGENT VERSION> part isn't rendering within the admonition. I'm not sure how to fix this one properly.

Previous PRs

This also look broken in v0.36 (wasn't fixed in v0.36 in the previous PRs)

@clayton-cornell clayton-cornell added the type/docs Docs Squad label across all Grafana Labs repos label Oct 16, 2023
@jdbaldry
Copy link
Member

Agh, sorry for this.

I discovered that the Markdown parser does not appreciate whitespace in link definitions. If possible, the best fix is to replace AGENT VERSION with something like AGENT_VERSION everywhere.

docs/sources/_index.md Outdated Show resolved Hide resolved
docs/sources/_index.md.t Outdated Show resolved Hide resolved
@clayton-cornell
Copy link
Contributor

clayton-cornell commented Oct 16, 2023

@clayton-cornell
Copy link
Contributor

@hainenber I'm going to apply the suggestions and push this fix through. I don't wan tit to lag behind too much and I need the topic fixed for other incoming updates :-) Thanks for spotting this. It's lead to fixing a similar problem in a few other places.

Copy link
Contributor

@clayton-cornell clayton-cornell left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Approving. The same fix has been applied already to v0.37 and v0.36 docs.

@clayton-cornell clayton-cornell enabled auto-merge (squash) October 17, 2023 17:00
@clayton-cornell clayton-cornell merged commit ff2a51d into grafana:main Oct 17, 2023
7 checks passed
@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 21, 2024
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Feb 21, 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.

3 participants