@@ -6,7 +6,7 @@ weight: 40
6
6
7
7
<!-- overview -->
8
8
9
- This page shows how to use the ` update-imported-docs ` script to generate
9
+ This page shows how to use the ` update-imported-docs.py ` script to generate
10
10
the Kubernetes reference documentation. The script automates
11
11
the build setup and generates the reference documentation for a release.
12
12
@@ -39,7 +39,7 @@ see the [contributing upstream guide](/docs/contribute/generate-ref-docs/contrib
39
39
40
40
## Overview of update-imported-docs
41
41
42
- The ` update-imported-docs ` script is located in the ` <web-base>/update-imported-docs/ `
42
+ The ` update-imported-docs.py ` script is located in the ` <web-base>/update-imported-docs/ `
43
43
directory.
44
44
45
45
The script builds the following references:
@@ -48,7 +48,7 @@ The script builds the following references:
48
48
* The ` kubectl ` command reference
49
49
* The Kubernetes API reference
50
50
51
- The ` update-imported-docs ` script generates the Kubernetes reference documentation
51
+ The ` update-imported-docs.py ` script generates the Kubernetes reference documentation
52
52
from the Kubernetes source code. The script creates a temporary directory
53
53
under ` /tmp ` on your machine and clones the required repositories: ` kubernetes/kubernetes ` and
54
54
` kubernetes-sigs/reference-docs ` into this directory.
@@ -69,7 +69,7 @@ The `generate-command` field defines a series of build instructions
69
69
from ` kubernetes-sigs/reference-docs/Makefile ` . The ` K8S_RELEASE ` variable
70
70
determines the version of the release.
71
71
72
- The ` update-imported-docs ` script performs the following steps:
72
+ The ` update-imported-docs.py ` script performs the following steps:
73
73
74
74
1 . Clones the related repositories specified in a configuration file. For the
75
75
purpose of generating reference docs, the repository that is cloned by
@@ -152,17 +152,17 @@ For example:
152
152
153
153
# # Running the update-imported-docs tool
154
154
155
- You can run the `update-imported-docs` tool as follows :
155
+ You can run the `update-imported-docs.py ` tool as follows :
156
156
157
157
` ` ` shell
158
158
cd <web-base>/update-imported-docs
159
- ./update-imported-docs <configuration-file.yml> <release-version>
159
+ ./update-imported-docs.py <configuration-file.yml> <release-version>
160
160
` ` `
161
161
162
162
For example :
163
163
164
164
` ` ` shell
165
- ./update-imported-docs reference.yml 1.17
165
+ ./update-imported-docs.py reference.yml 1.17
166
166
` ` `
167
167
168
168
<!-- Revisit : is the release configuration used -->
@@ -254,4 +254,3 @@ running the build targets, see the following guides:
254
254
* [Generating Reference Documentation for kubectl Commands](/docs/contribute/generate-ref-docs/kubectl/)
255
255
* [Generating Reference Documentation for the Kubernetes API](/docs/contribute/generate-ref-docs/kubernetes-api/)
256
256
257
-
0 commit comments