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

Add doc for max_span_attr_byte and restructure troubleshoot doc #4551

Merged

Conversation

knylander-grafana
Copy link
Contributor

@knylander-grafana knylander-grafana commented Jan 13, 2025

What this PR does:

Adds doc for max_span_attr_byte and restructures the troubleshooting section.

Which issue(s) this PR fixes:
Part of https://github.com/grafana/tempo-squad/issues/533
Part of restructure doc work: https://github.com/grafana/tempo-squad/issues/468
Doc for #4335

Checklist

  • Tests updated
  • Documentation added
  • CHANGELOG.md updated - the order of entries should be [CHANGE], [FEATURE], [ENHANCEMENT], [BUGFIX]

@knylander-grafana knylander-grafana added the backport release-v2.7 Backport for V2.7 label Jan 13, 2025
Copy link
Contributor

This PR must be merged before a backport PR will be created.

@knylander-grafana knylander-grafana changed the title Add doc for max attr byte and restructure troubleshoot doc Add doc for max_span_attr_byte and restructure troubleshoot doc Jan 13, 2025
Copy link
Member

@jdbaldry jdbaldry left a comment

Choose a reason for hiding this comment

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

I've only really checked the aliases which work to redirect all the pre-patch locations to the post-patch locations.

Can we add a comments for all the old aliases with the full URL path they are intended to redirect so it's easier for a future reviewer to check?

docs/sources/tempo/troubleshooting/_index.md Outdated Show resolved Hide resolved
docs/sources/tempo/troubleshooting/send-traces/alloy.md Outdated Show resolved Hide resolved
@knylander-grafana
Copy link
Contributor Author

I've only really checked the aliases which work to redirect all the pre-patch locations to the post-patch locations.

Can we add a comments for all the old aliases with the full URL path they are intended to redirect so it's easier for a future reviewer to check?

I've added URL comments for all of the pages in the troubleshooting section.

Fix {{% to {{<
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.

Spotted a couple more... a typo.. and two anchors that don't exist/spelled differently.

@knylander-grafana knylander-grafana enabled auto-merge (squash) January 15, 2025 18:30
@knylander-grafana knylander-grafana merged commit e20401c into grafana:main Jan 15, 2025
16 checks passed
github-actions bot pushed a commit that referenced this pull request Jan 15, 2025
Co-authored-by: Jack Baldry <[email protected]>
Co-authored-by: Clayton Cornell <[email protected]>
(cherry picked from commit e20401c)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport release-v2.7 Backport for V2.7 type/docs Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants