Merge pull request #2531 from chuckha/links

🏃Fix all 404s in book and add a verify script to ensure there are no 404s

Author: k8s-ci-robot

Makefile

@@ -46,6 +46,8 @@ E2E_FRAMEWORK_DIR := test/framework
 CAPD_DIR := test/infrastructure/docker
 RELEASE_NOTES_BIN := bin/release-notes
 RELEASE_NOTES := $(TOOLS_DIR)/$(RELEASE_NOTES_BIN)
+LINK_CHECKER_BIN := bin/liche
+LINK_CHECKER := $(TOOLS_DIR)/$(LINK_CHECKER_BIN)
 
 # Binaries.
 # Need to use abspath so we can invoke these from subdirectories
@@ -170,6 +172,9 @@ $(GOBINDATA): $(TOOLS_DIR)/go.mod # Build go-bindata from tools folder.
 $(RELEASE_NOTES): $(TOOLS_DIR)/go.mod
 	cd $(TOOLS_DIR) && go build -tags=tools -o $(RELEASE_NOTES_BIN) ./release
 
+$(LINK_CHECKER): $(TOOLS_DIR)/go.mod
+	cd $(TOOLS_DIR) && go build -tags=tools -o $(LINK_CHECKER_BIN) github.com/raviqqe/liche
+
 .PHONY: e2e-framework
 e2e-framework: ## Builds the CAPI e2e framework
 	cd $(E2E_FRAMEWORK_DIR); go build ./...
@@ -521,6 +526,7 @@ verify:
 	./hack/verify-doctoc.sh
 	./hack/verify-shellcheck.sh
 	./hack/verify-starlark.sh
+	$(MAKE) verify-book-links
 	$(MAKE) verify-modules
 	$(MAKE) verify-gen
 	$(MAKE) verify-docker-provider
@@ -544,6 +550,10 @@ verify-docker-provider:
 	@echo "Verifying CAPD"
 	cd $(CAPD_DIR); $(MAKE) verify
 
+.PHONY: verify-book-links
+verify-book-links: $(LINK_CHECKER)
+	 # Ignore localhost links and set concurrency to a reasonable number
+	$(LINK_CHECKER) -r docs/book -x "^https?://localhost($|[:/].*)" -c 10
 ## --------------------------------------
 ## Others / Utilities
 ## --------------------------------------

README.md

@@ -36,7 +36,7 @@ API design. Because of this, all of the codebase is rapidly changing.
     - Weekly on Wednesdays @ 10:00 PT on [Zoom][zoomMeeting]
     - Previous meetings: \[ [notes][notes] | [recordings][recordings] \]
 - Provider implementers office hours where you can ask questions related to developing providers for Cluster API
-    - Weekly on Tuesdays @ 12:00 PT ([Zoom](providerZoomMeetingTues)) and Wednesdays @ 15:00 CET ([Zoom](providerZoomMeetingWed))
+    - Weekly on Tuesdays @ 12:00 PT ([Zoom][providerZoomMeetingTues]) and Wednesdays @ 15:00 CET ([Zoom][providerZoomMeetingWed])
     - Previous meetings: \[ [notes][implementerNotes] \]
 
 Pull Requests and feedback on issues are very welcome!

docs/book/src/SUMMARY.md

@@ -23,6 +23,7 @@
 - [Developer Guide](./developer/guide.md)
     - [Repository Layout](./developer/repository-layout.md)
     - [Rapid iterative development with Tilt](./developer/tilt.md)
+    - [Testing](./developer/testing.md)
     - [Controllers](./developer/architecture/controllers.md)
         - [Bootstrap](./developer/architecture/controllers/bootstrap.md)
         - [Cluster](./developer/architecture/controllers/cluster.md)

docs/book/src/developer/architecture/controllers/cluster.md

@@ -7,7 +7,7 @@ The Cluster controller's main responsibilities are:
 * Setting an OwnerReference on the infrastructure object referenced in `Cluster.Spec.InfrastructureRef`.
 * Cleanup of all owned objects so that nothing is dangling after deletion.
 * Keeping the Cluster's status in sync with the infrastructure Cluster's status.
-* Creating a kubeconfig secret for [workload clusters](../../reference/glossary.html#workload-cluster).
+* Creating a kubeconfig secret for [workload clusters](../../../reference/glossary.md#workload-cluster).
 
 ## Contracts
 

docs/book/src/developer/architecture/controllers/machine-deployment.md

@@ -1,6 +1,6 @@
 # MachineDeployment
 
-A MachineDeployment orchestrates deployments over a fleet of [MachineSets](./machine-set.yaml).
+A MachineDeployment orchestrates deployments over a fleet of [MachineSets](./machine-set.md).
 
 Its main responsibilities are:
 * Adopting matching MachineSets not assigned to a MachineDeployment

docs/book/src/developer/architecture/controllers/machine-set.md

@@ -1,6 +1,6 @@
 # MachineSet
 
-A MachineSet is an immutable abstraction over [Machines](./machine.html).
+A MachineSet is an immutable abstraction over [Machines](./machine.md).
 
 Its main responsibilities are:
 * Adopting unowned Machines that aren't assigned to a MachineSet

docs/book/src/developer/guide.md

@@ -181,7 +181,7 @@ capi-controller-manager-bf9c6468c-d6msj   1/1     Running   0          2m9s
 Cluster API has a number of test suites available for you to run. Please visit the [testing][testing] page for more
 information on each suite.
 
-[testing]: ./tests.md
+[testing]: ./testing.md
 
 ## That's it!
 

docs/book/src/developer/tests.md renamed to docs/book/src/developer/testing.md

@@ -1346,5 +1346,5 @@ spec:
 {{#/tabs }}
 
 <!-- links -->
-[control-plane-controller]: ../architecture/controllers/control-plane.md
+[control-plane-controller]: ../developer/architecture/controllers/control-plane.md
 [workload cluster]: ../reference/glossary.md#workload-cluster

docs/book/src/user/quick-start.md

@@ -6,6 +6,7 @@ require (
 	github.com/blang/semver v3.5.1+incompatible
 	github.com/go-bindata/go-bindata v3.1.2+incompatible
 	github.com/golangci/golangci-lint v1.23.3
+	github.com/raviqqe/liche v0.0.0-20200229003944-f57a5d1c5be4
 	golang.org/x/tools v0.0.0-20200102140908-9497f49d5709
 	k8s.io/code-generator v0.18.0-alpha.2.0.20200130061103-7dfd5e9157ef
 	sigs.k8s.io/controller-tools v0.2.6-0.20200226180227-d6efdcdd90e2