2020-01-07 00:50:18 +00:00
|
|
|
### Update Kubernetes reference docs
|
2018-01-11 04:03:16 +00:00
|
|
|
|
2020-02-06 21:53:25 +00:00
|
|
|
The `update-imported-docs` script generates the Kubernetes reference docs (component and tool pages, kubectl-command
|
|
|
|
|
reference, and Kubernetes API reference).
|
2018-01-11 04:03:16 +00:00
|
|
|
|
2020-02-06 21:53:25 +00:00
|
|
|
For detailed information about the generation process, view the
|
|
|
|
|
[Generating Reference Documentation Quickstart Guide](https://kubernetes.io/docs/contribute/generate-ref-docs/quickstart/).
|
2020-01-07 00:50:18 +00:00
|
|
|
|
|
|
|
|
### General Usage
|
|
|
|
|
|
|
|
|
|
```shell
|
2020-02-06 21:53:25 +00:00
|
|
|
./update-imported-docs <configuration-file.yml> <k8s_release>
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
For example:
|
|
|
|
|
|
|
|
|
|
```shell
|
|
|
|
|
./update-imported-docs reference.yml 1.17
|
|
|
|
|
```
|
