-
-
Notifications
You must be signed in to change notification settings - Fork 3.6k
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
Hide design docs from documentation #7826
Conversation
I constantly hit these pages and they must be very confusing for customers and non-technical users. These are internal conversations and should probably be moved to a separate location entirely, but for now, this will hide them from output and hopefully from indexing. If this does not remove them from indexing, I think they should be removed from this doc set entirely. Most commonly, I hit the APIv3 design doc as the first search result, before the actual APIv3 documentation.
Search indexing of these pages can't be testing the PR build, but the design docs are still built, and do not emit an error on build. I can test search index outside a PR build. |
With the search ignore addition, the design docs still build, are not linked in the If we want to step this back, we can still build and link the files in |
I'm fine actually having a link to them in the developer docs, is nice to have this rendered and easily to find, since now this isn't going to appear in the search results. |
docs/development/index.rst
Outdated
@@ -11,7 +11,6 @@ for your own :doc:`custom installation </custom_installs/index>`. | |||
architecture | |||
buildenvironments | |||
design | |||
design/index |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think we should leave these in the TOC, but just exclude them from search. Otherwise they'll be impossible to find.
I constantly hit these pages and they must be very confusing for
customers and non-technical users. These are internal conversations and
should probably be moved to a separate location entirely, but for now,
this will hide them from output and hopefully from indexing. If this
does not remove them from indexing, I think they should be removed from
this doc set entirely.
Most commonly, I hit the APIv3 design doc as the first search result,
before the actual APIv3 documentation.