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

Revise guide for generating reference docs #13375

Merged
merged 3 commits into from
Apr 19, 2019

Conversation

tengqm
Copy link
Contributor

@tengqm tengqm commented Mar 25, 2019

This PR changes the guidance for generating reference documentation for
Kubernetes API and kubernetes components. The topic of making changes to
the upstream repo is separated out because 1) it is not a mandatory step
for generating the reference docs; 2) it is about a more advanced level
of documentation fix.

@k8s-ci-robot k8s-ci-robot added the cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. label Mar 25, 2019
@tengqm tengqm requested a review from steveperry-53 March 25, 2019 07:25
@k8s-ci-robot k8s-ci-robot added the size/XL Denotes a PR that changes 500-999 lines, ignoring generated files. label Mar 25, 2019
@tengqm tengqm requested review from xiangpengzhao and removed request for zhangxiaoyu-zidif and Rajakavitha1 March 25, 2019 07:25
@k8s-ci-robot k8s-ci-robot added language/en Issues or PRs related to English language sig/docs Categorizes an issue or PR as relevant to SIG Docs. labels Mar 25, 2019
@tengqm tengqm requested a review from jimangel March 25, 2019 07:25
@tengqm tengqm force-pushed the rev-gendoc-guide branch from 96dc79b to 53fe1d0 Compare March 25, 2019 07:27
@netlify
Copy link

netlify bot commented Mar 25, 2019

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

Built with commit 96dc79b

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

@netlify
Copy link

netlify bot commented Mar 25, 2019

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

Built with commit ceebfef

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

@daminisatya
Copy link
Contributor

Thank you @tengqm this will be very helpful.

This PR changes the guidance for generating reference documentation for
Kubernetes API and kubernetes components. The topic of making changes to
the upstream repo is separated out because 1) it is not a mandatory step
for generating the reference docs; 2) it is about a more advanced level
of documentation fix.
@tengqm tengqm force-pushed the rev-gendoc-guide branch from 53fe1d0 to 9691f68 Compare March 25, 2019 12:16
@jimangel
Copy link
Member

related: #13396

@DanyC97
Copy link
Contributor

DanyC97 commented Mar 26, 2019

/lgtm

@tengqm stellar PR, great walk through story 😍

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

DanyC97 commented Apr 15, 2019

@Bradamant3 in case you have time to review it ?

@k8s-ci-robot k8s-ci-robot removed the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Apr 19, 2019
@Bradamant3
Copy link
Contributor

/lgtm
/approve

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

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: Bradamant3

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 Apr 19, 2019
@k8s-ci-robot k8s-ci-robot merged commit ad80069 into kubernetes:master Apr 19, 2019
nowjean pushed a commit to nowjean/website that referenced this pull request Jun 13, 2019
* Revise guide for generating reference docs

This PR changes the guidance for generating reference documentation for
Kubernetes API and kubernetes components. The topic of making changes to
the upstream repo is separated out because 1) it is not a mandatory step
for generating the reference docs; 2) it is about a more advanced level
of documentation fix.

* light copyedit

* more light copyedits
@tengqm tengqm deleted the rev-gendoc-guide branch July 5, 2020 01:07
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. language/en Issues or PRs related to English language lgtm "Looks good to me", indicates that a PR is ready to be merged. sig/docs Categorizes an issue or PR as relevant to SIG Docs. size/XL Denotes a PR that changes 500-999 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants