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

docs: support items without nav sidebar entry #731

Closed
dashohoxha opened this issue Oct 24, 2019 · 5 comments
Closed

docs: support items without nav sidebar entry #731

dashohoxha opened this issue Oct 24, 2019 · 5 comments
Labels
type: enhancement Something is not clear, small updates, improvement suggestions website: eng-doc DEPRECATED JS engine for /doc

Comments

@dashohoxha
Copy link
Contributor

In some cases it might be useful to hide (not-show) a page on the left-side menu.
For example in the "Installation" page, the pages about "completion" and "plugins" are referenced from the index page of installation, but I wish they were not shown on the sidebar menu.

Currently this is not possible (unless I have missed something).
This could be specified for example with a field like "label": false, or "label": null, or "label": "",

@dashohoxha dashohoxha added website: eng-doc DEPRECATED JS engine for /doc type: enhancement Something is not clear, small updates, improvement suggestions labels Oct 24, 2019
@shcheklein shcheklein changed the title engine: hide a page from the left-side menu hide a page from the left-side menu Oct 24, 2019
@shcheklein shcheklein added A: docs Area: user documentation (gatsby-theme-iterative) p2-nice-to-have Less of a priority at the moment. We don't usually deal with this immediately. labels Oct 24, 2019
@jorgeorpinel
Copy link
Contributor

jorgeorpinel commented Oct 24, 2019

Seems to me like a correct feature: being able to have the files there for linking, but with no entry in sidebar.json (Basically, content hidden from navigation)

However I don't agree that neither /doc/user-guide/install/completion nor ...plugins should be hidden from the sidebar. They help users discover those topics by navigating the side bar. In fact can't find any element in the navigation at the moment that shouldn't be listed.

@jorgeorpinel
Copy link
Contributor

p.s. The problem with those 2 entries is that they are repeated as stand-alone User Guides since #695 was merged. This is reported in #701.

@jorgeorpinel jorgeorpinel changed the title hide a page from the left-side menu engine: support docs without nav sidebar entry Jan 5, 2020
@jorgeorpinel jorgeorpinel changed the title engine: support docs without nav sidebar entry docs: support items without nav sidebar entry Jan 5, 2020
@jorgeorpinel jorgeorpinel removed A: docs Area: user documentation (gatsby-theme-iterative) p2-nice-to-have Less of a priority at the moment. We don't usually deal with this immediately. labels Jan 19, 2020
@shcheklein
Copy link
Member

Not sure I see any valuable use case for this for now. Closing this. Will revisit if have a real use case for this.

@jorgeorpinel
Copy link
Contributor

BTW this is now possible on Gatsby I think. Are there any pages we want to hide from the docs @shcheklein? Maybe the Google API Privacy Policy (per #144 (comment))

@rogermparent
Copy link
Contributor

rogermparent commented May 3, 2020

You're correct, this has been possible since the Models PR. All MD source files will become pages, and if they aren't added to the sidebar they won't show up automatically, fulfilling this behavior.
Should the docs implementation change (and it probably will eventually), I'll keep this feature in mind when changing anything so as to not break it, and we can take advantage of it going into the future.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type: enhancement Something is not clear, small updates, improvement suggestions website: eng-doc DEPRECATED JS engine for /doc
Projects
None yet
Development

No branches or pull requests

4 participants