-
Notifications
You must be signed in to change notification settings - Fork 11.8k
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
Tracing: Add links to documentation in config pages #66442
Conversation
Backend code coverage report for PR #66442 |
Frontend code coverage report for PR #66442
|
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.
LGTM! 🚀
@joey-grafana Is there a way to list the links that are used in product links? I'll ask this question in the Slack channel. If a target link changes, how can we check for broken links? |
Hey Kim, sorry I pushed this before your review! I'm not sure if there's a way to check for broken links, do we have a policy around this or do it anywhere else? |
When you use make docs, it can check for broken links but that's only within the doc set. The website team provides a report of broken links to the doc team, but again that's not going to check for links in the product that go to docs. Let me ask @jdbaldry for some guidance here. |
#66440 will facilitate checking for broken links across projects. I won't be enforcing checks in CI until this has been tested out a bit but I would encourage all technical writers to start using cross project relrefs and checking them with the script. As for checking in product links, we don't have anything in place for this yet. You could use existing link checking tools or write a script that derives the grafana.com URLs from the project docs/sources directories that could be used to check against. I guess you could also script something that starts the |
Add links to documentation in config pages and clean up styles
What is this feature?
Adds a link to each section in the data sources config editor.
Why do we need this feature?
Allows users to easily link directly to documentation that describes the config section in more detail.
Who is this feature for?
Tracing users (Tempo/Jaeger/Zipkin).
Special notes for your reviewer:
Adds a button link in each settings section like the following:
Please check that: