README and issue template updates #3818

chrislovecnm · 2017-11-10T05:16:20Z

Addresses #3813

add information about new features
removing maintainers section
adding GCE documentation to README
reformating the issues template

chrislovecnm · 2017-11-10T05:16:33Z

/assign @geojaz @andrewsykim

geojaz

Nothing major here, just a few edits. thanks @chrislovecnm.

geojaz · 2017-11-10T10:45:38Z

.github/ISSUE_TEMPLATE.md


-6. What you expected to happen:
+1. Can you provide cluster manifest `kops get --name my.example.com -oyaml`?


How about:
Please provide your cluster manifest kops get --name my.example.com -oyaml if possible.

geojaz · 2017-11-10T10:46:55Z

.github/ISSUE_TEMPLATE.md


-7. How can we to reproduce it (as minimally and precisely as possible):
+1. What you expected to happen?


Your numbers got reset here. Silly markdown!

What did you expect to happen when you ran this? What would you like this command to do?

If you just do 1. 1. 1. you do not have to worry about changing them ever. The render with the correct numbers ;)

geojaz · 2017-11-10T10:47:57Z

.github/ISSUE_TEMPLATE.md


-8. Anything else do we need to know:
+1. How can we to reproduce it (as minimally and precisely as possible)?


-to and lose the parens

What is the simplest way to reproduce this result?

geojaz · 2017-11-10T10:50:20Z

.github/ISSUE_TEMPLATE.md


-------------FEATURE REQUEST --------------------
+1. Can you run the `kops` command with the `-v 10` flag and provide logs?


Please run the command with most verbose logging by adding the -v 10 flag and paste the logs into this report.

geojaz · 2017-11-10T10:58:54Z

README.md

+## Kubernetes Release Compatibility
+
+`kops` is intended to be backward compatible.  It is always recommended to use the 
+latest version of kop with whatever version of Kuberentes you are using. This 


s/kop/kops, s/Kuberentes/Kubernetes

geojaz · 2017-11-10T11:00:56Z

.github/ISSUE_TEMPLATE.md


-2. What kops version are you running? use `kops version`
+1. What kops version are you running? Use `kops version`?


I would change the "Use kops version?" to something like:

(run kops version)

Concur. This isn't a question.

geojaz · 2017-11-10T11:01:10Z

.github/ISSUE_TEMPLATE.md


-3. What Kubernetes version are you running? use `kubectl version`
+1. What Kubernetes version are you running? Use `kubectl version`?


geojaz · 2017-11-10T11:01:32Z

.github/ISSUE_TEMPLATE.md


-5. What commands did you execute (Please provide cluster manifest `kops get --name my.example.com`, if available) and what happened after commands executed?
+1. What commands did you execute, and what happened after the commands executed?


What commands did you run and what happened?

justinsb · 2017-11-10T15:22:07Z

.github/ISSUE_TEMPLATE.md


-2. What kops version are you running? use `kops version`
+1. What kops version are you running? Use `kops version`?


Concur. This isn't a question.

justinsb · 2017-11-10T15:27:26Z

README.md

+`kops` is intended to be backward compatible.  It is always recommended to use the 
+latest version of kop with whatever version of Kuberentes you are using. This 
+project does not follow the Kubernetes release schedule but typically releases 
+after Kubernetes does.  `kops` supports the matching Kubernetes minor release.  


I would split out the "This project does not follow the kubernetes release schedule..." sentence into is own paragraph, after this paragraph.

I would also say why we don't follow the kubernetes release schedule. Something like:

"kops aims to provide a reliable installation experience for kubernetes, and typically releases about a month after the corresponding Kubernetes release. This time allows for release issues in kubernetes, and ensures that we can support the latest features. Kops will release alpha and beta pre-releases before then for people that are eager to try the latest kubernetes release and have environments where they can tolerate the quirks of new releases - and please do report any issues encountered."

chrislovecnm · 2017-11-10T18:19:30Z

@geojaz @justinsb PTAL

blakebarnett · 2017-11-10T18:43:20Z

README.md

+the latest version of kops with whatever version of Kubernetes you are using.
+`kops` supports the matching Kubernetes minor release.   For instance kops,
+1.8.x does not support Kubernetes 1.9.x, but kops 1.9.x  supports Kubernetes
+1.9.x.  Moreover, kops 1.8.x attempts to be backward compatible and support


This should say "but kops 1.9.x would support kubernetes 1.8.x" right?

blakebarnett · 2017-11-10T18:43:57Z

README.md

+This project does not follow the Kubernetes release schedule.  `kops` aims to
+provide a reliable installation experience for kubernetes, and typically
+releases about a month after the corresponding Kubernetes release. This time
+allows for release issues in Kubernetes and ensures that we can support the


"allows for release issues to be resolved"

That is passive voice, let me see if I can make it active voice.

blakebarnett

👍

geojaz · 2017-11-10T19:07:40Z

README.md


 To replicate the above demo, check out our [tutorial](/docs/aws.md) for
 launching a Kubernetes cluster hosted on AWS.

+To install a Kuberentes cluster on GCE please follow this [guide](/docs/tutorial/gce.md).


kuberentes :)

chrislovecnm · 2017-11-10T19:08:08Z

/hold

geojaz

Good stuff Chris. The others had excellent feedback as well. once you get rid of the kuberentes, I can approve!

chrislovecnm · 2017-11-10T19:10:48Z

@geojaz I am re-writing the versioning section again. Will ping you

chrislovecnm · 2017-11-10T19:23:02Z

/hold cancel

chrislovecnm · 2017-11-10T19:24:25Z

@blakebarnett @geojaz PTAL

I added more details to the versioning section. It is complicated, so I tried to provide information and examples. Also, I deliberately repeated certain statements.

geojaz · 2017-11-10T19:24:30Z

README.md

+Kubernetes release.  kops does not stop a user from installing mismatching
+versions of K8s, but Kubernetes releases always require kops to install specific
+versions of components like docker, that tested against the particular
+Kuberenetes version.


they're breeding bro!

This is helpful but I almost think we need a diagram or a matrix in addition. Does not need to be a part of this PR

Never said I could spell. I am going to add a table matix here

geojaz · 2017-11-10T19:24:41Z

README.md

+versions of components like docker, that tested against the particular
+Kuberenetes version.
+
+Use the latest version of kops for all releases of Kuberentes, with the caveat


geojaz · 2017-11-10T19:26:19Z

README.md

+### Kubernetes Version Support
+
+kops is intended to be backward compatible.  It is always recommended to use the
+latest version of kops with whatever version of Kubernetes you are using. One


I'm a little bit confused about what you're saying here. Are you saying that regardless of the k8s version, use the latest released kops?

geojaz

not picking on you. more little things :)

geojaz · 2017-11-10T19:32:27Z

README.md

+Kuberenetes version.
+
+Use the latest version of kops for all releases of Kuberentes, with the caveat
+that higher versions of Kuberentes are not _officially_ supported by kops.


👉 here too

chrislovecnm · 2017-11-16T21:07:33Z

@geojaz / @blakebarnett PTAL

blakebarnett · 2017-11-16T21:15:45Z

/lgtm

chrislovecnm · 2017-11-16T21:16:14Z

/approve

chrislovecnm · 2017-11-16T21:17:12Z

/approve

chrislovecnm · 2017-11-16T21:17:45Z

/approve cancel

chrislovecnm · 2017-11-16T21:18:40Z

/approve

blakebarnett · 2017-11-16T21:19:27Z

hah, I only searched for kuberentes

k8s-github-robot · 2017-11-16T21:19:47Z

/lgtm cancel //PR changed after LGTM, removing LGTM. @andrewsykim @blakebarnett @chrislovecnm @geojaz

blakebarnett · 2017-11-16T21:20:57Z

/lgtm

k8s-ci-robot · 2017-11-16T21:21:04Z

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: blakebarnett, chrislovecnm

The full list of commands accepted by this bot can be found here.

Needs approval from an approver in each of these OWNERS Files:

~~OWNERS~~ [chrislovecnm]

You can indicate your approval by writing /approve in a comment
You can cancel your approval by writing /approve cancel in a comment

k8s-github-robot · 2017-11-16T21:51:53Z

Automatic merge from submit-queue.

k8s-ci-robot added 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. labels Nov 10, 2017

k8s-ci-robot assigned andrewsykim and geojaz Nov 10, 2017

chrislovecnm added the retest-not-required-docs-only label Nov 10, 2017

chrislovecnm force-pushed the readme-updates branch 2 times, most recently from 62e688f to 3a8e801 Compare November 10, 2017 06:09

k8s-ci-robot added size/L Denotes a PR that changes 100-499 lines, ignoring generated files. and removed size/M Denotes a PR that changes 30-99 lines, ignoring generated files. labels Nov 10, 2017

chrislovecnm force-pushed the readme-updates branch from 3a8e801 to b8e39a5 Compare November 10, 2017 06:19

geojaz suggested changes Nov 10, 2017

View reviewed changes

justinsb reviewed Nov 10, 2017

View reviewed changes

blakebarnett reviewed Nov 10, 2017

View reviewed changes

geojaz reviewed Nov 10, 2017

View reviewed changes

k8s-ci-robot added the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label Nov 10, 2017

geojaz reviewed Nov 10, 2017

View reviewed changes

chrislovecnm force-pushed the readme-updates branch from 27b65e8 to 8aca438 Compare November 10, 2017 19:22

k8s-ci-robot removed the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label Nov 10, 2017

geojaz reviewed Nov 10, 2017

View reviewed changes

adding new features to README, and removing Maintainers section.

cde5359

chrislovecnm added 2 commits November 16, 2017 14:07

Updating template with better formatting

f514690

updates from PR review

faf5ea2

chrislovecnm force-pushed the readme-updates branch from 8aca438 to faf5ea2 Compare November 16, 2017 21:07

kubernetes deleted a comment from k8s-github-robot Nov 16, 2017

k8s-ci-robot assigned blakebarnett Nov 16, 2017

k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Nov 16, 2017

k8s-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Nov 16, 2017

k8s-ci-robot removed the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Nov 16, 2017

another Kuberenetes fixed

e4b933f

k8s-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Nov 16, 2017

k8s-github-robot removed the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Nov 16, 2017

k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Nov 16, 2017

k8s-github-robot merged commit aa7ee34 into kubernetes:master Nov 16, 2017


		6. What you expected to happen:
		1. Can you provide cluster manifest `kops get --name my.example.com -oyaml`?


		7. How can we to reproduce it (as minimally and precisely as possible):
		1. What you expected to happen?


		8. Anything else do we need to know:
		1. How can we to reproduce it (as minimally and precisely as possible)?


		-------------FEATURE REQUEST --------------------
		1. Can you run the `kops` command with the `-v 10` flag and provide logs?


		2. What kops version are you running? use `kops version`
		1. What kops version are you running? Use `kops version`?


		3. What Kubernetes version are you running? use `kubectl version`
		1. What Kubernetes version are you running? Use `kubectl version`?


		5. What commands did you execute (Please provide cluster manifest `kops get --name my.example.com`, if available) and what happened after commands executed?
		1. What commands did you execute, and what happened after the commands executed?

README and issue template updates #3818

README and issue template updates #3818

Conversation

chrislovecnm commented Nov 10, 2017 • edited Loading

chrislovecnm commented Nov 10, 2017

geojaz left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

chrislovecnm commented Nov 10, 2017

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

blakebarnett left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

chrislovecnm commented Nov 10, 2017

geojaz left a comment • edited Loading

Choose a reason for hiding this comment

chrislovecnm commented Nov 10, 2017

chrislovecnm commented Nov 10, 2017

chrislovecnm commented Nov 10, 2017

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

geojaz left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

chrislovecnm commented Nov 16, 2017

blakebarnett commented Nov 16, 2017

chrislovecnm commented Nov 16, 2017 • edited Loading

chrislovecnm commented Nov 16, 2017

chrislovecnm commented Nov 16, 2017

chrislovecnm commented Nov 16, 2017

blakebarnett commented Nov 16, 2017

k8s-github-robot commented Nov 16, 2017

blakebarnett commented Nov 16, 2017

k8s-ci-robot commented Nov 16, 2017

k8s-github-robot commented Nov 16, 2017

chrislovecnm commented Nov 10, 2017 •

edited

Loading

geojaz left a comment •

edited

Loading

chrislovecnm commented Nov 16, 2017 •

edited

Loading