🌱 add meta titles & descriptions (#1498)

* 🌱 add descriptions * 🌱 add new meta titles * 📖 Improve documentation pages metadata * 🌱 lint * 🌱 fix heading level --------- Co-authored-by: Lucas Rattz <[email protected]>
syself · Nov 21, 2024 · e81eac0 · e81eac0
1 parent b023d19
commit e81eac0
Show file tree

Hide file tree

Showing 30 changed files with 152 additions and 64 deletions.
diff --git a/docs/caph/01-getting-started/01-introduction.md b/docs/caph/01-getting-started/01-introduction.md
@@ -1,5 +1,8 @@
 ---
 title: Introduction
+metatitle: What is the Cluster API Provider Hetzner and Compatible Versions
+sidebar: Introduction
+description: Cluster API Provider Hetzner automates the lifecycle and provisioning of Kubernetes clusters on cloud or bare metal.
 ---
 
 Welcome to the official documentation for the Cluster API Provider Hetzner (CAPH). If you are new to it, you can keep reading the Getting Started section, the Quickstart guide will walk you through your first cluster setup.
@@ -23,14 +26,14 @@ This provider's versions can install and manage the following versions of Kubern
 
 |                   | Hetzner Provider `v1.0.x` |
 | ----------------- | ------------------------- |
-| Kubernetes 1.23.x | ✅                       |
-| Kubernetes 1.24.x | ✅                       |
-| Kubernetes 1.25.x | ✅                       |
-| Kubernetes 1.26.x | ✅                       |
-| Kubernetes 1.27.x | ✅                       |
-| Kubernetes 1.28.x | ✅                       |
-| Kubernetes 1.29.x | ✅                       |
-| Kubernetes 1.30.x | ✅                       |
+| Kubernetes 1.23.x | ✅                        |
+| Kubernetes 1.24.x | ✅                        |
+| Kubernetes 1.25.x | ✅                        |
+| Kubernetes 1.26.x | ✅                        |
+| Kubernetes 1.27.x | ✅                        |
+| Kubernetes 1.28.x | ✅                        |
+| Kubernetes 1.29.x | ✅                        |
+| Kubernetes 1.30.x | ✅                        |
 
 Test status:
 

diff --git a/docs/caph/01-getting-started/02-quickstart/01-prerequisites.md b/docs/caph/01-getting-started/02-quickstart/01-prerequisites.md
@@ -1,5 +1,8 @@
 ---
 title: Prerequisites
+metatitle: Tools Needed to Work With Cluster API Provider Hetzner
+sidebar: Prerequisites
+description: Automate provisioning, upgrading, and operating Kubernetes clusters on Hetzner infrastructure with Cluster API for a production-ready setup.
 ---
 
 This guide goes through all the necessary steps to create a cluster on Hetzner infrastructure (on HCloud).

diff --git a/docs/caph/01-getting-started/02-quickstart/02-management-cluster-setup.md b/docs/caph/01-getting-started/02-quickstart/02-management-cluster-setup.md
@@ -1,5 +1,8 @@
 ---
 title: Management cluster setup
+metatitle: Cluster API Management Cluster Setup for Hetzner
+sidebar: Management cluster setup
+description: Bootstrap a cluster, install and configure all the necessary components to make it function as a Cluster API management cluster.
 ---
 
 You have two options: either create a pure HCloud cluster or a hybrid cluster with Hetzner dedicated (bare metal) servers. For a full list of flavors, please check out the [release page](https://github.com/syself/cluster-api-provider-hetzner/releases). In the quickstart guide, we will go with the cluster creation on a pure Hetzner Cloud server.

diff --git a/docs/caph/01-getting-started/02-quickstart/03-creating-a-workload-cluster.md b/docs/caph/01-getting-started/02-quickstart/03-creating-a-workload-cluster.md
@@ -1,5 +1,8 @@
 ---
 title: Creating the workload cluster
+metatitle: Creating Workload Clusters on Hetzner
+sidebar: Creating the workload cluster
+description: Provision a Kubernetes workload cluster with essential components for a secure deployment, including CNI, CCM, and optional CSI integration.
 ---
 
 ## Generating the cluster.yaml

diff --git a/docs/caph/01-getting-started/02-quickstart/04-next-steps.md b/docs/caph/01-getting-started/02-quickstart/04-next-steps.md
@@ -1,5 +1,8 @@
 ---
 title: Next steps
+metatitle: Move Your Management Cluster to the Cloud
+sidebar: Next steps
+description: How to move the Cluster API components out of your bootstrap cluster, and into the newly created cluster on Hetzner.
 ---
 
 ## Switching to the workload cluster

diff --git a/docs/caph/01-getting-started/03-preparation.md b/docs/caph/01-getting-started/03-preparation.md
@@ -1,5 +1,8 @@
 ---
 title: Hetzner project preparation
+metatitle: Preparing Your Hetzner Cloud Project for Working With CAPH
+sidebar: Hetzner project preparation
+description: Learn how to do the necessary steps for creating your first workload cluster on Hetzner with Cluster API.
 ---
 
 There are several tasks that have to be completed before a workload cluster can be created.

diff --git a/docs/caph/02-topics/01-managing-ssh-keys.md b/docs/caph/02-topics/01-managing-ssh-keys.md
@@ -1,5 +1,8 @@
 ---
 title: SSH key management
+metatitle: Secure SSH Key Management for Remote Access in Hetzner with Cluster API
+sidebar: SSH key management
+description: Details about SSH keys and its importance with regards to clusters managed by CAPH.
 ---
 
 This section provides details about SSH keys and its importance with regards to CAPH.

diff --git a/docs/caph/02-topics/02-HA-setup.md b/docs/caph/02-topics/02-HA-setup.md
@@ -1,5 +1,8 @@
 ---
 title: High availability setup
+metatitle: Setting Up High Availability Cluster Configuration with Cluster API Provider Hetzner
+sidebar: High availability setup
+description: How to achieve high availability in clusters managed by CAPH.
 ---
 
 ## HA Cluster API Components

diff --git a/docs/caph/02-topics/03-node-image.md b/docs/caph/02-topics/03-node-image.md
@@ -1,5 +1,8 @@
 ---
 title: Node Images
+metatitle: Custom Node Images for Nodes in Clusters Managed by CAPH
+sidebar: Node Images
+description: Build custom Node Images for CAPH using Packer on Hetzner Cloud. Create, configure, and snapshot servers with all necessary components for Kubernetes.
 ---
 
 ## What are node-images?

diff --git a/docs/caph/02-topics/04-upgrading-caph.md b/docs/caph/02-topics/04-upgrading-caph.md
@@ -1,5 +1,8 @@
 ---
 title: Upgrading the Kubernetes Cluster API Provider Hetzner
+metatitle: Upgrade Process for Kubernetes Clusters with CAPH
+sidebar: Upgrading the Kubernetes Cluster API Provider Hetzner
+description: How to upgrade Cluster API and Cluster API Provider Hetzner.
 ---
 
 This guide explains how to upgrade Cluster API and Cluster API Provider Hetzner (aka CAPH). Additionally, it also references [upgrading your kubernetes version](#external-cluster-api-reference) as part of this guide.

diff --git a/docs/caph/02-topics/05-baremetal/01-introduction.md b/docs/caph/02-topics/05-baremetal/01-introduction.md
@@ -1,5 +1,8 @@
 ---
-title: Hetzner baremetal
+title: Hetzner bare metal
+metatitle: Introduction to Using Hetzner Bare Metal Servers as Nodes with CAPH
+sidebar: Hetzner bare metal
+description: Explanation of the Hetzner offerings, and the available cluster flavors with bare metal servers.
 ---
 
 Hetzner have two offerings primarily:
@@ -9,7 +12,7 @@ Hetzner have two offerings primarily:
 
 In this guide, we will focus on creating a cluster from baremetal servers.
 
-## Flavors of Hetzner Baremetal
+## Flavors of Hetzner Bare Metal
 
 Now, there are different ways you can use baremetal servers, you can use them as controlplanes or as worker nodes or both. Based on that we have created some templates and those templates are released as flavors in GitHub releases.
 

diff --git a/docs/caph/02-topics/05-baremetal/02-management-cluster.md b/docs/caph/02-topics/05-baremetal/02-management-cluster.md
@@ -1,5 +1,8 @@
 ---
-title: Management cluster setup for baremetal
+title: Management cluster setup for bare metal
+metatitle: Configure Your Management Cluster for Handling Hetzner Bare Metal Servers
+sidebar: Management cluster setup for bare metal
+description: Learn how to provision a management cluster ready to manage bare metal servers.
 ---
 
 ## Creating a bootstrap cluster

diff --git a/docs/caph/02-topics/05-baremetal/03-creating-workload-cluster.md b/docs/caph/02-topics/05-baremetal/03-creating-workload-cluster.md
@@ -1,5 +1,8 @@
 ---
-title: Creating a workload cluster with baremetal servers
+title: Creating a workload cluster with bare metal servers
+metatitle: Provisioning a Kubernetes Workload Cluster with Bare Metal Servers
+sidebar: Creating a workload cluster with bare metal servers
+description: Create workload clusters on Hetzner using bare metal servers as nodes in an automated way, using CAPI custom resources.
 ---
 
 ## Creating Workload Cluster

diff --git a/docs/caph/02-topics/05-baremetal/04-constant-hostnames.md b/docs/caph/02-topics/05-baremetal/04-constant-hostnames.md
@@ -1,5 +1,8 @@
 ---
 title: Using constant hostnames
+metatitle: Enable Fixed Hostnames for Bare Metal Servers in Hetzner Clusters
+sidebar: Using constant hostnames
+description: Utilize fixed node names for bare metal servers, useful for local storage persistence across reprovisionings.
 ---
 
 ## Constant hostnames for baremetal servers

diff --git a/docs/caph/02-topics/06-advanced/01-csr-controller.md b/docs/caph/02-topics/06-advanced/01-csr-controller.md
@@ -1,5 +1,8 @@
 ---
 title: CSR controller
+metatitle: Managing CSR Controller in Clusters Managed by CAPH
+sidebar: CSR controller
+description: Explore advanced Certificate Signing Request options like using a custom CSR controller in Kubernetes clusters managed by CAPH.
 ---
 
 For the secure operation of Kubernetes, it is necessary to sign the kubelet serving certificates. By default, these are self-signed by kubeadm. By using the kubelet flag `rotate-server-certificates: "true"`, which can be found in initConfiguration/joinConfiguration.nodeRegistration.kubeletExtraArgs, the kubelet will do a certificate signing request (CSR) to the certificates API of Kubernetes.
@@ -33,4 +36,4 @@ If you disable the default CSR controller, you'll need to deploy an equivalent c
 For more information, see:
 
 - [https://kubernetes.io/docs/reference/access-authn-authz/certificate-signing-requests/](https://kubernetes.io/docs/reference/access-authn-authz/certificate-signing-requests/)
-- [https://kubernetes.io/docs/reference/access-authn-authz/kubelet-tls-bootstrapping/#certificate-rotation](https://kubernetes.io/docs/reference/access-authn-authz/kubelet-tls-bootstrapping/#certificate-rotation)
+- [https://kubernetes.io/docs/reference/access-authn-authz/kubelet-tls-bootstrapping/#certificate-rotation](https://kubernetes.io/docs/reference/access-authn-authz/kubelet-tls-bootstrapping/#certificate-rotation)
diff --git a/docs/caph/02-topics/06-advanced/02-rate-limits.md b/docs/caph/02-topics/06-advanced/02-rate-limits.md
@@ -1,5 +1,8 @@
 ---
 title: Rate limits
+metatitle: Rate Limits for HCloudMachine Reconciliation Controller
+sidebar: Rate limits
+description: Information about Hetzner Cloud rate limits, and what to expect when you are affected.
 ---
 
 Hetzner Cloud and Hetzner Robot both implement rate limits. As a brute-force method, we implemented some logic that prevents the controller from reconciling a specific object for some defined time period if a rate limit was hit during reconcilement of that object. We set the condition on true, that a rate limit was hit. Of course, this only affects one object so that another `HCloudMachine` still reconciles normally, even though one hits the rate limit. There is a chance that it will also hit the rate limit (which is defined per function so that it does not necessarily need to happen). In that case, the controller also stops reconciling this object for some time.
diff --git a/docs/caph/02-topics/06-advanced/03-multi-tenancy.md b/docs/caph/02-topics/06-advanced/03-multi-tenancy.md
@@ -1,5 +1,8 @@
 ---
 title: Multi tenancy
+metatitle: Multi tenancy, Running Multiple Clusters in The Same Hetzner Project
+sidebar: Multi tenancy
+description: Information about multi tenancy, i.e. running multiple Kubernetes clusters in the same Hetzner cloud project.
 ---
 
 We support multi-tenancy. You can start multiple clusters in one Hetzner project at the same time. As the resources all have a label with the cluster name, the controller is able to handle them perfectly.
diff --git a/docs/caph/02-topics/06-advanced/04-custom-templates-mhc.md b/docs/caph/02-topics/06-advanced/04-custom-templates-mhc.md
@@ -1,5 +1,8 @@
 ---
 title: Machine Health Checks with Custom Remediation Template
+metatitle: Custom Remediation Template for Machine Health Checks
+sidebar: Machine Health Checks with Custom Remediation Template
+description: Learn about the default Machine Health Checks and Bare Metal Server Remediation Templates, and how to configure them.
 ---
 
 Cluster API allows to [configure Machine Health Checks](https://cluster-api.sigs.k8s.io/tasks/automated-machine-management/healthchecking.html) with custom remediation strategies. This is helpful for our bare metal servers. If the health checks give an outcome that one server cannot be reached, the default strategy would be to delete it. In that case, it would need to be provisioned again. This takes, of course, longer for bare metal servers than for virtual cloud servers. Therefore, we want to try to avoid this with the help of our `HetznerBareMetalRemediationController` and `HCloudRemediationController`. Instead of deleting the object and deprovisioning it, we first try to reboot it and see whether this helps. If it solves the problem, we save a lot of time that is required for re-provisioning it.

diff --git a/docs/caph/03-reference/01-introduction.md b/docs/caph/03-reference/01-introduction.md
@@ -1,5 +1,8 @@
 ---
 title: Object Reference
+metatitle: Naming Conventions for Custom Resources
+sidebar: Object Reference
+description: "Overview of the naming conventions of objects specific to the CAPH integration."
 ---
 
 In this object reference, we introduce all objects that are specific for this provider integration. The naming of objects, servers, machines, etc. can be confusing. Without claiming to be consistent throughout these docs, we would like to give an overview of how we name things here.

diff --git a/docs/caph/03-reference/02-hetzner-cluster.md b/docs/caph/03-reference/02-hetzner-cluster.md
@@ -1,5 +1,7 @@
 ---
 title: HetznerCluster
+metatitle: HetznerCluster Object Reference
+description: In HetznerCluster you can define everything related to the general components of the cluster as well as those properties, which are valid cluster-wide.
 ---
 
 In HetznerCluster you can define everything related to the general components of the cluster as well as those properties, which are valid cluster-wide.