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

Update README.md and INSTALL.md for v6.0.0 #347

Merged
merged 1 commit into from
Dec 19, 2017
Merged

Update README.md and INSTALL.md for v6.0.0 #347

merged 1 commit into from
Dec 19, 2017

Conversation

sttts
Copy link
Contributor

@sttts sttts commented Dec 18, 2017

Prepare for v6.0.0 release.

@sttts sttts requested a review from caesarxuchao December 18, 2017 16:28
@k8s-ci-robot k8s-ci-robot added the cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. label Dec 18, 2017
@k8s-reviewable
Copy link

This change is Reviewable

@k8s-ci-robot k8s-ci-robot added the size/S Denotes a PR that changes 10-29 lines, ignoring generated files. label Dec 18, 2017
@sttts sttts changed the title Update README.md for v6.0.0 Update README.md and INSTALL.md for v6.0.0 Dec 18, 2017
@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 Dec 18, 2017
| client-go 2.0 | Kubernetes main repo, 1.5 branch | |
| client-go 3.0 | Kubernetes main repo, 1.6 branch | |
| client-go 2.0 | Kubernetes main repo, 1.5 branch | = - |
| client-go 3.0 | Kubernetes main repo, 1.6 branch | = - |
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

these are 9 months ago. So we should officially deprecate them.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

(we promise 6 months)

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Waiting for approval by @cheftako as both @caesarxuchao and @lavalamp are out.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@cheftako I read your 👍 as agreement.

Copy link
Contributor

@timoreimann timoreimann left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM.

@sttts sttts assigned cheftako and unassigned lavalamp Dec 18, 2017
@@ -99,7 +99,7 @@ your project:
package: ( your project's import path ) # e.g. github.com/foo/bar
import:
- package: k8s.io/client-go
version: v2.0.0
Copy link
Member

@cheftako cheftako Dec 18, 2017

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We clearly need to "fix" v2 but I'm a little worried that we are prescribing client v6. It seems live the "right" version is the fully compatible version for your kubernetes cluster or the latest such version if you have multiple kubernetes clusters with different versions. I am not seeing anything in the docs which explains that or that this the line you would want to change. I wonder if the different versions you are needing to change here were meant to convey message.

Copy link
Contributor Author

@sttts sttts Dec 19, 2017

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's documented in README.md (https://github.com/kubernetes/client-go/pull/347/files#diff-04c6e90faac2675aa89e2176d2eec7d8R82). But your comment shows once again that all this is far too complicated and spread over too many files. We cannot change this here in the PR, but I am for a major rewrite of the docs here. Compare #337 from your colleague who struggled as well from this documentation.

@sttts
Copy link
Contributor Author

sttts commented Dec 19, 2017

Merging this, with agreement on https://github.com/kubernetes/client-go/pull/347/files#r157535202.

I think we all agree that we have to work on these two files and simplify things. But we should do that in follow-ups, it's nothing specific to v6.

@sttts sttts merged commit a4971b3 into master Dec 19, 2017
@sttts sttts deleted the sttts-6-README branch December 19, 2017 08:22
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. 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.

6 participants