Merge pull request #1316 from tallclair/toc

Allow case-insensitive TOC tags
kubernetes · Oct 19, 2019 · 34cb5ee · 34cb5ee
2 parents 239b0c8 + 7dcb49b
commit 34cb5ee
Show file tree

Hide file tree

Showing 4 changed files with 53 additions and 61 deletions.
diff --git a/hack/update-toc.sh b/hack/update-toc.sh
@@ -19,7 +19,7 @@ set -o nounset
 set -o pipefail
 
 # keep in sync with hack/verify-toc.sh
-TOOL_VERSION=4dc3d6f908138504b02a1766f1f8ea282d6bdd7c
+TOOL_VERSION=ee652eb78c047a7b6c7417d9324a97bb05689563
 
 # cd to the root path
 ROOT="$(cd "$(dirname "${BASH_SOURCE[0]}")/.." && pwd -P)"
@@ -43,4 +43,4 @@ export PATH="${TMP_DIR}:${PATH}"
 cd "${ROOT}"
 
 # Update tables of contents if necessary.
-grep --include='*.md' -rl keps -e '<!-- toc -->' | xargs mdtoc --inplace
+grep --include='*.md' -rli keps -e '<!-- toc -->' | xargs mdtoc --inplace
diff --git a/hack/verify-toc.sh b/hack/verify-toc.sh
@@ -18,8 +18,8 @@ set -o errexit
 set -o nounset
 set -o pipefail
 
-# keep in sync with hack/verify-toc.sh
-TOOL_VERSION=4dc3d6f908138504b02a1766f1f8ea282d6bdd7c
+# keep in sync with hack/update-toc.sh
+TOOL_VERSION=ee652eb78c047a7b6c7417d9324a97bb05689563
 
 # cd to the root path
 ROOT="$(cd "$(dirname "${BASH_SOURCE[0]}")/.." && pwd -P)"
@@ -44,4 +44,4 @@ cd "${ROOT}"
 
 echo "Checking table of contents are up to date..."
 # Verify tables of contents are up-to-date
-grep --include='*.md' -rl keps -e '<!-- toc -->' | xargs mdtoc --inplace --dryrun
+grep --include='*.md' -rli keps -e '<!-- toc -->' | xargs mdtoc --inplace --dryrun
diff --git a/keps/sig-cloud-provider/azure/20180809-cross-resource-group-nodes.md b/keps/sig-cloud-provider/azure/20180809-cross-resource-group-nodes.md
@@ -21,21 +21,17 @@ status: implementable
 ## Table of Contents
 
 <!-- TOC -->
-
-- [Cross resource group nodes](#cross-resource-group-nodes)
-    - [Table of Contents](#table-of-contents)
-    - [Summary](#summary)
-    - [Motivation](#motivation)
-        - [Assumptions](#assumptions)
-        - [Non-Goals](#non-goals)
-    - [Design](#design)
-    - [Implementation](#implementation)
-        - [Cross-RG nodes](#cross-rg-nodes)
-        - [On-prem nodes](#on-prem-nodes)
-    - [Graduation Criteria](#graduation-criteria)
-    - [Implementation History](#implementation-history)
-    - [Alternatives](#alternatives)
-
+- [Summary](#summary)
+- [Motivation](#motivation)
+  - [Assumptions](#assumptions)
+  - [Non-Goals](#non-goals)
+- [Design](#design)
+- [Implementation](#implementation)
+  - [Cross-RG nodes](#cross-rg-nodes)
+  - [On-prem nodes](#on-prem-nodes)
+- [Graduation Criteria](#graduation-criteria)
+- [Implementation History](#implementation-history)
+- [Alternatives](#alternatives)
 <!-- /TOC -->
 
 ## Summary

diff --git a/keps/sig-windows/20190424-windows-cri-containerd.md b/keps/sig-windows/20190424-windows-cri-containerd.md
@@ -22,47 +22,43 @@ status: implementable
 ## Table of Contents
 
 <!-- TOC -->
-
-- [Supporting CRI-ContainerD on Windows](#supporting-cri-containerd-on-windows)
-    - [Table of Contents](#table-of-contents)
-    - [Release Signoff Checklist](#release-signoff-checklist)
-    - [Summary](#summary)
-    - [Motivation](#motivation)
-        - [Goals](#goals)
-        - [Non-Goals](#non-goals)
-    - [Proposal](#proposal)
-        - [User Stories](#user-stories)
-            - [Improving Kubernetes integration for Windows Server containers](#improving-kubernetes-integration-for-windows-server-containers)
-            - [Improved isolation and compatibility between Windows pods using Hyper-V](#improved-isolation-and-compatibility-between-windows-pods-using-hyper-v)
-            - [Improve Control over Memory & CPU Resources with Hyper-V](#improve-control-over-memory--cpu-resources-with-hyper-v)
-            - [Improved Storage Control with Hyper-V](#improved-storage-control-with-hyper-v)
-            - [Enable runtime resizing of container resources](#enable-runtime-resizing-of-container-resources)
-        - [Implementation Details/Notes/Constraints](#implementation-detailsnotesconstraints)
-            - [Proposal: Use Runtimeclass Scheduler to simplify deployments based on OS version requirements](#proposal-use-runtimeclass-scheduler-to-simplify-deployments-based-on-os-version-requirements)
-            - [Proposal: Standardize hypervisor annotations](#proposal-standardize-hypervisor-annotations)
-        - [Dependencies](#dependencies)
-                - [Windows Server 2019](#windows-server-2019)
-                - [CRI-ContainerD](#cri-containerd)
-                - [CNI: Flannel](#cni-flannel)
-                - [CNI: Kubenet](#cni-kubenet)
-                - [CNI: GCE](#cni-gce)
-                - [Storage: in-tree AzureFile, AzureDisk, Google PD](#storage-in-tree-azurefile-azuredisk-google-pd)
-                - [Storage: FlexVolume for iSCSI & SMB](#storage-flexvolume-for-iscsi--smb)
-        - [Risks and Mitigations](#risks-and-mitigations)
-            - [CRI-ContainerD availability](#cri-containerd-availability)
-    - [Design Details](#design-details)
-        - [Test Plan](#test-plan)
-        - [Graduation Criteria](#graduation-criteria)
-        - [Alpha release (proposed 1.17)](#alpha-release-proposed-117)
-        - [Alpha -> Beta Graduation](#alpha---beta-graduation)
-                - [Beta -> GA Graduation](#beta---ga-graduation)
-        - [Upgrade / Downgrade Strategy](#upgrade--downgrade-strategy)
-        - [Version Skew Strategy](#version-skew-strategy)
-    - [Implementation History](#implementation-history)
-    - [Alternatives](#alternatives)
-        - [CRI-O](#cri-o)
-    - [Infrastructure Needed](#infrastructure-needed)
-
+- [Release Signoff Checklist](#release-signoff-checklist)
+- [Summary](#summary)
+- [Motivation](#motivation)
+  - [Goals](#goals)
+  - [Non-Goals](#non-goals)
+- [Proposal](#proposal)
+  - [User Stories](#user-stories)
+    - [Improving Kubernetes integration for Windows Server containers](#improving-kubernetes-integration-for-windows-server-containers)
+    - [Improved isolation and compatibility between Windows pods using Hyper-V](#improved-isolation-and-compatibility-between-windows-pods-using-hyper-v)
+    - [Improve Control over Memory &amp; CPU Resources with Hyper-V](#improve-control-over-memory--cpu-resources-with-hyper-v)
+    - [Improved Storage Control with Hyper-V](#improved-storage-control-with-hyper-v)
+    - [Enable runtime resizing of container resources](#enable-runtime-resizing-of-container-resources)
+  - [Implementation Details/Notes/Constraints](#implementation-detailsnotesconstraints)
+    - [Proposal: Use Runtimeclass Scheduler to simplify deployments based on OS version requirements](#proposal-use-runtimeclass-scheduler-to-simplify-deployments-based-on-os-version-requirements)
+    - [Proposal: Standardize hypervisor annotations](#proposal-standardize-hypervisor-annotations)
+  - [Dependencies](#dependencies)
+      - [Windows Server 2019](#windows-server-2019)
+      - [CRI-ContainerD](#cri-containerd)
+      - [CNI: Flannel](#cni-flannel)
+      - [CNI: Kubenet](#cni-kubenet)
+      - [CNI: GCE](#cni-gce)
+      - [Storage: in-tree AzureFile, AzureDisk, Google PD](#storage-in-tree-azurefile-azuredisk-google-pd)
+      - [Storage: FlexVolume for iSCSI &amp; SMB](#storage-flexvolume-for-iscsi--smb)
+  - [Risks and Mitigations](#risks-and-mitigations)
+    - [CRI-ContainerD availability](#cri-containerd-availability)
+- [Design Details](#design-details)
+  - [Test Plan](#test-plan)
+  - [Graduation Criteria](#graduation-criteria)
+  - [Alpha release (proposed 1.17)](#alpha-release-proposed-117)
+  - [Alpha -&gt; Beta Graduation](#alpha---beta-graduation)
+      - [Beta -&gt; GA Graduation](#beta---ga-graduation)
+  - [Upgrade / Downgrade Strategy](#upgrade--downgrade-strategy)
+  - [Version Skew Strategy](#version-skew-strategy)
+- [Implementation History](#implementation-history)
+- [Alternatives](#alternatives)
+  - [CRI-O](#cri-o)
+- [Infrastructure Needed](#infrastructure-needed)
 <!-- /TOC -->
 
 ## Release Signoff Checklist