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

Tracing: Add links to documentation in config pages #66442

Merged
merged 1 commit into from
Apr 13, 2023

Conversation

joey-grafana
Copy link
Contributor

@joey-grafana joey-grafana commented Apr 13, 2023

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:

Screenshot 2023-04-13 at 10 19 31

Please check that:

  • It works as expected from a user's perspective.
  • If this is a pre-GA feature, it is behind a feature toggle.
  • The docs are updated, and if this is a notable improvement, it's added to our What's New doc.

@github-actions
Copy link
Contributor

Backend code coverage report for PR #66442
No changes

@github-actions
Copy link
Contributor

Frontend code coverage report for PR #66442

Plugin Main PR Difference
explore 86.51% 86.52% .01%

@joey-grafana joey-grafana marked this pull request as ready for review April 13, 2023 10:00
@joey-grafana joey-grafana requested review from a team as code owners April 13, 2023 10:00
@joey-grafana joey-grafana requested review from joshhunt and ashharrison90 and removed request for a team April 13, 2023 10:00
Copy link
Contributor

@adrapereira adrapereira left a comment

Choose a reason for hiding this comment

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

LGTM! 🚀

@joey-grafana joey-grafana merged commit 22fde6a into main Apr 13, 2023
@joey-grafana joey-grafana deleted the joey/traces-config-editor-links branch April 13, 2023 13:56
@knylander-grafana
Copy link
Contributor

@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?

@joey-grafana
Copy link
Contributor Author

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?

@knylander-grafana
Copy link
Contributor

knylander-grafana commented Apr 13, 2023

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.

@jdbaldry
Copy link
Member

#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 make docs webserver and then checks the links against that?

alexmobo pushed a commit that referenced this pull request Apr 14, 2023
Add links to documentation in config pages and clean up styles
@zerok zerok modified the milestones: 10.0.0, 10.0.0-preview May 31, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

6 participants