11---
2- title : Generating reference documentation for metrics
2+ title : Generating Reference Documentation for Metrics
33content_type : task
44weight : 100
55---
66
77<!-- overview -->
88
9- This page demonstrates the generation of metrics reference documentation
9+ This page demonstrates the generation of metrics reference documentation.
1010
1111## {{% heading "prerequisites" %}}
1212
1313{{< include "prerequisites-ref-docs.md" >}}
1414
1515<!-- steps -->
1616
17- ## Cloning the Kubernetes repository
17+ ## Clone the Kubernetes repository
1818
19- The metric generation happens in the Kubernetes repository.
20- To clone the repository, Change directories to where you want the clone to exist.
19+ The metric generation happens in the Kubernetes repository.
20+ To clone the repository, change directories to where you want the clone to exist.
2121
2222Then, execute the following command:
2323
@@ -29,16 +29,16 @@ This creates a `kubernetes` folder in your current working directory.
2929
3030## Generate the metrics
3131
32- Inside the cloned Kubernetes repository, locate the
32+ Inside the cloned Kubernetes repository, locate the
3333` test/instrumentation/documentation ` directory.
3434The metrics documentation is generated in this directory.
3535
3636With each release, new metrics are added.
37- After you run the metrics documentation generator script, copy the
37+ After you run the metrics documentation generator script, copy the
3838metrics documentation to the Kubernetes website and
3939publish the updated metrics documentation.
4040
41- To generate the latest metrics, Make sure you are in the root of the cloned Kubernetes directory.
41+ To generate the latest metrics, make sure you are in the root of the cloned Kubernetes directory.
4242Then, execute the following command:
4343
4444``` shell
@@ -51,7 +51,7 @@ To check for changes, execute:
5151git status
5252```
5353
54- The output is similar to
54+ The output is similar to:
5555
5656```
5757./test/instrumentation/documentation/documentation.md
@@ -60,36 +60,31 @@ The output is similar to
6060
6161## Copy the generated metrics documentation file to the Kubernetes website repository
6262
63- 1 . Set the Kubernetes website root environment variable
63+ 1 . Set the Kubernetes website root environment variable.
6464
65- Execute the following command to set the website root:
65+ Execute the following command to set the website root:
6666
67- ``` shell
68- export WEBSITE_ROOT=< path to website root>
69- ```
70-
71-
72- 2 . Copy operation
67+ ``` shell
68+ export WEBSITE_ROOT=< path to website root>
69+ ```
7370
74- Copy the generated metrics file to the Kubernetes website repository.
71+ 2 . Copy the generated metrics file to the Kubernetes website repository.
7572
76- ``` shell
77- cp ./test/instrumentation/documentation/documentation.md " ${WEBSITE_ROOT} /content/en/docs/reference/instrumentation/metrics.md"
78- ```
73+ ``` shell
74+ cp ./test/instrumentation/documentation/documentation.md " ${WEBSITE_ROOT} /content/en/docs/reference/instrumentation/metrics.md"
75+ ```
7976
80- {{< note >}}
81- If you get an error, check that you have permission to copy the file.
82- You can use ` chown ` to change the file ownership back to your own user.
83- {{< /note >}}
77+ {{< note >}}
78+ If you get an error, check that you have permission to copy the file.
79+ You can use ` chown ` to change the file ownership back to your own user.
80+ {{< /note >}}
8481
85- ## Creating a pull request
82+ ## Create a pull request
8683
87- To create a pull request, Follow the instructions in [ Opening a pull request] ( /docs/contribute/new-content/open-a-pr/ )
84+ To create a pull request, follow the instructions in [ Opening a pull request] ( /docs/contribute/new-content/open-a-pr/ ) .
8885
8986## {{% heading "whatsnext" %}}
9087
9188* [ Contribute-upstream] ( /docs/contribute/generate-ref-docs/contribute-upstream/ )
9289* [ Generating Reference Docs for Kubernetes Components and Tools] ( /docs/contribute/generate-ref-docs/kubernetes-components/ )
9390* [ Generating Reference Documentation for kubectl Commands] ( /docs/contribute/generate-ref-docs/kubectl/ )
94-
95-
0 commit comments