Skip to content

Update navigation.yml to add EDOT Troubleshooting #1515

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

Closed
wants to merge 5 commits into from

Conversation

theletterf
Copy link
Contributor

This adds EDOT Troubleshooting docs to the navigation.

Contributes to elastic/opentelemetry#333

+CC @alexandra5000

This adds EDOT Troubleshooting docs to the navigation.

Contributes to elastic/opentelemetry#333

+CC @alexandra5000
@theletterf
Copy link
Contributor Author

@elastic/docs-engineering The https://github.com/elastic/docs-content/blob/main/troubleshoot/toc.yml file is composed of files exclusively. How do we determine the position of the imported troubleshooting in the nav?

@theletterf
Copy link
Contributor Author

theletterf commented Jul 3, 2025

@colleenmcginnis @shainaraskas Do we consider Troubleshooting "narrative" docs? Is it a requirement for EDOT troubleshooting docs to live inside docs-content? Aleks and I were thinking of serving it from the opentelemetry repo, but we could move it to docs-content, too.

@shainaraskas
Copy link
Contributor

@colleenmcginnis @shainaraskas Do we consider Troubleshooting "narrative" docs? Is it a requirement for EDOT troubleshooting docs to live inside docs-content? Aleks and I were thinking of serving it from the opentelemetry repo, but we could move it to docs-content, too.

I can imagine this changing long term. we had an external requirement to create a single home for the troubleshooting docs, but from a reader pov, not a writer pov.

in my experience, these are largely authored by support, which is one reason to keep them in the docs-content repo (mostly easier oversight and review cycles but that might not be worth much).

The complexity here is perhaps pivoting from the single-repo to multi-repo model (doing the original planning for this I recall was a little bit of a headache). I haven't done a lot of this myself and am not sure of what's involved. colleen might know more, dev definitely will.

@theletterf
Copy link
Contributor Author

@shainaraskas Thanks! I think @lucabelluccini and the EDOT devs are already used to the EDOT troubleshooting docs being in the opentelemetry repo, so in this case I lean towards keeping them there.

@theletterf
Copy link
Contributor Author

This won't work, unfortunately. We're going to move the docs to docs-content....

@theletterf theletterf closed this Jul 4, 2025
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.

3 participants