github/kubernetes
1
0
Fork 0
mirror of https://github.com/k3s-io/kubernetes.git synced 2025-07-19 09:52:49 +00:00
Code Issues Projects Releases Wiki Activity

add documentation about auto-generating auto-documentation

Browse Source 
Change-Id: I6bfa6a7e8d83d211f4e52865e033b9911f607c58
This commit is contained in:
Han Kang 2022-10-25 15:09:54 -04:00
parent 325f09045f
commit 8dffb57188
3 changed files with 25 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
test/instrumentation/README.md
View File

@ -25,3 +25,16 @@ To update the golden test list, you can run:
```console
./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
```

12
test/instrumentation/documentation/main.go
View File

@ -53,12 +53,12 @@ These are the metrics which are exported in Kubernetes components (i.e. kube-api
<table class="table">
<thead>
<tr>
<td>Name</td>
<td>Stability Level</td>
<td>Type</td>
<td width="20%">Help</td>
<td>Labels</td>
<td>Const Labels</td>
<td width="20%">Name</td>
<td width="12%">Stability Level</td>
<td width="12%">Type</td>
<td width="30%">Help</td>
<td width="13%">Labels</td>
<td width="13%">Const Labels</td>
</tr>
</thead>
<tbody>

12
test/instrumentation/testdata/documentation.md vendored
View File

@ -15,12 +15,12 @@ These are the metrics which are exported in Kubernetes components (i.e. kube-api
<table class="table">
<thead>
<tr>
<td>Name</td>
<td>Stability Level</td>
<td>Type</td>
<td width="20%">Help</td>
<td>Labels</td>
<td>Const Labels</td>
<td width="20%">Name</td>
<td width="12%">Stability Level</td>
<td width="12%">Type</td>
<td width="30%">Help</td>
<td width="13%">Labels</td>
<td width="13%">Const Labels</td>
</tr>
</thead>
<tbody>