Skip to content

Commit

Permalink
Clean up metrics-reference.md
Browse files Browse the repository at this point in the history
  • Loading branch information
windsonsea committed Jan 22, 2024
1 parent e77dd20 commit 48509ee
Showing 1 changed file with 24 additions and 29 deletions.
53 changes: 24 additions & 29 deletions content/en/docs/contribute/generate-ref-docs/metrics-reference.md
Original file line number Diff line number Diff line change
@@ -1,23 +1,23 @@
---
title: Generating reference documentation for metrics
title: Generating Reference Documentation for Metrics
content_type: task
weight: 100
---

<!-- overview -->

This page demonstrates the generation of metrics reference documentation
This page demonstrates the generation of metrics reference documentation.

## {{% heading "prerequisites" %}}

{{< include "prerequisites-ref-docs.md" >}}

<!-- steps -->

## Cloning the Kubernetes repository
## Clone 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.
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:

Expand All @@ -29,16 +29,16 @@ This creates a `kubernetes` folder in your current working directory.

## Generate the metrics

Inside the cloned Kubernetes repository, locate the
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
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.
To generate the latest metrics, make sure you are in the root of the cloned Kubernetes directory.
Then, execute the following command:

```shell
Expand All @@ -51,7 +51,7 @@ To check for changes, execute:
git status
```

The output is similar to
The output is similar to:

```
./test/instrumentation/documentation/documentation.md
Expand All @@ -60,36 +60,31 @@ The output is similar to

## Copy the generated metrics documentation file to the Kubernetes website repository

1. Set the Kubernetes website root environment variable
1. Set the Kubernetes website root environment variable.

Execute the following command to set the website root:
Execute the following command to set the website root:

```shell
export WEBSITE_ROOT=<path to website root>
```


2. Copy operation
```shell
export WEBSITE_ROOT=<path to website root>
```

Copy the generated metrics file to the Kubernetes website repository.
2. 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"
```
```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 >}}
{{< 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
## Create a pull request

To create a pull request, Follow the instructions in [Opening a pull request](/docs/contribute/new-content/open-a-pr/)
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/)


0 comments on commit 48509ee

Please sign in to comment.