Revise guide for generating reference docs #13375
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
k8s-ci-robot
added
the
cncf-cla: yes
k8s-ci-robot
added
the
size/XL
tengqm
requested review from
xiangpengzhao
and removed request for
zhangxiaoyu-zidif and
Rajakavitha1
k8s-ci-robot
added
language/en
tengqm
force-pushed
the
rev-gendoc-guide
branch
from
96dc79b to
53fe1d0
Compare
|
Deploy preview for kubernetes-io-master-staging ready! Built with commit 96dc79b https://deploy-preview-13375--kubernetes-io-master-staging.netlify.com |
|
Deploy preview for kubernetes-io-master-staging ready! Built with commit ceebfef https://deploy-preview-13375--kubernetes-io-master-staging.netlify.com |
|
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
force-pushed
the
rev-gendoc-guide
branch
from
53fe1d0 to
9691f68
Compare
|
related: #13396 |
|
/lgtm @tengqm stellar PR, great walk through story 😍 |
k8s-ci-robot
added
the
lgtm
|
@Bradamant3 in case you have time to review it ? |
k8s-ci-robot
removed
the
lgtm
|
/lgtm |
k8s-ci-robot
added
the
lgtm
|
[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 |
k8s-ci-robot
added
the
approved
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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.