Skip to content
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

Repeated entries in navigation #443

Open
1 of 3 tasks
lcawl opened this issue Feb 6, 2025 · 4 comments
Open
1 of 3 tasks

Repeated entries in navigation #443

lcawl opened this issue Feb 6, 2025 · 4 comments
Labels

Comments

@lcawl
Copy link
Contributor

lcawl commented Feb 6, 2025

Describe the bug

Some pages appears twice in the navigation even though they're mentioned only once in the toc.yml file. For example:

Image

I see this happenening in places of the toc like

    - toc: elasticsearch/docs/reference/elasticsearch-plugins

... which references https://github.com/elastic/asciidocalypse/blob/reference/docs/elasticsearch/docs/reference/elasticsearch-plugins/toc.yml

The first file referenced in that toc.yml is shown twice:

toc:
  - file: elasticsearch-plugins.md

I searched on the navigation title just to be sure there wasn't a duplicate file lurking.

Expected behavior

I expected these pages to be used for the section in the navigation, but not to re-appear within that section.

Steps to reproduce

Build the reference branch: https://github.com/elastic/asciidocalypse/tree/reference

Tooling

  • docs-builder
  • migration tooling
  • I'm not sure
@lcawl lcawl added the bug label Feb 6, 2025
@lcawl
Copy link
Contributor Author

lcawl commented Feb 7, 2025

There was a similar problem in the ECS reference section, so I've worked around it for now by bumping that section up a level in the navigation tree in https://github.com/elastic/asciidocalypse/pull/20

@lcawl
Copy link
Contributor Author

lcawl commented Feb 19, 2025

In https://github.com/elastic/asciidocalypse/pull/93 I renamed the first file in the toc.yml to index.md and the problem went away. Is this a hard requirement?

lcawl added a commit that referenced this issue Feb 19, 2025
@Mpdreamz
Copy link
Member

No this is a bug! we should address it so we don't force everyone to use index.md everywhere which is a terrible experience in editors.

@lcawl
Copy link
Contributor Author

lcawl commented Feb 20, 2025

No this is a bug! we should address it so we don't force everyone to use index.md everywhere which is a terrible experience in editors.

Yay, I've done that to move forward for now but agree it's not ideal.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

2 participants