docs: restructure observability documentation for clarity and neutrality#4249
Merged
docs: restructure observability documentation for clarity and neutrality#4249
Conversation
Closed
181969c to
147de31
Compare
Member
|
Hi @vishu-bh Regards, |
- Extract Prometheus metrics to dedicated guide (prometheus.md) - Rename files for clarity: - observability/observability.md → opentelemetry.md - internal-observability.md → internal.md - Move OTEL_SPAN_ATTRIBUTES.md to architecture/otel-span-attributes.md - Rewrite landing page with neutral, descriptive language - Remove prescriptive recommendations, use factual descriptions - Update all cross-references and navigation - Add comprehensive comparison matrix - Add pragma comments for documentation example tokens Closes #4245 Signed-off-by: Vishu Bheda <vishubheda@gmail.com> Signed-off-by: Vishu Bhatnagar <vishu.bhatnagar@ibm.com>
147de31 to
34debd8
Compare
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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
Restructures the observability documentation to improve clarity, eliminate duplication, and use neutral language that describes capabilities rather than prescribing choices.
Changes
New Files
Renamed Files
Updated Files
Key Improvements
Documentation Structure
Testing
Closes #4245