whentimeslows/website
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Fixed incorrect commands for generating docs (#19693)

Browse Source 
I followed the process for generating docs, but encountered and fixed some problems along the way due to incorrect commands in the documentation:
* Fixed incorrect go get source for `github.com/kubernetes-sigs/reference-docs`
* Fixed syntax error in shell commands by changing `$(GOPATH)` to `$GOPATH`
* Fixed wrong variable name, changed `WEB_ROOT` to `K8S_WEBROOT` to match what Makefile expects
This commit is contained in:
Brian Pursley
2020-03-17 16:05:27 -04:00
committed by GitHub
parent b1050541c7
commit e1397c9e2d
1 changed files with 4 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files
content/en/docs/contribute/generate-ref-docs/kubectl.md
+4 -4
View File
@@ -47,7 +47,7 @@ Get a local clone of the following repositories:
go get -u github.com/spf13/pflag go get -u github.com/spf13/pflag
go get -u github.com/spf13/cobra go get -u github.com/spf13/cobra
go get -u gopkg.in/yaml.v2 go get -u gopkg.in/yaml.v2
go get -u kubernetes-sigs/reference-docs go get -u github.com/kubernetes-sigs/reference-docs
``` ```
If you don't already have the kubernetes/website repository, get it now: If you don't already have the kubernetes/website repository, get it now:
@@ -140,15 +140,15 @@ need to work with someone who can set the label and milestone for you.
Go to `<rdocs-base>`. On you command line, set the following environment variables. Go to `<rdocs-base>`. On you command line, set the following environment 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, set `K8S_RELEASE` to 1.17.
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
``` ```