Merge pull request #1453 from alexeldeib/ace/deadlink

fix: dead links; add ci link check for docs

Author: k8s-ci-robot

.github/workflows/lint-docs.yaml

@@ -0,0 +1,21 @@
+name: Lint Documentation
+on:
+  push:
+    paths:
+      - "docs/**"
+    branches:
+      - main
+  pull_request:
+    paths: "docs/**"
+jobs:
+  lint_docs:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: actions/setup-node@v2
+        with:
+          node-version: "14"
+      - name: Install markdown-link-check
+        run: npm install -g markdown-link-check
+      - name: markdown-link-check
+        run: find . -name \*.md | xargs -I{} markdown-link-check -c .markdownlinkcheck.json {}

.markdownlinkcheck.json

@@ -0,0 +1,10 @@
+{
+    "ignorePatterns": [{
+        "pattern": "^https://calendar.google.com/calendar"
+    }],
+    "timeout": "5s",
+    "retryOn429": true,
+    "retryCount": 5,
+    "fallbackRetryDelay": "30s",
+    "aliveStatusCodes": [200, 206]
+}

README.md

@@ -130,7 +130,7 @@ We also use the issue tracker to track features. If you have an idea for a featu
 [prow]: https://go.k8s.io/bot-commands
 [bug_report]: https://github.com/kubernetes-sigs/cluster-api-provider-azure/issues/new?template=bug_report.md
 [feature_request]: https://github.com/kubernetes-sigs/cluster-api-provider-azure/issues/new?template=feature_request.md
-[slack_info]: https://github.com/kubernetes/community/blob/master/communication.md#social-media
+[slack_info]: https://github.com/kubernetes/community/tree/master/communication#slack
 [cluster_api]: https://github.com/kubernetes-sigs/cluster-api
 [quickstart]: https://cluster-api.sigs.k8s.io/user/quick-start.html
 [flavors_doc]: https://github.com/kubernetes-sigs/cluster-api-provider-azure/blob/master/templates/flavors/README.md

docs/book/src/developers/development.md

@@ -163,7 +163,7 @@ If you want to develop in both CAPI and CAPZ at the same time, then this is the
 
 To use [Tilt](https://tilt.dev/) for a simplified development workflow, follow the [instructions](https://cluster-api.sigs.k8s.io/developer/tilt.html) in the cluster-api repo.  The instructions will walk you through cloning the Cluster API (CAPI) repository and configuring Tilt to use `kind` to deploy the cluster api management components.
 
-> you may wish to checkout out the correct version of CAPI to match the [version used in CAPZ](go.mod)
+> you may wish to checkout out the correct version of CAPI to match the [version used in CAPZ][go.mod]
 
 Note that `tilt up` will be run from the `cluster-api repository` directory and the `tilt-settings.json` file will point back to the `cluster-api-provider-azure` repository directory.  Any changes you make to the source code in `cluster-api` or `cluster-api-provider-azure` repositories will automatically redeployed to the `kind` cluster.
 
@@ -460,7 +460,7 @@ You can optionally set the following variables:
 | `USE_CI_ARTIFACTS`          | Use a CI version of Kubernetes, ie. not a released version (eg. `v1.19.0-alpha.1.426+0926c9c47677e9`)                                      |
 | `CI_VERSION`                | Provide a custom CI version of Kubernetes. By default, the latest master commit will be used.                                              |
 | `TEST_CCM`                  | Build a cluster that uses custom versions of the Azure cloud-provider cloud-controller-manager and node-controller-manager images          |
-| `EXP_MACHINE_POOL`          | Use [Machine Pool](topics/machinepools.md) for worker machines.                                                                            |
+| `EXP_MACHINE_POOL`          | Use [Machine Pool](../topics/machinepools.md) for worker machines.                                                                            |
 | `REGISTRY`                  | Registry to push any custom k8s images or cloud provider images built.                                                                     |
 | `CLUSTER_TEMPLATE`          | Use a custom cluster template. By default, the script will choose the appropriate cluster template based on existing environment variabes. |
 

docs/book/src/topics/failure-domains.md

@@ -1,6 +1,6 @@
 # Failure Domains
 
-The Azure provider includes the support for [failure domains](https://cluster-api.sigs.k8s.io/developer/providers/v1alpha2-to-v1alpha4.html#optional-support-failure-domains) introduced as part of v1alpha4.
+The Azure provider includes the support for [failure domains](https://cluster-api.sigs.k8s.io/developer/providers/v1alpha2-to-v1alpha3.html#optional-support-failure-domains) introduced as part of v1alpha3.
 
 ## Failure domains in Azure
 

docs/book/src/topics/troubleshooting.md

@@ -155,10 +155,10 @@ ssh -J capi@${apiserver} capi@${node}
 
 ## Automated log collection
 
-As part of [CI](../../../../scripts/ci-e2e.sh) there is a [log collection script](hack/../../hack/log/log-dump.sh) which you can also leverage to pull all the logs for machines which will dump logs to `${PWD}/_artifacts}` by default:
+As part of [CI](../../../../scripts/ci-e2e.sh) there is a [log collection script](../../../../hack/log/log-dump.sh) which you can also leverage to pull all the logs for machines which will dump logs to `${PWD}/_artifacts}` by default:
 
 ```bash
 ./hack/log/log-dump.sh
 ```
 
-There are also some [provided scripts](/hack/debugging/Readme.md) that can help automate a few common tasks.
+There are also some [provided scripts](../../../../hack/debugging/Readme.md) that can help automate a few common tasks.