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

docs: fix 'Flow mode' link #5412

Closed
wants to merge 3 commits into from
Closed

docs: fix 'Flow mode' link #5412

wants to merge 3 commits into from

Conversation

d4nyll
Copy link

@d4nyll d4nyll commented Oct 9, 2023

PR Description

Fix link to Flow Mode in docs:

Screenshot 2023-10-09 at 09 49 55

Copy link
Member

@tpaschalis tpaschalis left a comment

Choose a reason for hiding this comment

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

I'm preemptively approving, but leaving it to @clayton-cornell for the final decision.

I'm not sure why the link is not working here; does it have to do with it being inside of the admonition block?

@clayton-cornell
Copy link
Contributor

clayton-cornell commented Oct 11, 2023

@d4nyll Thanks for spotting this one. It slipped through on me.

The link is failing to render correctly because it's inside a note block, and the link definition is set in a doc/reference ta the bottom of the topic. We are using the doc/reference link definitions here because we mount the Static topics in the OSS documentation and in the Grafana Cloud documentation... and we need some special handling for linking so everything work in both doc locations.

The simplest fix here is to simply remove the link from the Note. We have this link elsewhere within the same topic so we aren't loosing anything.

Also... we can't update directly within this .md file because this particular _index.md is a generated topic. The change needs to be applied in the parallel template file _index.md.t

So do you want to roll back this change and apply it to the _index.md.t file? Or we can close this PR and open a new PR that just changes the template file.

@clayton-cornell
Copy link
Contributor

Hmmm... looking deeper into this one, and it looks like the fix is a bit complicated because it happened right around when we templated this _index.md file. So the mistake exists in _index.md in the v0.37.1 release and then it was carried over in the conversion to the templated file in main (tagged to next). So I'll close this PR and fix it in the template in main and then manually change the original file in v0.37.1 in a second PR.

@clayton-cornell
Copy link
Contributor

Fixed in:

Closing this PR. Thanks for finding this mistake @d4nyll The fix took a little fiddling and two separate PRs to get it all right. :-)

@d4nyll d4nyll deleted the fix/flow-mode-link branch October 12, 2023 21:30
@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