Remove duplicated docs #8895
Remove duplicated docs #8895
Conversation
k8s-ci-robot
added
cncf-cla: yes
| @@ -21,13 +21,13 @@ Kubernetes version. | |||
|
|
|||
| ## Compatibility Matrix | |||
|
|
|||
| | kops version | k8s 1.11.x | k8s 1.12.x | k8s 1.13.x | k8s 1.14.x | k8s 1.15.x | | |||
| | kops version | k8s 1.12.x | k8s 1.13.x | k8s 1.14.x | k8s 1.15.x | k8s 1.16.x | | |||
There was a problem hiding this comment.
I feel like the information in this chart is the biggest stumbling block for most people. That said, the common failure mode is running a newer version of k8s than kops, and I believe we have an error message for that now, and we are hopefully about to ~ catch up, so may not be as big of a concern any more?
There was a problem hiding this comment.
I think this is less of a concern now that we have that warning.
There was a problem hiding this comment.
Agreed. The chart was added to help people but often confused them even more. Regardless, I feel like lack of clarity around supported versions was the real issue (which we've addresses very heavily lately). I think we should leave this for now and come back another time if it should be removed from the releases page.
| https://go.k8s.io/bot-commands). | ||
|
|
||
|
|
||
| ## Office Hours |
There was a problem hiding this comment.
I do think we should have a link to office hours on the "homepage"
There was a problem hiding this comment.
I added a shorter description of office hours now, with a link to the longer one.
There was a problem hiding this comment.
Thanks for adding them, I agree it's good to have the link.
The docs in README.md is duplicated in /docs, but we are not good at keeping them in sync. Therefor I removed most of the information from README.md andr refer to the docs instead. Also fixed a few broken/missing links.
There was a problem hiding this comment.
This is great, thanks for the hard work @olemarkus! This is definitely the direction we wanted to go with many of these docs changes (and the whole reason they were duplicated in the first place). I think now is the perfect time to continue this cleanup! Thanks!
| @@ -21,13 +21,13 @@ Kubernetes version. | |||
|
|
|||
| ## Compatibility Matrix | |||
|
|
|||
| | kops version | k8s 1.11.x | k8s 1.12.x | k8s 1.13.x | k8s 1.14.x | k8s 1.15.x | | |||
| | kops version | k8s 1.12.x | k8s 1.13.x | k8s 1.14.x | k8s 1.15.x | k8s 1.16.x | | |||
There was a problem hiding this comment.
Agreed. The chart was added to help people but often confused them even more. Regardless, I feel like lack of clarity around supported versions was the real issue (which we've addresses very heavily lately). I think we should leave this for now and come back another time if it should be removed from the releases page.
|
|
||
| ## Documentation | ||
|
|
||
| [To check out Live documentation](https://kops.sigs.k8s.io/) |
There was a problem hiding this comment.
I wonder if we should move this to a comment at the top of this file to tell markdown users they should goto the live docs site?
There was a problem hiding this comment.
Not sure it is easy to add this without it also being rendered on the live docs site.
Maybe something to look into later?
| https://go.k8s.io/bot-commands). | ||
|
|
||
|
|
||
| ## Office Hours |
There was a problem hiding this comment.
Thanks for adding them, I agree it's good to have the link.
|
Thanks @olemarkus! /lgtm |
k8s-ci-robot
added
the
lgtm
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: mikesplain, olemarkus 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 |
k8s-ci-robot
added
the
approved
The docs in README.md is duplicated in /docs, but we are not good at
keeping them in sync. Therefor I removed most of the information from
README.md andr refer to the docs instead.
Also fixed a few broken/missing links.
This is really more of an RFC, but I would love to get into a state where people start using https://kops.sigs.k8s.io/ over just the markdowns on github.