Merge pull request #6801 from oscr/find-missing-summary

📖 Add script to find files missing in SUMMARY.md

Author: k8s-ci-robot

Makefile

@@ -454,7 +454,7 @@ APIDIFF_OLD_COMMIT ?= $(shell git rev-parse origin/main)
 apidiff: $(GO_APIDIFF) ## Check for API differences
 	$(GO_APIDIFF) $(APIDIFF_OLD_COMMIT) --print-compatible
 
-ALL_VERIFY_CHECKS = doctoc boilerplate shellcheck tiltfile modules gen conversions
+ALL_VERIFY_CHECKS = doctoc boilerplate shellcheck tiltfile modules gen conversions capi-book-summary
 
 .PHONY: verify
 verify: $(addprefix verify-,$(ALL_VERIFY_CHECKS)) ## Run all verify-* targets
@@ -485,6 +485,10 @@ verify-conversions: $(CONVERSION_VERIFIER)  ## Verifies expected API conversion
 verify-doctoc:
 	./hack/verify-doctoc.sh
 
+.PHONY: verify-capi-book-summary
+verify-capi-book-summary:
+	./hack/verify-capi-book-summary.sh
+
 .PHONY: verify-boilerplate
 verify-boilerplate: ## Verify boilerplate text exists in each file
 	./hack/verify-boilerplate.sh

docs/book/src/SUMMARY.md

@@ -10,6 +10,8 @@
         - [Generating a Kubeconfig](./tasks/certs/generate-kubeconfig.md)
     - [Kubeadm based bootstrap](./tasks/kubeadm-bootstrap.md)
     - [Upgrading management and workload clusters](./tasks/upgrading-clusters.md)
+    - [External etcd](./tasks/external-etcd.md)
+    - [Using kustomize](./tasks/using-kustomize.md)
     - [Upgrading Cluster API components](./tasks/upgrading-cluster-api-versions.md)
     - [Kubeadm based control plane management](./tasks/kubeadm-control-plane.md)
     - [Updating Machine Infrastructure and Bootstrap Templates](tasks/updating-machine-templates.md)
@@ -78,6 +80,7 @@
           - [Bootstrap](./developer/providers/bootstrap.md)
         - [Implementer's Guide](./developer/providers/implementers-guide/overview.md)
           - [Naming](./developer/providers/implementers-guide/naming.md)
+          - [Configure](./developer/providers/implementers-guide/configure.md)
           - [Create Repo and Generate CRDs](./developer/providers/implementers-guide/generate_crds.md)
           - [Create API](./developer/providers/implementers-guide/create_api.md)
           - [Webhooks](./developer/providers/webhooks.md)

docs/book/src/user/guide.md

@@ -0,0 +1,34 @@
+#!/bin/bash
+
+# Copyright 2022 The Kubernetes Authors.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+set -o errexit
+set -o nounset
+set -o pipefail
+
+RESULT=0
+SUMMARY=$(cat ./docs/book/src/SUMMARY.md)
+
+pushd ./docs/book/src > /dev/null
+FILES=$(find -- * -name "*.md" ! -name "SUMMARY.md")
+while read -r file; do
+  if ! [[ $SUMMARY == *"${file}"* ]]; then
+    RESULT=1
+    echo "Didn't find $file in SUMMARY.md"
+  fi
+done <<< "${FILES}"
+popd > /dev/null
+
+exit ${RESULT}