Merge pull request #44320 from Gauravpadam/metric-refdocs

Added documentation for metrics generation

Author: k8s-ci-robot

content/en/docs/contribute/generate-ref-docs/metrics-reference.md

@@ -0,0 +1,95 @@
+---
+title: Generating reference documentation for metrics
+content_type: task
+weight: 100
+---
+
+<!-- overview -->
+
+This page demonstrates the generation of metrics reference documentation
+
+## {{% heading "prerequisites" %}}
+
+{{< include "prerequisites-ref-docs.md" >}}
+
+<!-- steps -->
+
+## Cloning the Kubernetes repository
+
+The metric generation happens in the Kubernetes repository. 
+To clone the repository, Change directories to where you want the clone to exist.
+
+Then, execute the following command:
+
+```shell
+git clone https://www.github.com/kubernetes/kubernetes 
+```
+
+This creates a `kubernetes` folder in your current working directory.
+
+## Generate the metrics
+
+Inside the cloned Kubernetes repository, locate the 
+`test/instrumentation/documentation` directory.
+The metrics documentation is generated in this directory.
+
+With each release, new metrics are added.
+After you run the metrics documentation generator script, copy the 
+metrics documentation to the Kubernetes website and
+publish the updated metrics documentation.
+
+To generate the latest metrics, Make sure you are in the root of the cloned Kubernetes directory. 
+Then, execute the following command:
+
+```shell
+./test/instrumentation/update-documentation.sh
+```
+
+To check for changes, execute:
+
+```shell
+git status
+```
+
+The output is similar to
+
+```
+./test/instrumentation/documentation/documentation.md
+./test/instrumentation/documentation/documentation-list.yaml
+```
+
+## Copy the generated metrics documentation file to the Kubernetes website repository
+
+1. Set the Kubernetes website root environment variable
+
+Execute the following command to set the website root:
+
+```shell
+export WEBSITE_ROOT=<path to website root>
+```
+
+
+2. Copy operation
+
+Copy the generated metrics file to the Kubernetes website repository.
+
+```shell
+cp ./test/instrumentation/documentation/documentation.md "${WEBSITE_ROOT}/content/en/docs/reference/instrumentation/metrics.md"
+```
+
+{{< note >}}
+If you get an error, check that you have permission to copy the file.
+You can use `chown` to change the file ownership back to your own user.
+{{< /note >}}
+
+## Creating a pull request
+
+To create a pull request, Follow the instructions in [Opening a pull request](/docs/contribute/new-content/open-a-pr/)
+
+## {{% heading "whatsnext" %}}
+
+* [Contribute-upstream](/docs/contribute/generate-ref-docs/contribute-upstream/)
+* [Generating Reference Docs for Kubernetes Components and Tools](/docs/contribute/generate-ref-docs/kubernetes-components/)
+* [Generating Reference Documentation for kubectl Commands](/docs/contribute/generate-ref-docs/kubectl/)
+
+