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

updating contrib for ref docs (#18787)

Browse Source 
more cleanup
This commit is contained in:
Karen Bradshaw
2020-02-06 16:53:25 -05:00
committed by GitHub
parent 79e1b94c91
commit 121076085c
8 changed files with 433 additions and 385 deletions
Download Patch File Download Diff File Expand all files Collapse all files
update-imported-docs/README.md
+12 -5
View File
@@ -1,12 +1,19 @@
### Update Kubernetes reference docs
This `update-imported-docs.py` script generates the Kubernetes reference docs (component/tool pages, kubectl-command, Kubernetes API reference).
The `update-imported-docs` script generates the Kubernetes reference docs (component and tool pages, kubectl-command
reference, and Kubernetes API reference).
<!-- TODO: Update this information -->
[Generating Reference Pages for Kubernetes Components and Tools](https://kubernetes.io/docs/contribute/generate-ref-docs/kubernetes-components/) contains detailed instructions for using this tool.
For detailed information about the generation process, view the
[Generating Reference Documentation Quickstart Guide](https://kubernetes.io/docs/contribute/generate-ref-docs/quickstart/).
### General Usage
```shell
python3 update-imported-docs.py <config_file> <k8s_release>
```
./update-imported-docs <configuration-file.yml> <k8s_release>
```
For example:
```shell
./update-imported-docs reference.yml 1.17
```