From 45698e8c40e9c5923513540c59b56f655011f012 Mon Sep 17 00:00:00 2001 From: yuswift Date: Mon, 26 Jul 2021 20:48:02 +0800 Subject: [PATCH] fix typo in content/en/docs/contribute/generate-ref-docs/quickstart.md Signed-off-by: yuswift --- .../contribute/generate-ref-docs/quickstart.md | 15 +++++++-------- 1 file changed, 7 insertions(+), 8 deletions(-) diff --git a/content/en/docs/contribute/generate-ref-docs/quickstart.md b/content/en/docs/contribute/generate-ref-docs/quickstart.md index c9b15a2360..51bff81cf8 100644 --- a/content/en/docs/contribute/generate-ref-docs/quickstart.md +++ b/content/en/docs/contribute/generate-ref-docs/quickstart.md @@ -6,7 +6,7 @@ weight: 40 -This page shows how to use the `update-imported-docs` script to generate +This page shows how to use the `update-imported-docs.py` script to generate the Kubernetes reference documentation. The script automates the build setup and generates the reference documentation for a release. @@ -39,7 +39,7 @@ see the [contributing upstream guide](/docs/contribute/generate-ref-docs/contrib ## Overview of update-imported-docs -The `update-imported-docs` script is located in the `/update-imported-docs/` +The `update-imported-docs.py` script is located in the `/update-imported-docs/` directory. The script builds the following references: @@ -48,7 +48,7 @@ The script builds the following references: * The `kubectl` command reference * The Kubernetes API reference -The `update-imported-docs` script generates the Kubernetes reference documentation +The `update-imported-docs.py` script generates the Kubernetes reference documentation from the Kubernetes source code. The script creates a temporary directory under `/tmp` on your machine and clones the required repositories: `kubernetes/kubernetes` and `kubernetes-sigs/reference-docs` into this directory. @@ -69,7 +69,7 @@ The `generate-command` field defines a series of build instructions from `kubernetes-sigs/reference-docs/Makefile`. The `K8S_RELEASE` variable determines the version of the release. -The `update-imported-docs` script performs the following steps: +The `update-imported-docs.py` script performs the following steps: 1. Clones the related repositories specified in a configuration file. For the purpose of generating reference docs, the repository that is cloned by @@ -152,17 +152,17 @@ For example: ## Running the update-imported-docs tool -You can run the `update-imported-docs` tool as follows: +You can run the `update-imported-docs.py` tool as follows: ```shell cd /update-imported-docs -./update-imported-docs +./update-imported-docs.py ``` For example: ```shell -./update-imported-docs reference.yml 1.17 +./update-imported-docs.py reference.yml 1.17 ``` @@ -254,4 +254,3 @@ running the build targets, see the following guides: * [Generating Reference Documentation for kubectl Commands](/docs/contribute/generate-ref-docs/kubectl/) * [Generating Reference Documentation for the Kubernetes API](/docs/contribute/generate-ref-docs/kubernetes-api/) -