diff --git a/content/en/docs/contribute/generate-ref-docs/kubernetes-components.md b/content/en/docs/contribute/generate-ref-docs/kubernetes-components.md index 0ec38e8de6..b19f060714 100644 --- a/content/en/docs/contribute/generate-ref-docs/kubernetes-components.md +++ b/content/en/docs/contribute/generate-ref-docs/kubernetes-components.md @@ -12,7 +12,6 @@ reference documentation for tools and components in the {{% /capture %}} - {{% capture prerequisites %}} * You need a machine that is running Linux or macOS. @@ -36,7 +35,6 @@ information, see {{% /capture %}} - {{% capture steps %}} ## Getting two repositories @@ -115,9 +113,8 @@ need to work with someone who can set the label and milestone for you. ## Overview of update-imported-docs -The website repository contains a `update-imported-docs` tool under the -`kubernetes/website/update-imported-docs/` directory that performs the -following steps: +The `update-imported-docs` tool is located in the `kubernetes/website/update-imported-docs/` +directory. The tool performs the following steps: 1. Clones the related repositories specified in a configuration file. For the purpose of generating reference docs, the repositories that are cloned by @@ -134,8 +131,8 @@ to `kubernetes/website`. ## Customizing the config file -Open `/update-imported-docs/reference.yaml` for editing. -Do not change the content for the `generate-command` entry unless you undertand +Open `/update-imported-docs/reference.yml` for editing. +Do not change the content for the `generate-command` entry unless you understand what it is doing and need to change the specified release branch. ```shell @@ -159,8 +156,9 @@ repos: make comp ``` -The `update-imported-docs` tool uses `src` and `dst` fields in a configuration -to decide the source and target location for doc files to be copied. +In reference.yml, the `files` field is a list of `src` and `dst` fields. The `src` field +specifies the location of a generated Markdown file, and the `dst` field specifies +where to copy this file in the cloned `kubernetes/website` repository. For example: ```yaml @@ -240,6 +238,4 @@ topics will be visible in the * [Generating Reference Documentation for the Kubernetes API](/docs/home/contribute/generated-reference/kubernetes-api/) * [Generating Reference Documentation for the Kubernetes Federation API](/docs/home/contribute/generated-reference/federation-api/) -{{% /capture %}} - - +{{% /capture %}} \ No newline at end of file