Disambiguate distributed tracing documentation #51397
Open
+4
−0
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add a note to the beginning of the distributed tracing doc to also point to the logging and tracing doc. There's already a link from logging and tracing here, so making the link bidirectional so the relationship is clear regardless of which entrypoint the reader found.
dotnet-policy-service
bot
added
dotnet-fundamentals/svc
community-contribution
Contributor
There was a problem hiding this comment.
Pull request overview
This PR clarifies terminology in the distributed tracing documentation by adding an upfront note that points readers to the logging and tracing article for legacy “tracing” meanings, making navigation between the two docs bidirectional.
Changes:
- Add a NOTE callout near the top of the distributed tracing doc to disambiguate “tracing” terminology.
- Add a link to Logging and tracing (
logging-tracing.md) for readers looking for older tracing APIs.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
Add a note to the beginning of the distributed tracing doc to also point to the logging and tracing doc. There's already a link from logging and tracing here, so making the link bidirectional so the relationship is clear regardless of which entrypoint the reader found.
Internal previews