Skip to content

Update navigation.yml #845

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

Merged
merged 5 commits into from
Mar 26, 2025
Merged

Update navigation.yml #845

merged 5 commits into from
Mar 26, 2025

Conversation

colleenmcginnis
Copy link
Contributor

@colleenmcginnis colleenmcginnis commented Mar 25, 2025

I'm stuck on updating the navigation.yml for release notes and I'm hoping @Mpdreamz can help me figure out where I'm going wrong.

The problem

  • We need to assign a different path_prefix to the toc.yml file in each subdirectory in docs-content's release-notes directory:
  • We also need a different prefix for the index.md file (just release_notes).
  • In order to assign these directories and file with different prefixes, I think we need a separate entry for each in the navigation.yml file, but I'm not sure how to deal with the index.md file (just release_notes) file because it doesn't have its own toc.yml.

What I tried

  • In my local .artifacts/checkouts/docs-content/release-notes directory, I created a new intro directory.
  • In that directory I added:
    • index.md: An exact copy of index.md.
    • toc.yml: With the index.md file as the only item.
  • I updated toc.yml to be:
    toc:
      - file: index.md
      - toc: intro
      - toc: elastic-observability
      - toc: elastic-security
      - toc: elastic-cloud-serverless
      - toc: fleet-elastic-agent
  • I got this errorError: No toc for output path: 'docs-content://release-notes/index.md' falling back to: '/GitHub/docs-builder/.artifacts/assembly/docs/_failed/docs-content/release-notes/index.md' and the rendered result looked like this:
    localhost_4000_docs_release-notes (1)

I'm not sure what else to do.

Other changes

  • We probably need to add max_toc_depth: 2 to the cloud repo's docset.yml file because I added separate items for cloud://release-notes/cloud-hosted and cloud://release-notes/cloud-enterprise since these need different path prefixes, too.
  • Unrelated to release notes, this PR also:

colleenmcginnis added a commit to elastic/docs-content that referenced this pull request Mar 25, 2025
Related to elastic/docs-builder#845

Remove some reference section landing pages:

* `reference/cloud/index.md`: Use the elastic/cloud repo's
[`reference/index.md`](https://github.com/elastic/cloud/blob/master/docs/reference/index.md)
instead
([preview](https://docs-v3-preview.elastic.dev/elastic/cloud/tree/master/reference))
* `reference/elasticsearch/index.md`: Use the elastic/elasticsearch
repo's
[`reference/elasticsearch/index.md`](https://github.com/elastic/elasticsearch/blob/main/docs/reference/elasticsearch/index.md)
instead
([preview](https://docs-v3-preview.elastic.dev/elastic/elasticsearch/tree/main/reference/elasticsearch/))
* `reference/ecs/index.md`: Use the elastic/ecs repo's
[`reference/index.md`](https://github.com/elastic/ecs/blob/main/docs/reference/index.md)
instead
([preview](https://docs-v3-preview.elastic.dev/elastic/ecs/tree/main/reference/))
@colleenmcginnis colleenmcginnis marked this pull request as ready for review March 26, 2025 14:45
@colleenmcginnis colleenmcginnis requested a review from a team as a code owner March 26, 2025 14:45
@colleenmcginnis colleenmcginnis changed the title [work in progress] Update navigation.yml Update navigation.yml Mar 26, 2025
@reakaleek reakaleek merged commit 4a4d703 into main Mar 26, 2025
11 checks passed
@reakaleek reakaleek deleted the nav-adjustments branch March 26, 2025 14:50
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