fix broken links

kubernetes-sigs · Aug 21, 2024 · a0f1549 · a0f1549
1 parent 453a597
commit a0f1549
Show file tree

Hide file tree

Showing 8 changed files with 22 additions and 16 deletions.
diff --git a/docs/README.md b/docs/README.md
@@ -23,3 +23,9 @@
 ## Troubleshooting
 
 - [Troubleshooting guide](https://capz.sigs.k8s.io/topics/troubleshooting.html)
+
+## Docs contributors
+
+To run the link check linter, execute the following command from the root of the repository:
+
+`find . -name '*.md' -not -path './node_modules/*' -exec markdown-link-check '{}' --config .markdownlinkcheck.json -q ';'`
diff --git a/docs/book/src/developers/development.md b/docs/book/src/developers/development.md
@@ -122,7 +122,7 @@ Makefile targets and scripts are offered to work with go modules:
 
 ### Setting up the environment
 
-Your must have the Azure credentials as outlined in the [getting started prerequisites](../topics/getting-started.md#Prerequisites) section.
+Your must have the Azure credentials as outlined in the [getting started prerequisites](../getting-started.md#Prerequisites) section.
 
 ### Tilt Requirements
 
@@ -163,7 +163,7 @@ kustomize_substitutions:
   AZURE_CLIENT_ID: <client-id>
 ```
 
-You should have these values saved from the [getting started prerequisites](../topics/getting-started.md#Prerequisites) section.
+You should have these values saved from the [getting started prerequisites](../getting-started.md#Prerequisites) section.
 
 To build a kind cluster and start Tilt, just run:
 
@@ -218,7 +218,7 @@ kustomize_substitutions:
 EOF
 ```
 
-Make sure to replace the credentials with the values from the [getting started prerequisites](../topics/getting-started.md#Prerequisites) section.
+Make sure to replace the credentials with the values from the [getting started prerequisites](../getting-started.md#Prerequisites) section.
 
 > `$REGISTRY` should be in the format `docker.io/<dockerhub-username>`
 
@@ -245,7 +245,7 @@ To delete the cluster:
 make delete-workload-cluster
 ```
 
-> Check out the [troubleshooting guide](../topics/troubleshooting.md) for common errors you might run into.
+> Check out the [self-managed](../self-managed/troubleshooting.md) and [managed](../managed/troubleshooting.md) troubleshooting guides for common errors you might run into.
 
 #### Viewing Telemetry
 
@@ -414,7 +414,7 @@ Create the cluster:
 make create-cluster
 ```
 
-> Check out the [troubleshooting](../topics/troubleshooting.md) guide for common errors you might run into.
+> Check out the [self-managed](../self-managed/troubleshooting.md) and [managed](../managed/troubleshooting.md) troubleshooting guides for common errors you might run into
 
 ### Instrumenting Telemetry
 Telemetry is the key to operational transparency. We strive to provide insight into the internal behavior of the
@@ -571,7 +571,7 @@ You can optionally set the following variables:
 | `KUBERNETES_VERSION`        | Desired Kubernetes version to test. You can pass in a definitive released version, e.g., "v1.24.0". If you want to use pre-released CI bits of a particular release you may use the "latest-" prefix, e.g., "latest-1.24"; you may use the very latest built CI bits from the kubernetes/kubernetes master branch by passing in "latest". If you provide a `KUBERNETES_VERSION` environment variable, you may not also use `CI_VERSION` (below). Use only one configuration variable to declare the version of Kubernetes to test. |
 | `CI_VERSION`                | Provide a custom CI version of Kubernetes (e.g., `v1.25.0-alpha.0.597+aa49dffc7f24dc`). If not specified, this will be determined from the KUBERNETES_VERSION above if it is an unreleased version. If you provide a `CI_VERSION` environment variable, you may not also use `KUBERNETES_VERSION` (above).                                                                                                                                                                                                                         |
 | `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](../self-managed/machinepools.md) for worker machines.                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |
 | `TEST_WINDOWS`              | Build a cluster that has Windows worker nodes.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |
 | `REGISTRY`                  | Registry to push any custom k8s images or cloud provider images built.                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
 | `CLUSTER_TEMPLATE`          | Use a custom cluster template. It can be a path to a template under templates/, a path on the host or a link. If the value is not set, the script will choose the appropriate cluster template based on existing environment variables.                                                                                                                                                                                                                                                                                            |

diff --git a/docs/book/src/developers/releasing.md b/docs/book/src/developers/releasing.md
@@ -156,7 +156,7 @@ Note: this step requires access to the Netlify site. If you don't have access, p
 
 #### Minor/Major Releases
 
-1. Follow the communications process for [pre-releases](#pre-releases)
+1. Follow the communications process for [patch-releases](#patch-releases)
 2. An announcement email is sent to `[email protected]` and `[email protected]` with the subject `[ANNOUNCE] cluster-api-provider-azure <version> has been released`
 
 [semver]: https://semver.org/#semantic-versioning-200

diff --git a/docs/book/src/getting-started.md b/docs/book/src/getting-started.md
@@ -45,7 +45,7 @@ An Azure Service Principal is needed for deploying Azure resources. The below in
   ```
 
   5. Create an Azure Service Principal by running the following command or skip this step and use a previously created Azure Service Principal.
-  NOTE: the "owner" role is required to be able to create role assignments for [system-assigned managed identity](vm-identity.md).
+  NOTE: the "owner" role is required to be able to create role assignments for system-assigned managed identity.
 
   ```bash
   az ad sp create-for-rbac --role contributor --scopes="/subscriptions/${AZURE_SUBSCRIPTION_ID}"
@@ -84,15 +84,15 @@ For example, if your password is `foo'blah$`, you should do `export AZURE_CLIENT
 
 <h1> Warning </h1>
 
-The capability to set credentials using environment variables is now deprecated and will be removed in future releases, the recommended approach is to use `AzureClusterIdentity` as explained [here](multitenancy.md)
+The capability to set credentials using environment variables is now deprecated and will be removed in future releases, the recommended approach is to use `AzureClusterIdentity` as explained [here](./topics/multitenancy.md)
 
 </aside>
 
 
 ### Building your first cluster
 Check out the [Cluster API Quick Start](https://cluster-api.sigs.k8s.io/user/quick-start.html) to create your first Kubernetes cluster on Azure using Cluster API. Make sure to select the "Azure" tabs.
 
-If you are looking to install additional ASO CRDs, set `ADDITIONAL_ASO_CRDS` to the list of CRDs you want to install. Refer to adding additional CRDs for Azure Service Operator [here](aso.md#Using-aso-for-non-capz-resources).
+If you are looking to install additional ASO CRDs, set `ADDITIONAL_ASO_CRDS` to the list of CRDs you want to install. Refer to adding additional CRDs for Azure Service Operator [here](./topics/aso.md#Using-aso-for-non-capz-resources).
 
 <h1> Warning </h1>
 

diff --git a/docs/book/src/managed/managed.md b/docs/book/src/managed/managed.md
@@ -1,7 +1,7 @@
 # Managed Clusters
 
 This section contains information specific to configuring managed (AKS) Kubernetes clusters using Cluster API Provider for Azure (CAPZ).
-See [self-managed clusters](./self-managed.md) for information specific to provisioning these clusters.
+See [self-managed clusters](../self-managed/self-managed.md) for information specific to provisioning these clusters.
 
 Documents under the Managed Clusters area:
 - [Adopting Clusters](managed.md)

diff --git a/docs/book/src/self-managed/flatcar.md b/docs/book/src/self-managed/flatcar.md
@@ -14,7 +14,7 @@ The testing reference images are built using [image-builder](https://github.com/
 
 The reference images are not updated with security fixes. They are intended only to facilitate testing and to help users try out Cluster API for Azure.
 
-The reference images should not be used in a production environment. It is highly recommended to [maintain your own custom image](#building-a-custom-image) instead.
+The reference images should not be used in a production environment. It is highly recommended to [maintain your own custom image](./custom-images.md#building-a-custom-image) instead.
 
 </aside>
 

diff --git a/docs/book/src/topics/identities.md b/docs/book/src/topics/identities.md
@@ -160,9 +160,9 @@ spec:
     - <cluster-namespace>
 ```
 
-### Assigning VM identities for cloud provider authentication
+### Assigning VM identities for cloud provider authentication (self-managed)
 
-When using a user-assigned managed identity to create the workload cluster, a VM identity should also be assigned to each control plane machine in the workload cluster for Azure Cloud Provider to use. See [here](../topics/vm-identity.md#managed-identities) for more information.
+When using a user-assigned managed identity to create the workload cluster, a VM identity should also be assigned to each control plane machine in the workload cluster for Azure Cloud Provider to use. See [here](../self-managed/vm-identity.md#managed-identities) for more information.
 
 
 ## Azure Host Identity
@@ -172,6 +172,6 @@ The identity assigned to the Azure host which in the control plane provides the
 - User-assigned Managed Identity
 - System-assigned Managed Identity
 - Service Principal
-- See details about each type in the [VM identity](vm-identity.md) page
+- See details about each type in the [VM identity](../self-managed/vm-identity.md) page
 
 More details in [Azure built-in roles documentation](https://learn.microsoft.com/azure/role-based-access-control/built-in-roles).
diff --git a/docs/book/src/topics/multitenancy.md b/docs/book/src/topics/multitenancy.md
@@ -20,7 +20,7 @@ Please note NamespaceList will take precedence over Selector if both are set.
 
 <aside class="note warning">
 <h1> Warning </h1>
-The ability to set credentials using environment variables has been removed. Instead, use <code class="hjls">AzureClusterIdentity</code> as described in the <a href="identities.html">identities</a> documentation.
+The ability to set credentials using environment variables has been removed. Instead, use <code class="hjls">AzureClusterIdentity</code> as described in the identities documentation.
 </aside>
 
 <aside class="note warning">