mirror of
https://github.com/k3s-io/kubernetes.git
synced 2025-07-20 10:20:51 +00:00
add documentation about auto-generating auto-documentation
Change-Id: I6bfa6a7e8d83d211f4e52865e033b9911f607c58
This commit is contained in:
parent
325f09045f
commit
8dffb57188
@ -25,3 +25,16 @@ To update the golden test list, you can run:
|
|||||||
```console
|
```console
|
||||||
./test/instrumentation/test-update.sh
|
./test/instrumentation/test-update.sh
|
||||||
```
|
```
|
||||||
|
|
||||||
|
To update the list of documented metrics (which you need to run first before
|
||||||
|
upgrading the documentation markdown file).
|
||||||
|
|
||||||
|
```console
|
||||||
|
./test/instrumentation/update-documentation-metrics.sh
|
||||||
|
```
|
||||||
|
|
||||||
|
To update the documented list of metrics for k8s/website, please run:
|
||||||
|
|
||||||
|
```console
|
||||||
|
./test/instrumentation/update-documentation.sh
|
||||||
|
```
|
||||||
|
@ -53,12 +53,12 @@ These are the metrics which are exported in Kubernetes components (i.e. kube-api
|
|||||||
<table class="table">
|
<table class="table">
|
||||||
<thead>
|
<thead>
|
||||||
<tr>
|
<tr>
|
||||||
<td>Name</td>
|
<td width="20%">Name</td>
|
||||||
<td>Stability Level</td>
|
<td width="12%">Stability Level</td>
|
||||||
<td>Type</td>
|
<td width="12%">Type</td>
|
||||||
<td width="20%">Help</td>
|
<td width="30%">Help</td>
|
||||||
<td>Labels</td>
|
<td width="13%">Labels</td>
|
||||||
<td>Const Labels</td>
|
<td width="13%">Const Labels</td>
|
||||||
</tr>
|
</tr>
|
||||||
</thead>
|
</thead>
|
||||||
<tbody>
|
<tbody>
|
||||||
|
12
test/instrumentation/testdata/documentation.md
vendored
12
test/instrumentation/testdata/documentation.md
vendored
@ -15,12 +15,12 @@ These are the metrics which are exported in Kubernetes components (i.e. kube-api
|
|||||||
<table class="table">
|
<table class="table">
|
||||||
<thead>
|
<thead>
|
||||||
<tr>
|
<tr>
|
||||||
<td>Name</td>
|
<td width="20%">Name</td>
|
||||||
<td>Stability Level</td>
|
<td width="12%">Stability Level</td>
|
||||||
<td>Type</td>
|
<td width="12%">Type</td>
|
||||||
<td width="20%">Help</td>
|
<td width="30%">Help</td>
|
||||||
<td>Labels</td>
|
<td width="13%">Labels</td>
|
||||||
<td>Const Labels</td>
|
<td width="13%">Const Labels</td>
|
||||||
</tr>
|
</tr>
|
||||||
</thead>
|
</thead>
|
||||||
<tbody>
|
<tbody>
|
||||||
|
Loading…
Reference in New Issue
Block a user