-
Notifications
You must be signed in to change notification settings - Fork 30
Add nav and assembler changes for EDOT docs move #1871
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
Conversation
config/navigation.yml
Outdated
- toc: opentelemetry://reference | ||
path_prefix: reference/opentelemetry | ||
# Children include all EDOT distribution docs. | ||
children: | ||
- toc: elastic-agent://reference/edot-collector | ||
path_prefix: reference/opentelemetry/edot-collector | ||
- toc: opentelemetry://reference/edot-sdks | ||
path_prefix: reference/opentelemetry/edot-sdks | ||
children: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think the problem is that the reference/toc.yml
file in the opentelemetry repo includes the reference/edot-sdks/index.md
file. This means that when you define toc: opentelemetry://reference
here, you're already including a page at path reference/opentelemetry/edot-sdks
so you can't add another toc (opentelemetry://reference/edot-sdks
) using that path_prefix
.
Note: We ran into a similar problem with APM agents. That's why we ended up with the path_prefix
reference/apm-agents
instead of reference/apm/agents
(which would better align with the pattern of all other path_prefix
es in that section).
If you want the final paths for the intro page and all the individual EDOT SDK repos to follow the same pattern (reference/edot-sdks/*
), I was able to get this to work locally by:
- In the opentelemetry, renaming the directory
docs/reference/edot-sdks/
todocs/intros/edot-sdks/
. - Removing this line from
docs/reference/toc.yml
. - Adding
- toc: intros/edot-sdks
todocs/docset.yml
(after- toc: reference
).- Note: The
docs/docset.yml
is only used to build the PR previews in each repo. It has no impact on the production site. So you really just need to add this extra page somewhere so it can be built in previews to both test that the syntax/links are valid and preview the rendered page.
- Note: The
This is what the production site will look like:

This is what the PR previews will look like:

There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is fantastic, thanks so much @colleenmcginnis! It makes lots of sense. Gonna try that now.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I ended up putting SDK docs inside subfolders and defining different nav paths. I'll deal with this through redirects.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@colleenmcginnis I'm trying this again now that've merged everything. I've prepared this PR: elastic/opentelemetry#452
What was the navigation.yml
block you used? +CC @reakaleek
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
- toc: opentelemetry://reference
path_prefix: reference/opentelemetry
children:
- toc: elastic-agent://reference/edot-collector
path_prefix: reference/opentelemetry/edot-collector
- toc: opentelemetry://intros/edot-sdks
path_prefix: reference/opentelemetry/edot-sdks
children:
- toc: elastic-otel-java://reference
path_prefix: reference/opentelemetry/edot-sdks/java
- toc: elastic-otel-python://reference
path_prefix: reference/opentelemetry/edot-sdks/python
- toc: elastic-otel-node://reference
path_prefix: reference/opentelemetry/edot-sdks/node
- toc: elastic-otel-php://reference
path_prefix: reference/opentelemetry/edot-sdks/php
- toc: apm-agent-android://reference
path_prefix: reference/opentelemetry/edot-sdks/android
- toc: apm-agent-ios://reference
path_prefix: reference/opentelemetry/edot-sdks/ios
- toc: elastic-otel-dotnet://reference
path_prefix: reference/opentelemetry/edot-sdks/dotnet
Co-authored-by: Colleen McGinnis <[email protected]>
Contributes to https://github.com/elastic/opentelemetry-dev/issues/1044