-
Notifications
You must be signed in to change notification settings - Fork 14.7k
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
Remove "design docs" from /docs/reference sidebar #6410
Conversation
Deploy preview for kubernetes-io-master-staging ready! Built with commit 3d38581 https://deploy-preview-6410--kubernetes-io-master-staging.netlify.com |
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.
You will need to add docs/admin/ovs-networking.md
to the skip_toc_check.txt file to make travis happy.
@tengqm is that fixed in a separate PR? If so I can just rebase my commit to make Travis happy. |
@ahmetb I'm afraid not. You may want to do it in your PR because it is your PR that makes it a dangling file . :) |
@thockin I am about to remove ovs-networking.md completely, as part of removing links to design docs from Do you think we should keep it somewhere else (like contrib/design-docs)? It seems untouched for about ~2 years, but if it is valuable information I can move it somewhere else. |
/assign |
I just don't know what to do with that |
It's not invalid content - added two years ago and hasn't been touched since (in any real sense anyway), it only seems relevant to be a component of a "how to make your own bare-metal cluster from scratch" kind of reference effort. Kubernetes-the-hard-way is the most relevant track there- as official documentation goes, this isn't entirely helpful because it's so skimpy on end-to-end details, so I'd lean towards dropping it. |
Deleted the |
@ahmetb the CI system is reporting:
|
This list on the sidebar isn't very useful: - it's not an exhaustive list - it's not an up-to-date list either - design docs are not documentation (they're already stale) - we already link to the full list from https://kubernetes.io/docs/reference/ home page Also removing the 'docs/admin/ovs-networking.md' document as per the pull request comments, it's no longer necessary. Signed-off-by: Ahmet Alp Balkan <ahmetb@google.com>
/approve |
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: heckj The full list of commands accepted by this bot can be found here. The pull request process is described here
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
This list on the sidebar isn't very useful: - it's not an exhaustive list - it's not an up-to-date list either - design docs are not documentation (they're already stale) - we already link to the full list from https://kubernetes.io/docs/reference/ home page Also removing the 'docs/admin/ovs-networking.md' document as per the pull request comments, it's no longer necessary. Signed-off-by: Ahmet Alp Balkan <ahmetb@google.com>
This list on the sidebar isn't very useful:
home page
This change is