Update docs and fix broken links (#116)

* Update docs and fix broken links

* More changes

Author: davidjumani

README.md

@@ -68,11 +68,11 @@ This provider's versions are able to work on the following versions of Apache Cl
 
 ## Operating system images
 
-Note: Cluster API Provider Apache CloudStack relies on a few prerequisites which have to be already
+Note: Cluster API Provider CloudStack relies on a few prerequisites which have to be already
 installed in the used operating system images, e.g. a container runtime, kubelet, kubeadm, etc.
 Reference images can be found in [kubernetes-sigs/image-builder][image-builder].
 
-Prebuilt images can be found [here](prebuilt-images)
+Prebuilt images can be found [here][prebuilt-images]
 
 ------
 ## Getting involved and contributing
@@ -86,7 +86,7 @@ involved:
 
 ## Code of conduct
 
-Participation in the Kubernetes community is governed by the [Kubernetes Code of Conduct](code-of-conduct.md).
+Participation in the Kubernetes community is governed by the [Kubernetes Code of Conduct][code-of-conduct].
 
 ## Github issues
 
@@ -136,11 +136,12 @@ All the CAPC contributors:
 
 [capi-quick-start]: https://cluster-api.sigs.k8s.io/user/quick-start.html
 [cluster_api]: https://sigs.k8s.io/cluster-api
+[code-of-conduct]: https://kubernetes.io/community/code-of-conduct/
 [getting_started]: https://cluster-api-cloudstack.sigs.k8s.io/getting-started.html
-[image-builder]: https://sigs.k8s.io/image-builder/tree/master/images/capi
+[image-builder]: https://github.com/kubernetes-sigs/image-builder/tree/master/images/capi
 [kops]: https://github.com/kubernetes/kops
 [kubicorn]: http://kubicorn.io/
 [prebuilt-images]: http://packages.shapeblue.com/cluster-api-provider-cloudstack/images/
 [slack]: https://kubernetes.slack.com/messages/cluster-api-cloudstack
-[new_bug_issue]: https://sigs.k8s.io/cluster-api-provider-cloudstack/issues/new
-[new_feature_issue]: https://sigs.k8s.io/cluster-api-provider-cloudstack/issues/new
+[new_bug_issue]: https://github.com/kubernetes-sigs/cluster-api-provider-cloudstack/issues/new
+[new_feature_issue]: https://github.com/kubernetes-sigs/cluster-api-provider-cloudstack/issues/new

docs/book/src/clustercloudstack/configuration.md

@@ -179,7 +179,6 @@ The list of existing affinity groups can be fetched using the cmk cli as follows
 cmk list affinitygroups listall=true | jq '.affinitygroup[] | {name, id}'
 ```
 
-
 ### VM Details
 
 These are arbitrary key value pairs which are passed as VM details while deploying the nodes.
@@ -194,6 +193,7 @@ TODO / Maybe add feature ?
 
 TODO / Add feature
 
+
 # Apache CloudStack Credentials
 
   1. Generate the API and Secret Key for your Apache CloudStack instance either via the UI (Accounts > User > API Key) or the `getUserKeys` API.

docs/book/src/development/building.md

@@ -6,8 +6,7 @@
     1. docker
     2. kind
     3. kubectl
-    4. clusterctl [here][clusterctl-release]
-    TODO : Update this once there is an official release
+    4. clusterctl (Requires v1.1.5 +)
 
 2. Create a local docker registry to save your docker image - otherwise, you need an image registry to push it somewhere else.
 

docs/book/src/development/index.md

@@ -16,7 +16,7 @@ Please install the following tools :
 
 ### Get the source
 
-Fork the [cluster-api-provider-cloudstack repo](https://github.com/kubernetes-sigs/cluster-api-provider-cloudstack):
+Fork the [cluster-api-provider-cloudstack](https://github.com/kubernetes-sigs/cluster-api-provider-cloudstack) repo:
 
 ```bash
 cd "$(go env GOPATH)"/src

docs/book/src/development/tilt.md

@@ -125,4 +125,4 @@ kind delete cluster
 <!-- References -->
 [tilt]: https://tilt.dev
 [cluster_api_tilt]: https://cluster-api.sigs.k8s.io/developer/tilt.html
-[initial-setup]: ./index.md#initial-setup-for-development-environment
+[initial-setup]: ./index.html#initial-setup-for-development-environment

docs/book/src/getting-started.md

@@ -4,9 +4,7 @@
 
 1. Follow the instructions [here][capi-quick-start] to install the following tools:
     - [kubectl][kubectl-install]
-    - [clusterctl][clusterctl-install]
-
-    TODO : Update this once there is an official release
+    - [clusterctl][clusterctl-install] (Requires v1.1.5 +)
 
     Optional if you do not have an existing Kubernetes cluster
     - [kind][kind-install]
@@ -52,7 +50,7 @@ Run the following command to turn your cluster into a management cluster and loa
 [cloudstack-capi-images]: https://image-builder.sigs.k8s.io/capi/providers/cloudstack.html
 [docker-install]: https://www.docker.com/
 [kind-install]: https://kind.sigs.k8s.io/
-[kubectl-install]: [https://kubernetes.io/docs/tasks/tools/install-kubectl/]
+[kubectl-install]: https://kubernetes.io/docs/tasks/tools/install-kubectl/
 [prebuilt-images]: http://packages.shapeblue.com/cluster-api-provider-cloudstack/images/
 
 

docs/book/src/topics/custom-images.md

@@ -10,28 +10,12 @@ As of now, prebuilt images for KVM, VMware and XenServer are available [here][pr
 
 ## Building a custom image
 
-Cluster API uses the Kubernetes [Image Builder][image-builder] tools. You should use the [CloudStack images][image-builder-cloudstack] from that project as a starting point for your custom image.
+Cluster API uses the Kubernetes [Image Builder][image-builder] tools. You should use the [QEMU images][image-builder-qemu] from that project as a starting point for your custom image.
 
 [The Image Builder Book][capi-images] explains how to build the images defined in that repository, with instructions for [CloudStack CAPI Images][cloudstack-capi-images] in particular.
 
 The image is built using KVM hypervisor as a `qcow2` image.
-Following which, it is then converted into `ova` for VMware and `vhd` for XenServer as a `post-processors` build step.
-
-Depending on the requirement and the hypervisor, the `post-processors` can be modified.
-
-If you build Apache CloudStack CAPI images with the `make` targets in Image Builder, these required values are printed after a successful build. For example:
-
-```bash
-$ make -C images/capi/ build-cloudstack-ubuntu-2004
-# many minutes later...
-==> qemu:
-Build 'qemu' finished after 45 minutes 54 seconds.
-
-11:13:48 ==> Builds finished. The artifacts of successful builds are:
-11:13:48 --> qemu: VM files in directory: ./output/ubuntu-2004-kube-v1.21.10
-11:13:48 --> qemu: VM files in directory: ./output/ubuntu-2004-kube-v1.21.10
-11:13:48 --> qemu: VM files in directory: ./output/ubuntu-2004-kube-v1.21.10
-```
+Depending on they hypervisor requirements, it can then converted into `ova` for VMware and `vhd` for XenServer via the `convert-cloudstack-image.sh` script.
 
 ### Operating system requirements
 
@@ -75,7 +59,7 @@ See [Upgrading workload clusters][upgrading-workload-clusters] for more details.
 [capi-images]: https://image-builder.sigs.k8s.io/capi/capi.html
 [cloudstack-capi-images]: https://image-builder.sigs.k8s.io/capi/providers/cloudstack.html
 [image-builder]: https://github.com/kubernetes-sigs/image-builder
-[image-builder-cloudstack]: https://github.com/kubernetes-sigs/image-builder/tree/master/images/capi/packer/cloudstack
+[image-builder-qemu]: https://github.com/kubernetes-sigs/image-builder/tree/master/images/capi/packer/qemu
 [kubeadm-preflight-checks]: https://github.com/kubernetes/kubeadm/blob/master/docs/design/design_v1.10.md#preflight-checks
 [prebuilt-images]: http://packages.shapeblue.com/cluster-api-provider-cloudstack/images/
 [upgrading-workload-clusters]: https://cluster-api.sigs.k8s.io/tasks/kubeadm-control-plane.html#upgrading-workload-clusters