Create docs that explain how to update generated reference pages. #6366

steveperry-53 · 2017-11-17T19:36:22Z

This PR creates four new topics. Here are the previews:

This change is

k8sio-netlify-preview-bot · 2017-11-17T19:38:41Z

Deploy preview ready!

Built with commit 7b78afd

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

tengqm · 2017-11-20T01:17:13Z

docs/home/contribute/generated-reference/federation-components.md

@@ -0,0 +1,64 @@
+---
+title: Generating Reference Pages for Kubernetes Federation Components


This page is not linked from docs-home.html ?

There's a new home page coming soon as part of the User Journeys project. We'll revisit linking when that is in place.

k8s-ci-robot · 2017-11-29T23:33:14Z

Thanks for your pull request. Before we can look at your pull request, you'll need to sign a Contributor License Agreement (CLA).

📝 Please follow instructions at https://github.com/kubernetes/kubernetes/wiki/CLA-FAQ to sign the CLA.

It may take a couple minutes for the CLA signature to be fully registered; after that, please reply here with a new comment and we'll verify. Thanks.

If you've already signed a CLA, it's possible we don't have your GitHub username or you're using a different email address. Check your existing CLA data and verify that your email is set on your git commits.
If you signed the CLA as a corporation, please sign in with your organization's credentials at https://identity.linuxfoundation.org/projects/cncf to be authorized.
If you have done the above and are still having issues with the CLA being reported as unsigned, please email the CNCF helpdesk: helpdesk@rt.linuxfoundation.org

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository. I understand the commands that are listed here.

tengqm · 2017-11-30T08:36:07Z

docs/home/contribute/generated-reference/federation-api.md

+go get github.com/kubernetes/federation
+```
+
+TODO: Checkout the branch of interest. For 1.8 docs, release-1.8.


This TODO for you or for readers? :)

tengqm · 2017-11-30T08:39:37Z

docs/home/contribute/generated-reference/federation-components.md

+go get github.com/kubernetes/federation
+```
+
+TODO: Checkout the branch of interest. For 1.8 docs, release-1.8.


steveperry-53 · 2017-12-05T22:19:33Z

@zachpuck

steveperry-53 · 2018-01-05T21:04:50Z

@chenopis Could you do a sanity check on this. There are several things we could do to improve these topics, but in the interest of finishing this PR in finite time, I'd like to wrap this up. We can do further improvements in future PRs.

For example, in a future PR, we could enhance the Federation API topic by showing how to edit comments in the Federation source code.

steveperry-53 · 2018-01-05T21:05:17Z

cc @heckj

heckj · 2018-01-06T00:05:05Z

This totally works, but won't most individuals be using their own forks of the k/website repository? We reference the whole "pull request" under the Federation docs - do we need more specific details there, or am I being overly conservative about the reader's knowledge/skills here?

Reviewed 7 of 7 files at r5.
Review status: all files reviewed at latest revision, 4 unresolved discussions.

Comments from Reviewable

steveperry-53 · 2018-01-06T00:17:34Z

@heckj If I knew how to use Reviewable, I would reply there. But try as I will, I can't figure it out.

Anyway, I think we can link to our existing topics on creating a fork and a pull request to kubernetes/website.

For help creating pull requests to kubernetes/kubernetes and kubernetes/federation, I'm not sure what to do. I don't want to teach Git and GitHub in these new topics.

The reader has to be set up with a Golang development environment. That makes me think the reader probably knows how to create a pull request, and the reader probably has a workflow that involves a fork.

For readers who don't already have a local kubernetes/xxx repo, I show one way of cloning (go get). The fact that I show cloning the upstream repo doesn't stop the reader from using a workflow that involves a fork.

steveperry-53 · 2018-01-06T01:03:51Z

@heckj @chenopis How about this? Under Before you begin, we explain that you need to know how to create a pull request, and that this typically involves having a fork. For more info, see xxxx.

heckj · 2018-01-06T01:23:45Z

yeah, totally good with that

…

-joe

On Jan 5, 2018, at 5:03 PM, Steve Perry ***@***.***> wrote: @heckj @chenopis How about this? Under Before you begin, we explain that you need to know how to create a pull request, and that this typically involves having a fork. For more info, see xxxx. — You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub, or mute the thread.

steveperry-53 · 2018-01-06T03:28:24Z

@hekj @chenopis I added text about creating PRs to the Before you begin sections.

chenopis

You might want to double check the version requirement for Golang for each of these. I ran into an error indicating I should upgrade to Golang v1.9 when running hack/generate-docs.sh for kubernetes/kubernetes but not kubernetes/federation.

chenopis · 2018-01-09T20:40:41Z

docs/home/contribute/generated-reference/kubernetes-components.md

+
+    * [Git](https://git-scm.com/book/en/v2/Getting-Started-Installing-Git)
+
+    * [Golang](https://golang.org/doc/install) version 1.8 or later


Just found out kubernetes/kubernetes is now requiring Go v1.9+ in order to run hack/generate-docs.sh. LGTM otherwise.

chenopis · 2018-01-09T20:55:51Z

docs/home/contribute/generated-reference/kubernetes-components.md

+
+    * [Git](https://git-scm.com/book/en/v2/Getting-Started-Installing-Git)
+
+    * [Golang](https://golang.org/doc/install) version 1.8 or later


Also, users will probably need to run go get github.com/ghodss/yaml if they don't already have it, since it's a requirement of the script.

zacharysarah · 2018-01-10T23:01:34Z

This looks amazing. 🌟

…henopis-user-journeys * 'master' of https://github.com/kubernetes/website: fix admission plugins orders (#6900) link to other terms (#6625) Fix See Also links. (#6948) --experimental-nvidia-gpus error (#6527) Add HA guide for kubeadm (#6458) remove duplicated and conflicted TOC instrument fix deadlink Clarify the token webhook posts the TokenReview object Update federation.md Update create-cluster-kubeadm.md Add note about viewing changes locally. (#6936) Create page that lists supported doc versions. (#6882) Document how to generate reference pages. (#6366) Update networking.md to list ACI CNI plugin (#6367) Update kubeadm-init.md (#6932) fix typo in doc kubeadm-alpha dulplicated sentences Update certificates.md Replace all kube-ui with kubernetes dashboard Add openstack internal load balancer option

steveperry-53 added the do-not-merge DEPRECATED. Indicates that a PR should not merge. Label can only be manually applied/removed. label Nov 17, 2017

steveperry-53 self-assigned this Nov 17, 2017

k8s-ci-robot added size/M Denotes a PR that changes 30-99 lines, ignoring generated files. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. labels Nov 17, 2017

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 17, 2017

steveperry-53 force-pushed the ref-gen branch from 3761924 to 5c3498a Compare November 18, 2017 01:10

tengqm reviewed Nov 20, 2017

View reviewed changes

steveperry-53 force-pushed the ref-gen branch 3 times, most recently from 447ad6f to 1677939 Compare November 21, 2017 17:56

k8s-ci-robot added size/XL Denotes a PR that changes 500-999 lines, ignoring generated files. and removed size/L Denotes a PR that changes 100-499 lines, ignoring generated files. labels Nov 21, 2017

steveperry-53 force-pushed the ref-gen branch from df7d5b9 to 57a379d Compare November 22, 2017 18:16

k8s-ci-robot removed the cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. label Nov 29, 2017

k8s-ci-robot added the cncf-cla: no Indicates the PR's author has not signed the CNCF CLA. label Nov 29, 2017

steveperry-53 removed the cncf-cla: no Indicates the PR's author has not signed the CNCF CLA. label Nov 29, 2017

steveperry-53 force-pushed the ref-gen branch from 410a182 to 3fae5cb Compare November 29, 2017 23:45

k8s-ci-robot added the cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. label Nov 29, 2017

tengqm reviewed Nov 30, 2017

View reviewed changes

steveperry-53 closed this Dec 19, 2017

steveperry-53 deleted the ref-gen branch December 19, 2017 02:05

steveperry-53 restored the ref-gen branch December 19, 2017 02:35

steveperry-53 reopened this Dec 19, 2017

steveperry-53 force-pushed the ref-gen branch from 1ab056b to c76a5fb Compare December 21, 2017 18:34

This was referenced Dec 21, 2017

Fix typo in comment, and generate OpenAPI spec so docs can be regener… kubernetes/kubernetes#57525

Closed

Fix typo in Kubernetes API reference docs. #6734

Merged

steveperry-53 force-pushed the ref-gen branch 2 times, most recently from 751b640 to d287e25 Compare January 4, 2018 21:53

k8s-ci-robot added size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files. and removed size/XL Denotes a PR that changes 500-999 lines, ignoring generated files. labels Jan 5, 2018

steveperry-53 force-pushed the ref-gen branch from 3ef5bf0 to f7f33ab Compare January 5, 2018 20:55

k8s-ci-robot added size/XL Denotes a PR that changes 500-999 lines, ignoring generated files. and removed size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files. labels Jan 5, 2018

steveperry-53 removed the do-not-merge DEPRECATED. Indicates that a PR should not merge. Label can only be manually applied/removed. label Jan 5, 2018

This was referenced Jan 9, 2018

Added IPv6 information to various Component documents #6535

Closed

Import kubernetes/community docs #6863

Merged

chenopis suggested changes Jan 9, 2018

View reviewed changes

chenopis reviewed Jan 9, 2018

View reviewed changes

chenopis approved these changes Jan 9, 2018

View reviewed changes

zacharysarah added the Docs LGTM label Jan 10, 2018

k8s-ci-robot added size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files. and removed size/XL Denotes a PR that changes 500-999 lines, ignoring generated files. labels Jan 11, 2018

Document how to generate reference pages.

7b78afd

steveperry-53 force-pushed the ref-gen branch from 9e13f25 to 7b78afd Compare January 11, 2018 19:58

steveperry-53 merged commit f4ab0f3 into kubernetes:master Jan 11, 2018

steveperry-53 deleted the ref-gen branch January 11, 2018 20:55

chenopis added the team/google label Aug 6, 2018

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Create docs that explain how to update generated reference pages. #6366

Create docs that explain how to update generated reference pages. #6366

steveperry-53 commented Nov 17, 2017 •

edited

Loading

k8sio-netlify-preview-bot commented Nov 17, 2017 •

edited

Loading

tengqm Nov 20, 2017

steveperry-53 Jan 5, 2018

k8s-ci-robot commented Nov 29, 2017

tengqm Nov 30, 2017

tengqm Nov 30, 2017

steveperry-53 commented Dec 5, 2017

steveperry-53 commented Jan 5, 2018

steveperry-53 commented Jan 5, 2018

heckj commented Jan 6, 2018

steveperry-53 commented Jan 6, 2018 •

edited

Loading

steveperry-53 commented Jan 6, 2018

heckj commented Jan 6, 2018 via email

steveperry-53 commented Jan 6, 2018

chenopis left a comment

chenopis Jan 9, 2018 •

edited

Loading

chenopis Jan 9, 2018

zacharysarah commented Jan 10, 2018

		@@ -0,0 +1,64 @@
		---
		title: Generating Reference Pages for Kubernetes Federation Components


		* [Git](https://git-scm.com/book/en/v2/Getting-Started-Installing-Git)

		* [Golang](https://golang.org/doc/install) version 1.8 or later

Create docs that explain how to update generated reference pages. #6366

Create docs that explain how to update generated reference pages. #6366

Conversation

steveperry-53 commented Nov 17, 2017 • edited Loading

k8sio-netlify-preview-bot commented Nov 17, 2017 • edited Loading

tengqm Nov 20, 2017

Choose a reason for hiding this comment

steveperry-53 Jan 5, 2018

Choose a reason for hiding this comment

k8s-ci-robot commented Nov 29, 2017

tengqm Nov 30, 2017

Choose a reason for hiding this comment

tengqm Nov 30, 2017

Choose a reason for hiding this comment

steveperry-53 commented Dec 5, 2017

steveperry-53 commented Jan 5, 2018

steveperry-53 commented Jan 5, 2018

heckj commented Jan 6, 2018

steveperry-53 commented Jan 6, 2018 • edited Loading

steveperry-53 commented Jan 6, 2018

heckj commented Jan 6, 2018 via email

steveperry-53 commented Jan 6, 2018

chenopis left a comment

Choose a reason for hiding this comment

chenopis Jan 9, 2018 • edited Loading

Choose a reason for hiding this comment

chenopis Jan 9, 2018

Choose a reason for hiding this comment

zacharysarah commented Jan 10, 2018

steveperry-53 commented Nov 17, 2017 •

edited

Loading

k8sio-netlify-preview-bot commented Nov 17, 2017 •

edited

Loading

steveperry-53 commented Jan 6, 2018 •

edited

Loading

chenopis Jan 9, 2018 •

edited

Loading