From d857e8c7f47635fb4a7897349cc447e3accbefed Mon Sep 17 00:00:00 2001 From: willie-yao Date: Tue, 10 Sep 2024 18:30:08 +0000 Subject: [PATCH] Fix broken links --- .github/ISSUE_TEMPLATE/bug_report.md | 2 +- docs/README.md | 5 +++-- docs/book/src/roadmap.md | 2 +- docs/book/src/self-managed/addons.md | 2 +- docs/book/src/self-managed/custom-vnet.md | 2 +- docs/book/src/self-managed/publicmec-clusters.md | 4 ++-- 6 files changed, 9 insertions(+), 8 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index 8bef598cef1..ef032820572 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -6,7 +6,7 @@ about: Tell us about a problem you are experiencing. /kind bug -[Before submitting an issue, have you checked the [Troubleshooting Guide](https://capz.sigs.k8s.io/topics/troubleshooting.html)?] +[Before submitting an issue, have you checked the Troubleshooting Guide [self-managed](https://capz.sigs.k8s.io/self-managed/troubleshooting.html) & [managed](https://capz.sigs.k8s.io/managed/troubleshooting.html)?] **What steps did you take and what happened:** [A clear and concise description of what the bug is.] diff --git a/docs/README.md b/docs/README.md index 372af9dd6c8..4e4cd234d3b 100644 --- a/docs/README.md +++ b/docs/README.md @@ -2,7 +2,7 @@ ## Quick start -- [Getting started](https://capz.sigs.k8s.io/topics/getting-started.html) +- [Getting started](https://capz.sigs.k8s.io/getting-started.html) - [Cluster API quick start](https://cluster-api.sigs.k8s.io/user/quick-start.html) ## Features @@ -22,7 +22,8 @@ ## Troubleshooting -- [Troubleshooting guide](https://capz.sigs.k8s.io/topics/troubleshooting.html) +- [Self-managed troubleshooting guide](https://capz.sigs.k8s.io/self-managed/troubleshooting.html) +- [Managed troubleshooting guide](https://capz.sigs.k8s.io/managed/troubleshooting.html) ## Docs contributors diff --git a/docs/book/src/roadmap.md b/docs/book/src/roadmap.md index a50a2a1467b..4c2533b0a23 100644 --- a/docs/book/src/roadmap.md +++ b/docs/book/src/roadmap.md @@ -16,7 +16,7 @@ Azure Service Operator (ASO) is automatically installed with CAPZ and can be uti CAPZ can provision three major types of clusters, each of which have a different investment priority. 1. Self-Managed clusters - maintain the current functionality via bug fixes and security patches. New features will be accepted via contributor pull requests. -2. Managed clusters (AzureManaged* current API) - maintain the current functionality via bug fixes and security patches. New features will be accepted via contributor pull requests. It is recommended that the existing [asoManaged*Patches functionality](https://capz.sigs.k8s.io/topics/managedcluster#warning-warning-this-is-meant-to-be-used-sparingly-to-enable-features-for-development-and-testing-that-are-not-otherwise-represented-in-the-capz-api-misconfiguration-that-conflicts-with-capzs-normal-mode-of-operation-is-possible) be considered as a stop-gap to missing features in the CAPZ definitions for AKS. +2. Managed clusters (AzureManaged* current API) - maintain the current functionality via bug fixes and security patches. New features will be accepted via contributor pull requests. It is recommended that the existing [asoManaged*Patches functionality](./managed/managedcluster.md#warning-warning-this-is-meant-to-be-used-sparingly-to-enable-features-for-development-and-testing-that-are-not-otherwise-represented-in-the-capz-api-misconfiguration-that-conflicts-with-capzs-normal-mode-of-operation-is-possible) be considered as a stop-gap to missing features in the CAPZ definitions for AKS. See deprecation timeline below. 3. Managed clusters (AzureASOManaged* new API) - was moved out of experimentation in July for the 1.16 release and is where the investment lies moving forward for provisioning AKS clusters. diff --git a/docs/book/src/self-managed/addons.md b/docs/book/src/self-managed/addons.md index a1f3790b9af..84e1066f7a2 100644 --- a/docs/book/src/self-managed/addons.md +++ b/docs/book/src/self-managed/addons.md @@ -1,6 +1,6 @@ # Overview -This section provides examples for addons for self-managed clusters. For managed cluster addons, please go to the [managed cluster specifications](https://capz.sigs.k8s.io/topics/managedcluster.html#specification). +This section provides examples for addons for self-managed clusters. For managed cluster addons, please go to the [managed cluster specifications](../managed/managedcluster.md#specification). Self managed cluster addon options covered here: diff --git a/docs/book/src/self-managed/custom-vnet.md b/docs/book/src/self-managed/custom-vnet.md index b3401fadb23..95764a13814 100644 --- a/docs/book/src/self-managed/custom-vnet.md +++ b/docs/book/src/self-managed/custom-vnet.md @@ -70,7 +70,7 @@ spec: resourceGroup: cluster-vnet-peering ``` -Currently, only virtual networks on the same subscription can be peered. Also, note that when creating workload clusters with internal load balancers, the management cluster must be in the same VNet or a peered VNet. See [here](https://capz.sigs.k8s.io/topics/api-server-endpoint.html#warning) for more details. +Currently, only virtual networks on the same subscription can be peered. Also, note that when creating workload clusters with internal load balancers, the management cluster must be in the same VNet or a peered VNet. See [here](./api-server-endpoint.md#warning) for more details. ## Custom Network Spec diff --git a/docs/book/src/self-managed/publicmec-clusters.md b/docs/book/src/self-managed/publicmec-clusters.md index 1374604fce4..8a88fdf9849 100644 --- a/docs/book/src/self-managed/publicmec-clusters.md +++ b/docs/book/src/self-managed/publicmec-clusters.md @@ -68,14 +68,14 @@ Execute clusterctl to template the resources: clusterctl init --infrastructure azure clusterctl generate cluster ${CLUSTER_NAME} --kubernetes-version ${KUBERNETES_VERSION} --flavor edgezone > edgezone-cluster.yaml ``` -Public MEC doesn't have access to CAPI images in Azure Marketplace, therefore, users need to prepare CAPI image by themselves. You can follow doc [Custom Images](https://capz.sigs.k8s.io/topics/custom-images.html) to setup custom image. +Public MEC doesn't have access to CAPI images in Azure Marketplace, therefore, users need to prepare CAPI image by themselves. You can follow doc [Custom Images](./custom-images.md) to setup custom image. Apply the modified template to your kind management cluster: ```bash kubectl apply -f edgezone-cluster.yaml ``` -Once target cluster's control plane is up, install [Azure cloud provider components](https://github.com/kubernetes-sigs/cloud-provider-azure/tree/master/helm/cloud-provider-azure) by helm. The minimum version for "out-of-tree" Azure cloud provider is v1.0.3, "in-tree" Azure cloud provider is not supported. (Reference: https://capz.sigs.k8s.io/topics/addons.html#external-cloud-provider) +Once target cluster's control plane is up, install [Azure cloud provider components](https://github.com/kubernetes-sigs/cloud-provider-azure/tree/master/helm/cloud-provider-azure) by helm. The minimum version for "out-of-tree" Azure cloud provider is v1.0.3, "in-tree" Azure cloud provider is not supported. (Reference: ./addons.md#external-cloud-provider) ```bash # get the kubeconfig of the cluster