Update index pages for EDOT troubleshooting documentation #4184
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
Vale Linting ResultsSummary: 1 warning, 11 suggestions found
|
| File | Line | Rule | Message |
|---|---|---|---|
| troubleshoot/ingest/opentelemetry/edot-sdks/android/index.md | 28 | Elastic.PluralAbbreviations | Don't use apostrophes when making abbreviations plural. Use 'SDK' instead of ''s'. |
💡 Suggestions (11)
| File | Line | Rule | Message |
|---|---|---|---|
| troubleshoot/ingest/opentelemetry/429-errors-motlp.md | 54 | Elastic.Wordiness | Consider using 'because' instead of 'since'. |
| troubleshoot/ingest/opentelemetry/edot-collector/index.md | 42 | Elastic.WordChoice | Consider using 'refer to (if it's a document), view (if it's a UI element)' instead of 'See', unless the term is in the UI. |
| troubleshoot/ingest/opentelemetry/edot-collector/index.md | 44 | Elastic.WordChoice | Consider using 'can, might' instead of 'may', unless the term is in the UI. |
| troubleshoot/ingest/opentelemetry/edot-sdks/dotnet/index.md | 24 | Elastic.WordChoice | Consider using 'refer to (if it's a document), view (if it's a UI element)' instead of 'see', unless the term is in the UI. |
| troubleshoot/ingest/opentelemetry/edot-sdks/dotnet/index.md | 77 | Elastic.FutureTense | 'will be' might be in future tense. Write in the present tense to describe the state of the product as it is now. |
| troubleshoot/ingest/opentelemetry/edot-sdks/index.md | 44 | Elastic.WordChoice | Consider using 'refer to (if it's a document), view (if it's a UI element)' instead of 'See', unless the term is in the UI. |
| troubleshoot/ingest/opentelemetry/edot-sdks/index.md | 46 | Elastic.WordChoice | Consider using 'can, might' instead of 'may', unless the term is in the UI. |
| troubleshoot/ingest/opentelemetry/edot-sdks/index.md | 51 | Elastic.WordChoice | Consider using 'can, might' instead of 'may', unless the term is in the UI. |
| troubleshoot/ingest/opentelemetry/edot-sdks/nodejs/index.md | 88 | Elastic.WordChoice | Consider using 'refer to (if it's a document), view (if it's a UI element)' instead of 'see', unless the term is in the UI. |
| troubleshoot/ingest/opentelemetry/edot-sdks/python/index.md | 35 | Elastic.WordChoice | Consider using 'refer to (if it's a document), view (if it's a UI element)' instead of 'see', unless the term is in the UI. |
| troubleshoot/ingest/opentelemetry/no-data-in-kibana.md | 112 | Elastic.FutureTense | 'will not' might be in future tense. Write in the present tense to describe the state of the product as it is now. |
theletterf
approved these changes
Dec 2, 2025
Contributor
theletterf
left a comment
theletterf
left a comment
There was a problem hiding this comment.
The changes look good to me.
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
This PR audits and improves the IA and interlinking of the EDOT troubleshooting documentation. It rewrites the original index pages and adds contextual links to improve navigation.
Closes #3426
Generative AI disclosure
Did you use a generative AI (GenAI) tool to assist in creating this contribution?
[x] Yes
[ ] No
If you answered "Yes" to the previous question, please specify the tool(s) and model(s) used (e.g., Google Gemini, OpenAI ChatGPT-4, etc.).
Tool(s) and model(s) used: Cursor AI (Claude Sonnet 4.5)