kubernetes
/
website
mirror of https://github.com/kubernetes/website.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Tidy reference doc generation guide (#14825) 

- fix YAML marked as shell
- trim trailing whitespace
pull/14936/head
Tim Bannister 2019-06-17 02:04:07 +01:00 committed by Kubernetes Prow Robot
parent d1a47bf88c
commit ca9e44ff9c
1 changed files with 4 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
content/en/docs/contribute/generate-ref-docs/kubernetes-components.md
View File

@ -97,13 +97,13 @@ Open `<web-base>/update-imported-docs/reference.yml` for editing.
Do not change the content for the `generate-command` entry unless you understand Do not change the content for the `generate-command` entry unless you understand
what it is doing and need to change the specified release branch. what it is doing and need to change the specified release branch.
```shell ```yaml
repos: repos:
- name: reference-docs - name: reference-docs
remote: https://github.com/kubernetes-incubator/reference-docs.git remote: https://github.com/kubernetes-incubator/reference-docs.git
# This and the generate-command below needs a change when reference-docs has # This and the generate-command below needs a change when reference-docs has
# branches properly defined # branches properly defined
branch: master branch: master
generate-command: | generate-command: |
cd $GOPATH cd $GOPATH
git clone https://github.com/kubernetes/kubernetes.git src/k8s.io/kubernetes git clone https://github.com/kubernetes/kubernetes.git src/k8s.io/kubernetes
@ -138,7 +138,7 @@ to the same destination directory, you can use wildcards in the value given to
`src` and you can just provide the directory name as the value for `dst`. `src` and you can just provide the directory name as the value for `dst`.
For example: For example:
```shell ```yaml
files: files:
- src: gen-compdocs/build/kubeadm*.md - src: gen-compdocs/build/kubeadm*.md
dst: content/en/docs/reference/setup-tools/kubeadm/generated/ dst: content/en/docs/reference/setup-tools/kubeadm/generated/
@ -196,7 +196,7 @@ topics will be visible in the
{{% capture whatsnext %}} {{% capture whatsnext %}}
* [Generating Reference Documentation for kubectl Commands](/docs/home/contribute/generated-reference/kubectl/) * [Generating Reference Documentation for kubectl Commands](/docs/home/contribute/generated-reference/kubectl/)
* [Generating Reference Documentation for the Kubernetes API](/docs/home/contribute/generated-reference/kubernetes-api/) * [Generating Reference Documentation for the Kubernetes API](/docs/home/contribute/generated-reference/kubernetes-api/)
* [Generating Reference Documentation for the Kubernetes Federation API](/docs/home/contribute/generated-reference/federation-api/) * [Generating Reference Documentation for the Kubernetes Federation API](/docs/home/contribute/generated-reference/federation-api/)
* [Contributing to the Upstream Kubernetes Project for Documentation](/docs/contribute/gen-ref-docs/contribute-upstream) * [Contributing to the Upstream Kubernetes Project for Documentation](/docs/contribute/gen-ref-docs/contribute-upstream)