docs: Add how to deploy CAREN (#599)

Also add some more icon bling to the menu and update menu ordering.

Author: jimmidyson

.markdownlint.json

@@ -1,6 +1,6 @@
 {
   "heading-style": { "style": "atx" },
   "ul-style": { "style": "dash" },
-  "line-length": { "line_length": 120, "stern": true },
+  "line-length": { "line_length": 120, "code_blocks": false },
   "hr-style": { "style": "---" }
 }

docs/content/_index.md

@@ -1,5 +1,5 @@
 +++
-title = "CAPI Runtime Extensions"
+title = "Cluster API Runtime Extensions - Nutanix (CAREN)"
 
 # [[cascade]]
 # type = "blog"
@@ -23,11 +23,12 @@ templating by introducing variables specified with an OpenAPI schema that can th
 via patches.
 
 The [Runtime SDK] feature provides an extensibility mechanism to hook into `ClusterClass` managed Kubernetes clusters'
-lifecycle. This project, CAPI Runtime Extensions, provides implementations of various runtime hooks that can be used in
-`ClusterClasses` across providers. This includes variables and patches that can be used across any provider to configure
-generic Kubernetes capabilities, such as configuring audit policy or HTTP proxy configuration. These capabilities are
-not provider-specific and delivering these capabilities in code instead of directly embedded in `ClusterClass`
-definitions leads to a much more robust experience via fast-feedback unit tests, as opposed to long running e2e tests.
+lifecycle. This project, Cluster API Runtime Extensions - Nutanix (CAREN), provides implementations of various runtime
+hooks that can be used in `ClusterClasses` across providers. This includes variables and patches that can be used across
+any provider to configure generic Kubernetes capabilities, such as configuring audit policy or HTTP proxy configuration.
+These capabilities are not provider-specific and delivering these capabilities in code instead of directly embedded in
+`ClusterClass` definitions leads to a much more robust experience via fast-feedback unit tests, as opposed to long
+running e2e tests.
 
 In addition to cluster resource customizations, this project enables management of essential cluster addons (e.g. CNI)
 via variable definitions, e.g. selecting a CNI provider via variables defined on the `Cluster` resource itself. The goal

docs/content/addons/_index.md

@@ -1,5 +1,5 @@
 +++
 title = "Addons"
-weight = 2
+weight = 3
 icon = "fa-solid fa-cubes"
 +++

docs/content/addons/cluster-autoscaler.md

@@ -1,5 +1,6 @@
 +++
 title = "Cluster Autoscaler"
+icon = "fa-solid fa-up-right-and-down-left-from-center"
 +++
 
 By leveraging CAPI cluster lifecycle hooks, this handler deploys [Cluster Autoscaler][cluster-autoscaler]

docs/content/contributing/_index.md

@@ -1,5 +1,5 @@
 +++
 title = "Contributing"
 weight = 99
-icon = "fa-solid fa-gift"
+icon = "fa-solid fa-hand-holding-heart"
 +++

docs/content/contributing/e2e_tests.md

@@ -1,5 +1,6 @@
 +++
 title = "End-to-end tests"
+icon = "fa-solid fa-bugs"
 +++
 
 This project uses [Ginkgo] to run end-to-end tests. Tests are labelled to make running targeted or specific tests

docs/content/contributing/releasing.md

@@ -1,5 +1,6 @@
 +++
 title = "Releasing"
+icon = "fa-solid fa-gift"
 +++
 
 This project uses [release-please] to automate changelog updates per release. Due to security restrictions[^1] in the
@@ -9,7 +10,7 @@ This project uses [release-please] to automate changelog updates per release. Du
 When a release has been cut, a new release PR can be created manually using the `release-please` CLI locally. This needs
 to be run by someone with write permissions to the repository. Create the `release-please` branch and PR:
 
-```bash
+```shell
 make release-please
 ```
 
@@ -20,19 +21,19 @@ date).
 When a release is ready, the commits in the release PR will need to be signed (again, this is a security requirement).
 To do this, check out the PR branch locally:
 
-```bash
+```shell
 gh pr checkout <RELEASE_PR_NUMBER>
 ```
 
 Sign the previous commit:
 
-```bash
+```shell
 git commit --gpg-sign --amend
 ```
 
 And force push:
 
-```bash
+```shell
 git push --force-with-lease
 ```
 

docs/content/customization/_index.md

@@ -1,6 +1,6 @@
 +++
 title = "Cluster customizations"
-weight = 1
+weight = 2
 icon = "fa-solid fa-screwdriver-wrench"
 +++
 

docs/content/customization/nutanix/_index.md

@@ -1,6 +1,6 @@
 +++
 title = "Nutanix"
-icon = "fa-brands fa-nutanix"
+icon = "fa-solid fa-server"
 +++
 
 The customizations in this section are applicable only to Nutanix clusters. They will only be applied to clusters that

docs/content/getting-started/_index.md

@@ -0,0 +1,8 @@
++++
+title = "Getting started"
+icon = "fa-solid fa-forward-fast"
+weight = 1
++++
+
+To deploy CAREN, follow the docs on how to deploy CAREN using either
+[clusterctl]({{< ref "deployment/via-clusterctl" >}}) or [Helm]({{< ref "deployment/via-helm" >}}).