Skip to content

Conversation

theletterf
Copy link
Contributor

@theletterf theletterf self-assigned this Sep 10, 2025
@theletterf theletterf added the documentation Improvements or additions to documentation label Sep 10, 2025
Comment on lines 334 to 341
- 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:
Copy link
Contributor

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_prefixes 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:

  1. In the opentelemetry, renaming the directory docs/reference/edot-sdks/ to docs/intros/edot-sdks/.
  2. Removing this line from docs/reference/toc.yml.
  3. Adding - toc: intros/edot-sdks to docs/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.

This is what the production site will look like:

Screenshot 2025-09-15 at 4 24 13 PM

This is what the PR previews will look like:

Screenshot 2025-09-15 at 4 27 47 PM

Copy link
Contributor Author

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.

Copy link
Contributor Author

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.

Copy link
Contributor Author

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

Copy link
Contributor

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

@theletterf theletterf marked this pull request as ready for review September 16, 2025 08:48
@theletterf theletterf requested review from a team as code owners September 16, 2025 08:48
@theletterf theletterf requested a review from cotti September 16, 2025 08:48
@theletterf theletterf enabled auto-merge (squash) September 16, 2025 10:14
@theletterf theletterf merged commit b2e00f0 into main Sep 16, 2025
19 checks passed
@theletterf theletterf deleted the prepare-edot-docs-migration branch September 16, 2025 10:22
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants