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

Remove "design docs" from /docs/reference sidebar #6410

Merged
merged 1 commit into from
Mar 3, 2018
Merged

Remove "design docs" from /docs/reference sidebar #6410

merged 1 commit into from
Mar 3, 2018

Conversation

ahmetb
Copy link
Member

@ahmetb ahmetb commented Nov 22, 2017

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

This change is Reviewable

@k8s-ci-robot k8s-ci-robot added cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. size/S Denotes a PR that changes 10-29 lines, ignoring generated files. labels Nov 22, 2017
@k8sio-netlify-preview-bot
Copy link
Collaborator

k8sio-netlify-preview-bot commented Nov 22, 2017

Deploy preview for kubernetes-io-master-staging ready!

Built with commit 3d38581

https://deploy-preview-6410--kubernetes-io-master-staging.netlify.com

Copy link
Contributor

@tengqm tengqm left a 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.

@ahmetb
Copy link
Member Author

ahmetb commented Nov 23, 2017

@tengqm is that fixed in a separate PR? If so I can just rebase my commit to make Travis happy.

@tengqm
Copy link
Contributor

tengqm commented Nov 24, 2017

@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 . :)

@ahmetb
Copy link
Member Author

ahmetb commented Dec 20, 2017

@thockin I am about to remove ovs-networking.md completely, as part of removing links to design docs from k8s.io/docs/reference.

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.

@heckj
Copy link
Contributor

heckj commented Feb 28, 2018

@ahmetb Do you want to rebase this and remove the file that you commented on to @thockin and get this rolling again? I think the ToC checks in CI are the only real pending point... branch isn't set to updatable by a maintainer, or I might have just taken a stab at the rebase myself

@heckj
Copy link
Contributor

heckj commented Feb 28, 2018

/assign

@ahmetb
Copy link
Member Author

ahmetb commented Feb 28, 2018

I just don't know what to do with that ovs-networking.md file. 😟 I have no good place for it to move to. I also cannot assess if it contains information that deserve to be on the website, or should it just be deleted forever. Any ideas?

@heckj
Copy link
Contributor

heckj commented Feb 28, 2018

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.

@ahmetb
Copy link
Member Author

ahmetb commented Feb 28, 2018

Deleted the ovs-networking.md and pushed again. PTAL.

@k8s-ci-robot k8s-ci-robot added size/M Denotes a PR that changes 30-99 lines, ignoring generated files. and removed size/S Denotes a PR that changes 10-29 lines, ignoring generated files. labels Feb 28, 2018
@heckj
Copy link
Contributor

heckj commented Feb 28, 2018

@ahmetb the CI system is reporting:

Error: docs/reference/design-docs/overview.md doesn't have an entry in the table of contents under _data/*.yml
Found 1 files without entries. For how to fix it, see http://kubernetes.io/docs/home/contribute/write-new-topic/#creating-an-entry-in-the-table-of-contents

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>
@heckj
Copy link
Contributor

heckj commented Mar 3, 2018

/approve
/lgtm

@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Mar 3, 2018
@k8s-ci-robot
Copy link
Contributor

[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 /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@k8s-ci-robot k8s-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Mar 3, 2018
@k8s-ci-robot k8s-ci-robot merged commit 00c3eb0 into kubernetes:master Mar 3, 2018
tehut pushed a commit to tehut/website that referenced this pull request Mar 8, 2018
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>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. lgtm "Looks good to me", indicates that a PR is ready to be merged. size/M Denotes a PR that changes 30-99 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

7 participants