Fix anchor links

GoogleCloudPlatform · Feb 10, 2025 · 120d35d · 120d35d
1 parent 7e2d12e
commit 120d35d
Show file tree

Hide file tree

Showing 9 changed files with 237 additions and 181 deletions.
diff --git a/docs/en/features.md b/docs/en/features.md
diff --git a/docs/en/inspection-type.md b/docs/en/inspection-type.md
@@ -14,16 +14,16 @@ KHI filters out unsupported parser for the selected inspection type at first.
 <!-- END GENERATED PART: inspection-type-element-header-gcp-gke -->
 <!-- BEGIN GENERATED PART: inspection-type-element-header-features-gcp-gke -->
 
-* [Kubernetes Audit Log](./features.md#k8s_audit)
-* [Kubernetes Event Logs](./features.md#k8s_event)
-* [Kubernetes Node Logs](./features.md#k8s_node)
-* [Kubernetes container logs](./features.md#k8s_container)
-* [GKE Audit logs](./features.md#gke_audit)
-* [Compute API Logs](./features.md#compute_api)
-* [GCE Network Logs](./features.md#gce_network)
-* [Autoscaler Logs](./features.md#autoscaler)
-* [Kubernetes Control plane component logs](./features.md#k8s_control_plane_component)
-* [Node serial port logs](./features.md#serialport)
+* [Kubernetes Audit Log](./features.md#kubernetes-audit-log)
+* [Kubernetes Event Logs](./features.md#kubernetes-event-logs)
+* [Kubernetes Node Logs](./features.md#kubernetes-node-logs)
+* [Kubernetes container logs](./features.md#kubernetes-container-logs)
+* [GKE Audit logs](./features.md#gke-audit-logs)
+* [Compute API Logs](./features.md#compute-api-logs)
+* [GCE Network Logs](./features.md#gce-network-logs)
+* [Autoscaler Logs](./features.md#autoscaler-logs)
+* [Kubernetes Control plane component logs](./features.md#kubernetes-control-plane-component-logs)
+* [Node serial port logs](./features.md#node-serial-port-logs)
 <!-- END GENERATED PART: inspection-type-element-header-features-gcp-gke -->
 <!-- BEGIN GENERATED PART: inspection-type-element-header-gcp-composer -->
 ## [Cloud Composer](#gcp-composer)
@@ -33,19 +33,19 @@ KHI filters out unsupported parser for the selected inspection type at first.
 <!-- END GENERATED PART: inspection-type-element-header-gcp-composer -->
 <!-- BEGIN GENERATED PART: inspection-type-element-header-features-gcp-composer -->
 
-* [Kubernetes Audit Log](./features.md#k8s_audit)
-* [Kubernetes Event Logs](./features.md#k8s_event)
-* [Kubernetes Node Logs](./features.md#k8s_node)
-* [Kubernetes container logs](./features.md#k8s_container)
-* [GKE Audit logs](./features.md#gke_audit)
-* [Compute API Logs](./features.md#compute_api)
-* [GCE Network Logs](./features.md#gce_network)
-* [Autoscaler Logs](./features.md#autoscaler)
-* [Kubernetes Control plane component logs](./features.md#k8s_control_plane_component)
-* [Node serial port logs](./features.md#serialport)
-* [(Alpha) Composer / Airflow Scheduler](./features.md#airflow_schedule)
-* [(Alpha) Cloud Composer / Airflow Worker](./features.md#airflow_worker)
-* [(Alpha) Composer / Airflow DagProcessorManager](./features.md#airflow_dag_processor)
+* [Kubernetes Audit Log](./features.md#kubernetes-audit-log)
+* [Kubernetes Event Logs](./features.md#kubernetes-event-logs)
+* [Kubernetes Node Logs](./features.md#kubernetes-node-logs)
+* [Kubernetes container logs](./features.md#kubernetes-container-logs)
+* [GKE Audit logs](./features.md#gke-audit-logs)
+* [Compute API Logs](./features.md#compute-api-logs)
+* [GCE Network Logs](./features.md#gce-network-logs)
+* [Autoscaler Logs](./features.md#autoscaler-logs)
+* [Kubernetes Control plane component logs](./features.md#kubernetes-control-plane-component-logs)
+* [Node serial port logs](./features.md#node-serial-port-logs)
+* [(Alpha) Composer / Airflow Scheduler](./features.md#alpha-composer--airflow-scheduler)
+* [(Alpha) Cloud Composer / Airflow Worker](./features.md#alpha-cloud-composer--airflow-worker)
+* [(Alpha) Composer / Airflow DagProcessorManager](./features.md#alpha-composer--airflow-dagprocessormanager)
 <!-- END GENERATED PART: inspection-type-element-header-features-gcp-composer -->
 <!-- BEGIN GENERATED PART: inspection-type-element-header-gcp-gke-on-aws -->
 ## [GKE on AWS(Anthos on AWS)](#gcp-gke-on-aws)
@@ -55,12 +55,12 @@ KHI filters out unsupported parser for the selected inspection type at first.
 <!-- END GENERATED PART: inspection-type-element-header-gcp-gke-on-aws -->
 <!-- BEGIN GENERATED PART: inspection-type-element-header-features-gcp-gke-on-aws -->
 
-* [Kubernetes Audit Log](./features.md#k8s_audit)
-* [Kubernetes Event Logs](./features.md#k8s_event)
-* [Kubernetes Node Logs](./features.md#k8s_node)
-* [Kubernetes container logs](./features.md#k8s_container)
-* [MultiCloud API logs](./features.md#multicloud_api)
-* [Kubernetes Control plane component logs](./features.md#k8s_control_plane_component)
+* [Kubernetes Audit Log](./features.md#kubernetes-audit-log)
+* [Kubernetes Event Logs](./features.md#kubernetes-event-logs)
+* [Kubernetes Node Logs](./features.md#kubernetes-node-logs)
+* [Kubernetes container logs](./features.md#kubernetes-container-logs)
+* [MultiCloud API logs](./features.md#multicloud-api-logs)
+* [Kubernetes Control plane component logs](./features.md#kubernetes-control-plane-component-logs)
 <!-- END GENERATED PART: inspection-type-element-header-features-gcp-gke-on-aws -->
 <!-- BEGIN GENERATED PART: inspection-type-element-header-gcp-gke-on-azure -->
 ## [GKE on Azure(Anthos on Azure)](#gcp-gke-on-azure)
@@ -70,12 +70,12 @@ KHI filters out unsupported parser for the selected inspection type at first.
 <!-- END GENERATED PART: inspection-type-element-header-gcp-gke-on-azure -->
 <!-- BEGIN GENERATED PART: inspection-type-element-header-features-gcp-gke-on-azure -->
 
-* [Kubernetes Audit Log](./features.md#k8s_audit)
-* [Kubernetes Event Logs](./features.md#k8s_event)
-* [Kubernetes Node Logs](./features.md#k8s_node)
-* [Kubernetes container logs](./features.md#k8s_container)
-* [MultiCloud API logs](./features.md#multicloud_api)
-* [Kubernetes Control plane component logs](./features.md#k8s_control_plane_component)
+* [Kubernetes Audit Log](./features.md#kubernetes-audit-log)
+* [Kubernetes Event Logs](./features.md#kubernetes-event-logs)
+* [Kubernetes Node Logs](./features.md#kubernetes-node-logs)
+* [Kubernetes container logs](./features.md#kubernetes-container-logs)
+* [MultiCloud API logs](./features.md#multicloud-api-logs)
+* [Kubernetes Control plane component logs](./features.md#kubernetes-control-plane-component-logs)
 <!-- END GENERATED PART: inspection-type-element-header-features-gcp-gke-on-azure -->
 <!-- BEGIN GENERATED PART: inspection-type-element-header-gcp-gdcv-for-baremetal -->
 ## [GDCV for Baremetal(GKE on Baremetal, Anthos on Baremetal)](#gcp-gdcv-for-baremetal)
@@ -85,12 +85,12 @@ KHI filters out unsupported parser for the selected inspection type at first.
 <!-- END GENERATED PART: inspection-type-element-header-gcp-gdcv-for-baremetal -->
 <!-- BEGIN GENERATED PART: inspection-type-element-header-features-gcp-gdcv-for-baremetal -->
 
-* [Kubernetes Audit Log](./features.md#k8s_audit)
-* [Kubernetes Event Logs](./features.md#k8s_event)
-* [Kubernetes Node Logs](./features.md#k8s_node)
-* [Kubernetes container logs](./features.md#k8s_container)
-* [OnPrem API logs](./features.md#onprem_api)
-* [Kubernetes Control plane component logs](./features.md#k8s_control_plane_component)
+* [Kubernetes Audit Log](./features.md#kubernetes-audit-log)
+* [Kubernetes Event Logs](./features.md#kubernetes-event-logs)
+* [Kubernetes Node Logs](./features.md#kubernetes-node-logs)
+* [Kubernetes container logs](./features.md#kubernetes-container-logs)
+* [OnPrem API logs](./features.md#onprem-api-logs)
+* [Kubernetes Control plane component logs](./features.md#kubernetes-control-plane-component-logs)
 <!-- END GENERATED PART: inspection-type-element-header-features-gcp-gdcv-for-baremetal -->
 <!-- BEGIN GENERATED PART: inspection-type-element-header-gcp-gdcv-for-vmware -->
 ## [GDCV for VMWare(GKE on VMWare, Anthos on VMWare)](#gcp-gdcv-for-vmware)
@@ -100,10 +100,10 @@ KHI filters out unsupported parser for the selected inspection type at first.
 <!-- END GENERATED PART: inspection-type-element-header-gcp-gdcv-for-vmware -->
 <!-- BEGIN GENERATED PART: inspection-type-element-header-features-gcp-gdcv-for-vmware -->
 
-* [Kubernetes Audit Log](./features.md#k8s_audit)
-* [Kubernetes Event Logs](./features.md#k8s_event)
-* [Kubernetes Node Logs](./features.md#k8s_node)
-* [Kubernetes container logs](./features.md#k8s_container)
-* [OnPrem API logs](./features.md#onprem_api)
-* [Kubernetes Control plane component logs](./features.md#k8s_control_plane_component)
+* [Kubernetes Audit Log](./features.md#kubernetes-audit-log)
+* [Kubernetes Event Logs](./features.md#kubernetes-event-logs)
+* [Kubernetes Node Logs](./features.md#kubernetes-node-logs)
+* [Kubernetes container logs](./features.md#kubernetes-container-logs)
+* [OnPrem API logs](./features.md#onprem-api-logs)
+* [Kubernetes Control plane component logs](./features.md#kubernetes-control-plane-component-logs)
 <!-- END GENERATED PART: inspection-type-element-header-features-gcp-gdcv-for-vmware -->
diff --git a/docs/en/relationships.md b/docs/en/relationships.md
@@ -4,7 +4,7 @@ KHI timelines are basically placed in the order of `Kind` -> `Namespace` -> `Res
 The relationship between its parent and children is usually interpretted as the order of its hierarchy, but some subresources are not actual kubernetes resources and it's associated with the parent timeline for convenience. Each timeline color meanings and type of logs put on them are different by this relationship.
 
 <!-- BEGIN GENERATED PART: relationship-element-header-RelationshipChild -->
-## [The default resource timeline](#RelationshipChild)
+## ![#CCCCCC](https://placehold.co/15x15/CCCCCC/CCCCCC.png)The default resource timeline
 <!-- END GENERATED PART: relationship-element-header-RelationshipChild -->
 
 ![](./images/reference/default-timeline.png)
@@ -41,7 +41,7 @@ This timeline can have the following events.
 
 <!-- END GENERATED PART: relationship-element-header-RelationshipChild-events-table -->
 <!-- BEGIN GENERATED PART: relationship-element-header-RelationshipResourceCondition -->
-## [![#4c29e8](https://placehold.co/15x15/4c29e8/4c29e8.png) condition - Status condition field timeline](#RelationshipResourceCondition)
+## ![#4c29e8](https://placehold.co/15x15/4c29e8/4c29e8.png)Status condition field timeline
 <!-- END GENERATED PART: relationship-element-header-RelationshipResourceCondition -->
 <!-- BEGIN GENERATED PART: relationship-element-header-RelationshipResourceCondition-revisions-header -->
 ### Revisions
@@ -57,7 +57,7 @@ This timeline can have the following revisions.
 
 <!-- END GENERATED PART: relationship-element-header-RelationshipResourceCondition-revisions-table -->
 <!-- BEGIN GENERATED PART: relationship-element-header-RelationshipOperation -->
-## [![#000000](https://placehold.co/15x15/000000/000000.png) operation - Operation timeline](#RelationshipOperation)
+## ![#000000](https://placehold.co/15x15/000000/000000.png)Operation timeline
 <!-- END GENERATED PART: relationship-element-header-RelationshipOperation -->
 <!-- BEGIN GENERATED PART: relationship-element-header-RelationshipOperation-revisions-header -->
 ### Revisions
@@ -80,7 +80,7 @@ This timeline can have the following revisions.
 
 <!-- END GENERATED PART: relationship-element-header-RelationshipOperation-revisions-table -->
 <!-- BEGIN GENERATED PART: relationship-element-header-RelationshipEndpointSlice -->
-## [![#008000](https://placehold.co/15x15/008000/008000.png) endpointslice - Endpoint serving state timeline](#RelationshipEndpointSlice)
+## ![#008000](https://placehold.co/15x15/008000/008000.png)Endpoint serving state timeline
 <!-- END GENERATED PART: relationship-element-header-RelationshipEndpointSlice -->
 <!-- BEGIN GENERATED PART: relationship-element-header-RelationshipEndpointSlice-revisions-header -->
 ### Revisions
@@ -96,7 +96,7 @@ This timeline can have the following revisions.
 
 <!-- END GENERATED PART: relationship-element-header-RelationshipEndpointSlice-revisions-table -->
 <!-- BEGIN GENERATED PART: relationship-element-header-RelationshipContainer -->
-## [![#fe9bab](https://placehold.co/15x15/fe9bab/fe9bab.png) container - Container timeline](#RelationshipContainer)
+## ![#fe9bab](https://placehold.co/15x15/fe9bab/fe9bab.png)Container timeline
 <!-- END GENERATED PART: relationship-element-header-RelationshipContainer -->
 <!-- BEGIN GENERATED PART: relationship-element-header-RelationshipContainer-revisions-header -->
 ### Revisions
@@ -131,7 +131,7 @@ This timeline can have the following events.
 
 <!-- END GENERATED PART: relationship-element-header-RelationshipContainer-events-table -->
 <!-- BEGIN GENERATED PART: relationship-element-header-RelationshipNodeComponent -->
-## [![#0077CC](https://placehold.co/15x15/0077CC/0077CC.png) node-component - Node component timeline](#RelationshipNodeComponent)
+## ![#0077CC](https://placehold.co/15x15/0077CC/0077CC.png)Node component timeline
 <!-- END GENERATED PART: relationship-element-header-RelationshipNodeComponent -->
 <!-- BEGIN GENERATED PART: relationship-element-header-RelationshipNodeComponent-revisions-header -->
 ### Revisions
@@ -158,7 +158,7 @@ This timeline can have the following events.
 
 <!-- END GENERATED PART: relationship-element-header-RelationshipNodeComponent-events-table -->
 <!-- BEGIN GENERATED PART: relationship-element-header-RelationshipOwnerReference -->
-## [![#33DD88](https://placehold.co/15x15/33DD88/33DD88.png) owns - Owning children timeline](#RelationshipOwnerReference)
+## ![#33DD88](https://placehold.co/15x15/33DD88/33DD88.png)Owning children timeline
 <!-- END GENERATED PART: relationship-element-header-RelationshipOwnerReference -->
 <!-- BEGIN GENERATED PART: relationship-element-header-RelationshipOwnerReference-aliases-header -->
 ### Aliases
@@ -172,7 +172,7 @@ This timeline can have the following aliases.
 
 <!-- END GENERATED PART: relationship-element-header-RelationshipOwnerReference-aliases-table -->
 <!-- BEGIN GENERATED PART: relationship-element-header-RelationshipPodBinding -->
-## [![#FF8855](https://placehold.co/15x15/FF8855/FF8855.png) binds - Pod binding timeline](#RelationshipPodBinding)
+## ![#FF8855](https://placehold.co/15x15/FF8855/FF8855.png)Pod binding timeline
 <!-- END GENERATED PART: relationship-element-header-RelationshipPodBinding -->
 <!-- BEGIN GENERATED PART: relationship-element-header-RelationshipPodBinding-aliases-header -->
 ### Aliases
@@ -186,7 +186,7 @@ This timeline can have the following aliases.
 
 <!-- END GENERATED PART: relationship-element-header-RelationshipPodBinding-aliases-table -->
 <!-- BEGIN GENERATED PART: relationship-element-header-RelationshipNetworkEndpointGroup -->
-## [![#A52A2A](https://placehold.co/15x15/A52A2A/A52A2A.png) neg - Network Endpoint Group timeline](#RelationshipNetworkEndpointGroup)
+## ![#A52A2A](https://placehold.co/15x15/A52A2A/A52A2A.png)Network Endpoint Group timeline
 <!-- END GENERATED PART: relationship-element-header-RelationshipNetworkEndpointGroup -->
 <!-- BEGIN GENERATED PART: relationship-element-header-RelationshipNetworkEndpointGroup-revisions-header -->
 ### Revisions
@@ -201,7 +201,7 @@ This timeline can have the following revisions.
 
 <!-- END GENERATED PART: relationship-element-header-RelationshipNetworkEndpointGroup-revisions-table -->
 <!-- BEGIN GENERATED PART: relationship-element-header-RelationshipManagedInstanceGroup -->
-## [![#FF5555](https://placehold.co/15x15/FF5555/FF5555.png) mig - Managed instance group timeline](#RelationshipManagedInstanceGroup)
+## ![#FF5555](https://placehold.co/15x15/FF5555/FF5555.png)Managed instance group timeline
 <!-- END GENERATED PART: relationship-element-header-RelationshipManagedInstanceGroup -->
 <!-- BEGIN GENERATED PART: relationship-element-header-RelationshipManagedInstanceGroup-events-header -->
 ### Events
@@ -215,7 +215,7 @@ This timeline can have the following events.
 
 <!-- END GENERATED PART: relationship-element-header-RelationshipManagedInstanceGroup-events-table -->
 <!-- BEGIN GENERATED PART: relationship-element-header-RelationshipControlPlaneComponent -->
-## [![#FF5555](https://placehold.co/15x15/FF5555/FF5555.png) controlplane - Control plane component timeline](#RelationshipControlPlaneComponent)
+## ![#FF5555](https://placehold.co/15x15/FF5555/FF5555.png)Control plane component timeline
 <!-- END GENERATED PART: relationship-element-header-RelationshipControlPlaneComponent -->
 <!-- BEGIN GENERATED PART: relationship-element-header-RelationshipControlPlaneComponent-events-header -->
 ### Events
@@ -229,7 +229,7 @@ This timeline can have the following events.
 
 <!-- END GENERATED PART: relationship-element-header-RelationshipControlPlaneComponent-events-table -->
 <!-- BEGIN GENERATED PART: relationship-element-header-RelationshipSerialPort -->
-## [![#333333](https://placehold.co/15x15/333333/333333.png) serialport - Serialport log timeline](#RelationshipSerialPort)
+## ![#333333](https://placehold.co/15x15/333333/333333.png)Serialport log timeline
 <!-- END GENERATED PART: relationship-element-header-RelationshipSerialPort -->
 <!-- BEGIN GENERATED PART: relationship-element-header-RelationshipSerialPort-events-header -->
 ### Events

diff --git a/docs/template/feature.template.md b/docs/template/feature.template.md
@@ -1,7 +1,7 @@
 {{define "feature-template"}}
 {{range $index,$feature := .Features }}
 <!-- BEGIN GENERATED PART: feature-element-header-{{$feature.ID}} -->
-## [{{$feature.Name}}](#{{$feature.ID}})
+## {{$feature.Name}}
 
 {{$feature.Description}}
 
@@ -13,7 +13,7 @@
 |Parameter name|Description|
 |:-:|---|
 {{- range $index,$form := $feature.Forms}}
-|[{{$form.Label}}](./forms.md#{{$form.ID}})|{{$form.Description}}|
+|[{{$form.Label}}](./forms.md#{{$form.Label | anchor}})|{{$form.Description}}|
 {{- end}}
 <!-- END GENERATED PART: feature-element-depending-form-header-{{$feature.ID}} -->
 {{end}}
@@ -24,7 +24,7 @@
 |Timeline type|Short name on chip|
 |:-:|:-:|
 {{- range $index,$timeline := $feature.OutputTimelines}}
-|![{{$timeline.RelationshipColorCode}}](https://placehold.co/15x15/{{$timeline.RelationshipColorCode}}/{{$timeline.RelationshipColorCode}}.png)[{{$timeline.LongName}}](./relationships.md#{{$timeline.RelationshipID}})|{{$timeline.Name}}|
+|![{{$timeline.RelationshipColorCode}}](https://placehold.co/15x15/{{$timeline.RelationshipColorCode}}/{{$timeline.RelationshipColorCode}}.png)[{{$timeline.LongName}}](./relationships.md#{{$timeline.LongName | anchor}})|{{$timeline.Name}}|
 {{- end}}
 
 <!-- END GENERATED PART: feature-element-output-timelines-{{$feature.ID}} -->

diff --git a/docs/template/inspection-type.template.md b/docs/template/inspection-type.template.md
@@ -9,7 +9,7 @@
 
 <!-- BEGIN GENERATED PART: inspection-type-element-header-features-{{$type.ID}} -->
 {{range $feature := $type.SupportedFeatures}}
-* [{{$feature.Name}}](./features.md#{{$feature.ID}})
+* [{{$feature.Name}}](./features.md#{{$feature.Name | anchor }})
 {{- end}}
 <!-- END GENERATED PART: inspection-type-element-header-features-{{$type.ID}} -->
 {{end}}

diff --git a/docs/template/relationship.template.md b/docs/template/relationship.template.md
@@ -1,7 +1,7 @@
 {{define "relationship-template"}}
 {{range $index,$relationship := .Relationships }}
 <!-- BEGIN GENERATED PART: relationship-element-header-{{$relationship.ID}} -->
-## [{{with $relationship.HasVisibleChip}}![#{{$relationship.ColorCode}}](https://placehold.co/15x15/{{$relationship.ColorCode}}/{{$relationship.ColorCode}}.png) {{$relationship.Label}} - {{end}}{{$relationship.LongName}}](#{{$relationship.ID}})
+## ![#{{$relationship.ColorCode}}](https://placehold.co/15x15/{{$relationship.ColorCode}}/{{$relationship.ColorCode}}.png){{$relationship.LongName}}
 <!-- END GENERATED PART: relationship-element-header-{{$relationship.ID}} -->
 {{with $relationship.GeneratableRevisions}}
 <!-- BEGIN GENERATED PART: relationship-element-header-{{$relationship.ID}}-revisions-header -->