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

Hide design docs from documentation #7826

Merged
merged 7 commits into from
Jan 18, 2021
Merged

Hide design docs from documentation #7826

merged 7 commits into from
Jan 18, 2021

Conversation

agjohnson
Copy link
Contributor

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.

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.
@agjohnson
Copy link
Contributor Author

agjohnson commented Jan 13, 2021

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.

@agjohnson
Copy link
Contributor Author

With the search ignore addition, the design docs still build, are not linked in the /developer/ page, and will not show up in search results.

If we want to step this back, we can still build and link the files in /developer/, but ignore in search results. I'd still probably vote these are not good permanent docs to include in our documentation however, as they were mostly used to enable conversation around feature design.

@agjohnson agjohnson marked this pull request as ready for review January 13, 2021 22:09
@agjohnson agjohnson requested a review from a team January 13, 2021 22:10
@stsewd
Copy link
Member

stsewd commented Jan 13, 2021

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.

@@ -11,7 +11,6 @@ for your own :doc:`custom installation </custom_installs/index>`.
architecture
buildenvironments
design
design/index
Copy link
Member

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.

@stsewd stsewd merged commit 8b0be9f into master Jan 18, 2021
@stsewd stsewd deleted the agj/hide-design-docs branch January 18, 2021 19:05
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants