From 8dffb571883238c1938ab5ce7179019c0f535d9c Mon Sep 17 00:00:00 2001
From: Han Kang <hankang@google.com>
Date: Tue, 25 Oct 2022 15:09:54 -0400
Subject: [PATCH] add documentation about auto-generating auto-documentation

Change-Id: I6bfa6a7e8d83d211f4e52865e033b9911f607c58
---
 test/instrumentation/README.md                 | 13 +++++++++++++
 test/instrumentation/documentation/main.go     | 12 ++++++------
 test/instrumentation/testdata/documentation.md | 12 ++++++------
 3 files changed, 25 insertions(+), 12 deletions(-)

diff --git a/test/instrumentation/README.md b/test/instrumentation/README.md
index b9c41016bf7..80219cdba81 100644
--- a/test/instrumentation/README.md
+++ b/test/instrumentation/README.md
@@ -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
+```
diff --git a/test/instrumentation/documentation/main.go b/test/instrumentation/documentation/main.go
index c7e40709a7c..5e1d02e423e 100755
--- a/test/instrumentation/documentation/main.go
+++ b/test/instrumentation/documentation/main.go
@@ -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>
diff --git a/test/instrumentation/testdata/documentation.md b/test/instrumentation/testdata/documentation.md
index 9a876e0cc1b..764a3cf39e7 100644
--- a/test/instrumentation/testdata/documentation.md
+++ b/test/instrumentation/testdata/documentation.md
@@ -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>