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

Merge pull request #27386 from nicks/patch-1 

Fixed errors in instructions for generating ref docs
This commit is contained in:
Kubernetes Prow Robot 2021-04-04 23:56:14 -07:00 committed by GitHub
parent c6194a2473 34f1d61c60
commit 8b2ecd55ec
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 6 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
content/en/docs/contribute/generate-ref-docs/kubernetes-api.md
View File

@ -83,16 +83,16 @@ This section shows how to generate the
### Setting build variables ### Setting build variables
* Set `K8S_ROOT` to `<k8s-base>`. * Set `K8S_ROOT` to `<k8s-base>`.
* Set `WEB_ROOT` to `<web-base>`. * Set `K8S_WEBROOT` to `<web-base>`.
* Set `K8S_RELEASE` to the version of the docs you want to build. * Set `K8S_RELEASE` to the version of the docs you want to build.
For example, if you want to build docs for Kubernetes 1.17, set `K8S_RELEASE` to 1.17. For example, if you want to build docs for Kubernetes 1.17.0, set `K8S_RELEASE` to 1.17.0.
For example: For example:
```shell ```shell
export WEB_ROOT=$(GOPATH)/src/github.com/<your-username>/website export K8S_WEBROOT=$(GOPATH)/src/github.com/<your-username>/website
export K8S_ROOT=$(GOPATH)/src/k8s.io/kubernetes export K8S_ROOT=$(GOPATH)/src/k8s.io/kubernetes
export K8S_RELEASE=1.17 export K8S_RELEASE=1.17.0
``` ```
### Creating versioned directory and fetching Open API spec ### Creating versioned directory and fetching Open API spec
@ -124,8 +124,8 @@ make copyapi
Verify that these two files have been generated: Verify that these two files have been generated:
```shell ```shell
[ -e "<rdocs-base>/gen-apidocs/generators/build/index.html" ] && echo "index.html built" || echo "no index.html" [ -e "<rdocs-base>/gen-apidocs/build/index.html" ] && echo "index.html built" || echo "no index.html"
[ -e "<rdocs-base>/gen-apidocs/generators/build/navData.js" ] && echo "navData.js built" || echo "no navData.js" [ -e "<rdocs-base>/gen-apidocs/build/navData.js" ] && echo "navData.js built" || echo "no navData.js"
``` ```
Go to the base of your local `<web-base>`, and Go to the base of your local `<web-base>`, and