Skip to content

Add Contribute to docs as a proper child of the Extend section. #1746

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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

georgewallace
Copy link
Contributor

No description provided.

@theletterf
Copy link
Contributor

I think this has to do with the way the section is laid out in the nav: it's mostly a mix of assembled and docs-content, and that doesn't bode well with selecting the order of each item.

Copy link
Contributor

@shainaraskas shainaraskas left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't think this will render correctly unless we create another toc at https://github.com/elastic/docs-content/tree/main/extend/contribute or something. or else, we'll forever get this double nav weirdness.

the reason it is behaving strangely is because the index you're referencing here is the same index that sits at extend

@georgewallace
Copy link
Contributor Author

There is a toc.yml file here https://github.com/elastic/docs-content/blob/main/extend/toc.yml, it is just up a level and that is the problem? I'll look into this more. We really need to get docs-builder to be able to preview builds like this without guessing.

@theletterf
Copy link
Contributor

This is from our navigation.yml file (docs-builder repo):

  ##########
  # EXTEND #
  ##########
  # I didn't touch this section (yet?)
  - toc: extend
    children:
      - toc: kibana://extend
        path_prefix: extend/kibana
      - toc: logstash://extend
        path_prefix: extend/logstash
      - toc: beats://extend
        path_prefix: extend/beats
      - toc: elasticsearch://extend
        path_prefix: extend/elasticsearch
      - toc: integrations://extend
        path_prefix: extend/integrations

The first item, toc: extend, loads up this file: https://github.com/elastic/docs-content/blob/main/extend/toc.yml

The expectation, I think, is that the Contribute section should appear first and contain the rest of items. Instead, it's appended the last, the name of the section repeated.

I wonder if #1615 would solve this, @elastic/docs-engineering.

@shainaraskas
Copy link
Contributor

There is a toc.yml file here elastic/docs-content@main/extend/toc.yml, it is just up a level and that is the problem? I'll look into this more. We really need to get docs-builder to be able to preview builds like this without guessing.

yes. you can look at the way we do the reference section (tocs in all of the child folders, as well as the root) for an idea of how this should be done.

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.

Fix "contribute to docs" nesting
3 participants