From 2f35ed662741ffd9ab88c03a0a1ad6b51b924262 Mon Sep 17 00:00:00 2001 From: Naadir Jeewa Date: Tue, 20 Apr 2021 12:12:56 +0100 Subject: [PATCH] Docs improvement for AWS Cleanup, plus SEO enhancement Signed-off-by: Naadir Jeewa --- docs/book/src/reference/providers.md | 2 +- docs/book/src/user/quick-start.md | 12 ++++++------ 2 files changed, 7 insertions(+), 7 deletions(-) diff --git a/docs/book/src/reference/providers.md b/docs/book/src/reference/providers.md index 5603a73bd5a2..0f5cff5bfd05 100644 --- a/docs/book/src/reference/providers.md +++ b/docs/book/src/reference/providers.md @@ -12,7 +12,7 @@ updated info about which API version they are supporting. ## Infrastructure - [Alibaba Cloud](https://github.com/oam-oss/cluster-api-provider-alicloud) -- [AWS](https://github.com/kubernetes-sigs/cluster-api-provider-aws) +- [AWS](https://cluster-api-aws.sigs.k8s.io/) - [Azure](https://github.com/kubernetes-sigs/cluster-api-provider-azure) - [Azure Stack HCI](https://github.com/microsoft/cluster-api-provider-azurestackhci) - [Baidu Cloud](https://github.com/baidu/cluster-api-provider-baiducloud) diff --git a/docs/book/src/user/quick-start.md b/docs/book/src/user/quick-start.md index fd366f3611d9..b8b35d9d356f 100644 --- a/docs/book/src/user/quick-start.md +++ b/docs/book/src/user/quick-start.md @@ -161,10 +161,9 @@ before getting started with Cluster API. See below for the expected settings for {{#tabs name:"tab-installation-infrastructure" tabs:"AWS,Azure,DigitalOcean,Docker,GCP,vSphere,OpenStack,Metal3,Packet"}} {{#tab AWS}} -Download the latest binary of `clusterawsadm` from the [AWS provider releases] and make sure to place it in your path. You need at least version v0.5.5 for these instructions. -Instructions for older versions of clusterawsadm are available in [Github][legacy-clusterawsadm]. +Download the latest binary of `clusterawsadm` from the [AWS provider releases] and make sure to place it in your path. -The clusterawsadm command line utility assists with identity and access management (IAM) for Cluster API Provider AWS. +The [clusterawsadm] command line utility assists with identity and access management (IAM) for [Cluster API Provider AWS][capa]. ```bash export AWS_REGION=us-east-1 # This is used to help encode your environment variables @@ -753,22 +752,23 @@ See the [clusterctl] documentation for more detail about clusterctl supported ac [AWS provider releases]: https://github.com/kubernetes-sigs/cluster-api-provider-aws/releases [Azure Provider Prerequisites]: https://github.com/kubernetes-sigs/cluster-api-provider-azure/blob/master/docs/getting-started.md#prerequisites [bootstrap cluster]: ../reference/glossary.md#bootstrap-cluster +[capa]: https://cluster-api-aws.sigs.k8s.io [capv-upload-images]: https://github.com/kubernetes-sigs/cluster-api-provider-vsphere/blob/master/docs/getting_started.md#uploading-the-machine-images +[clusterawsadm]: https://cluster-api-aws.sigs.k8s.io/clusterawsadm/clusterawsadm.html [clusterctl config cluster]: ../clusterctl/commands/config-cluster.md [clusterctl get kubeconfig]: ../clusterctl/commands/get-kubeconfig.md [clusterctl]: ../clusterctl/overview.md -[Docker]: https://www.docker.com/ [docker-provider]: ../clusterctl/developers.md#additional-steps-for-the-docker-provider +[Docker]: https://www.docker.com/ [GCP provider]: https://github.com/kubernetes-sigs/cluster-api-provider-gcp [infrastructure provider]: ../reference/glossary.md#infrastructure-provider [kind]: https://kind.sigs.k8s.io/ [KubeadmControlPlane]: ../developer/architecture/controllers/control-plane.md [kubectl]: https://kubernetes.io/docs/tasks/tools/install-kubectl/ [management cluster]: ../reference/glossary.md#management-cluster -[Metal3 provider]: https://github.com/metal3-io/cluster-api-provider-metal3/ [Metal3 getting started guide]: https://github.com/metal3-io/cluster-api-provider-metal3/blob/master/docs/getting-started.md +[Metal3 provider]: https://github.com/metal3-io/cluster-api-provider-metal3/ [Packet getting started guide]: https://github.com/kubernetes-sigs/cluster-api-provider-packet#using [provider components]: ../reference/glossary.md#provider-components [vSphere getting started guide]: https://github.com/kubernetes-sigs/cluster-api-provider-vsphere/ [workload cluster]: ../reference/glossary.md#workload-cluster -[legacy-clusterawsadm]: https://github.com/kubernetes-sigs/cluster-api/blob/v0.3.6/docs/book/src/user/quick-start.md#initialization-for-common-providers