Skip to content
Permalink
Browse files

Tidy reference doc generation guide (#14825)

- fix YAML marked as shell
- trim trailing whitespace
  • Loading branch information...
sftim authored and k8s-ci-robot committed Jun 17, 2019
1 parent d1a47bf commit ca9e44ff9c25506f4aac12c2cb0bb1e168d0c81c
Showing with 4 additions and 4 deletions.
  1. +4 −4 content/en/docs/contribute/generate-ref-docs/kubernetes-components.md
@@ -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
what it is doing and need to change the specified release branch.

```shell
```yaml
repos:
- name: reference-docs
remote: https://github.com/kubernetes-incubator/reference-docs.git
# This and the generate-command below needs a change when reference-docs has
# branches properly defined
branch: master
branch: master
generate-command: |
cd $GOPATH
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`.
For example:

```shell
```yaml
files:
- src: gen-compdocs/build/kubeadm*.md
dst: content/en/docs/reference/setup-tools/kubeadm/generated/
@@ -196,7 +196,7 @@ topics will be visible in the

{{% 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 Federation API](/docs/home/contribute/generated-reference/federation-api/)
* [Contributing to the Upstream Kubernetes Project for Documentation](/docs/contribute/gen-ref-docs/contribute-upstream)

0 comments on commit ca9e44f

Please sign in to comment.
You can’t perform that action at this time.