docs: fix duplicate titles in documentation

This just converts H1s into metadata. Signed-off-by: Andrey Smirnov <smirnov.andrey@gmail.com>
siderolabs · May 24, 2021 · 2f8ad47 · 2f8ad47
1 parent 56ca87c
commit 2f8ad47
Show file tree

Hide file tree

Showing 42 changed files with 51 additions and 81 deletions.
diff --git a/website/content/docs/v0.1/Configuration/environments.md b/website/content/docs/v0.1/Configuration/environments.md
@@ -1,10 +1,9 @@
 ---
 description: ""
 weight: 1
+title: Environments
 ---
 
-# Environments
-
 Environments are a custom resource provided by the Metal Controller Manager.
 An environment is a codified description of what should be returned by the PXE server when a physical server attempts to PXE boot.
 

diff --git a/website/content/docs/v0.1/Configuration/metadata.md b/website/content/docs/v0.1/Configuration/metadata.md
@@ -1,10 +1,9 @@
 ---
 description: ""
 weight: 4
+title: Metadata
 ---
 
-# Metadata
-
 The Metadata server manages the Machine metadata.
 In terms of Talos (the OS on which the Kubernetes cluster is formed), this is the
 "[machine config](https://www.talos.dev/docs/v0.8/reference/configuration/)",

diff --git a/website/content/docs/v0.1/Configuration/serverclasses.md b/website/content/docs/v0.1/Configuration/serverclasses.md
@@ -1,10 +1,9 @@
 ---
 description: ""
 weight: 3
+title: Server Classes
 ---
 
-# Server Classes
-
 Server classes are a way to group distinct server resources.
 The "qualifiers" key allows the administrator to specify criteria upon which to group these servers.
 There are currently three keys: `cpu`, `systemInformation`, and `labelSelectors`.

diff --git a/website/content/docs/v0.1/Configuration/servers.md b/website/content/docs/v0.1/Configuration/servers.md
@@ -1,10 +1,9 @@
 ---
 description: ""
 weight: 2
+title: Servers
 ---
 
-# Servers
-
 Servers are the basic resource of bare metal in the Metal Controller Manager.
 These are created by PXE booting the servers and allowing them to send a registration request to the management plane.
 

diff --git a/website/content/docs/v0.1/Getting Started/architecture.md b/website/content/docs/v0.1/Getting Started/architecture.md
@@ -1,10 +1,9 @@
 ---
 description: ""
 weight: 3
+title: Architecture
 ---
 
-# Architecture
-
 The overarching architecture of Sidero centers around a "management plane".
 This plane is expected to serve as a single interface upon which administrators can create, scale, upgrade, and delete Kubernetes clusters.
 At a high level view, the management plane + created clusters should look something like:

diff --git a/website/content/docs/v0.1/Getting Started/installation.md b/website/content/docs/v0.1/Getting Started/installation.md
@@ -1,10 +1,9 @@
 ---
 description: ""
 weight: 2
+title: Installation
 ---
 
-# Installation
-
 As of Cluster API version 0.3.9, Sidero is included as a default infrastructure provider in clusterctl.
 
 To install Sidero and the other Talos providers, simply issue:

diff --git a/website/content/docs/v0.1/Getting Started/introduction.md b/website/content/docs/v0.1/Getting Started/introduction.md
@@ -1,10 +1,9 @@
 ---
 description: ""
 weight: 1
+title: Introduction
 ---
 
-# Introduction
-
 Sidero ("Iron" in Greek) is a project created by the [Talos Systems](https://www.talos-systems.com/) team.
 The goal of this project is to provide lightweight, composable tools that can be used to create bare-metal Talos + Kubernetes clusters.
 These tools are built around the Cluster API project.

diff --git a/website/content/docs/v0.1/Getting Started/resources.md b/website/content/docs/v0.1/Getting Started/resources.md
@@ -1,10 +1,9 @@
 ---
 description: ""
 weight: 4
+title: Resources
 ---
 
-# Resources
-
 Sidero, the Talos bootstrap/controlplane providers, and Cluster API each provide several custom resources (CRDs) to Kubernetes.
 These CRDs are crucial to understanding the connections between each provider and in troubleshooting problems.
 It may also help to look at the [cluster template](https://github.com/talos-systems/sidero/blob/master/templates/cluster-template.yaml) to get an idea of the relationships between these.

diff --git a/website/content/docs/v0.1/Guides/bootstrapping.md b/website/content/docs/v0.1/Guides/bootstrapping.md
@@ -1,10 +1,9 @@
 ---
 description: "A guide for bootstrapping Sidero management plane"
 weight: 1
+title: Bootstrapping
 ---
 
-# Bootstrapping
-
 ## Introduction
 
 Imagine a scenario in which you have shown up to a datacenter with only a laptop and your task is to transition a rack of bare metal machines into an HA management plane and multiple Kubernetes clusters created by that management plane.

diff --git a/website/content/docs/v0.1/Guides/first-cluster.md b/website/content/docs/v0.1/Guides/first-cluster.md
@@ -1,10 +1,9 @@
 ---
 description: "A guide for creating your first cluster with the Sidero management plane"
 weight: 2
+title: Creating Your First Cluster
 ---
 
-# Creating Your First Cluster
-
 ## Introduction
 
 This guide will detail the steps needed to provision your first bare metal Talos cluster after completing the bootstrap and pivot steps detailed in the previous guide.
@@ -30,7 +29,7 @@ kubectl patch deploy -n sidero-system sidero-controller-manager --type='json' -p
 Metadata Server:
 
 ```bash
-# Convert metadata server service to nodeport
+## Convert metadata server service to nodeport
 kubectl patch service -n sidero-system sidero-metadata-server --type='json' -p='[{"op": "replace", "path": "/spec/type", "value": "NodePort"}]'
 
 ## Set a known nodeport for metadata server

diff --git a/website/content/docs/v0.1/Guides/flow.md b/website/content/docs/v0.1/Guides/flow.md
@@ -1,10 +1,9 @@
 ---
 description: "Diagrams for various flows in Sidero."
 weight: 4
+title: Provisioning Flow
 ---
 
-# Provisioning Flow
-
 ```mermaid
 graph TD;
     Start(Start);

diff --git a/website/content/docs/v0.1/Guides/patching.md b/website/content/docs/v0.1/Guides/patching.md
@@ -1,10 +1,9 @@
 ---
 description: "A guide describing patching"
 weight: 3
+title: Patching
 ---
 
-# Patching
-
 Server resources can be updated by using the `configPatches` section of the custom resource.
 Any field of the [Talos machine config](https://www.talos.dev/docs/v0.8/reference/configuration/)
 can be overridden on a per-machine basis using this method.

diff --git a/website/content/docs/v0.1/index.md b/website/content/docs/v0.1/index.md
@@ -1,4 +1,6 @@
-# Documentation
+---
+title: "Welcome"
+---
 
 Welcome to the Sidero documentation.
 

diff --git a/website/content/docs/v0.2/Configuration/environments.md b/website/content/docs/v0.2/Configuration/environments.md
@@ -1,10 +1,9 @@
 ---
 description: ""
 weight: 1
+title: Environments
 ---
 
-# Environments
-
 Environments are a custom resource provided by the Metal Controller Manager.
 An environment is a codified description of what should be returned by the PXE server when a physical server attempts to PXE boot.
 

diff --git a/website/content/docs/v0.2/Configuration/metadata.md b/website/content/docs/v0.2/Configuration/metadata.md
@@ -1,10 +1,9 @@
 ---
 description: ""
 weight: 4
+title: Metadata
 ---
 
-# Metadata
-
 The Metadata server manages the Machine metadata.
 In terms of Talos (the OS on which the Kubernetes cluster is formed), this is the
 "[machine config](https://www.talos.dev/docs/v0.8/reference/configuration/)",

diff --git a/website/content/docs/v0.2/Configuration/serverclasses.md b/website/content/docs/v0.2/Configuration/serverclasses.md
@@ -1,10 +1,9 @@
 ---
 description: ""
 weight: 3
+title: Server Classes
 ---
 
-# Server Classes
-
 Server classes are a way to group distinct server resources.
 The "qualifiers" key allows the administrator to specify criteria upon which to group these servers.
 There are currently three keys: `cpu`, `systemInformation`, and `labelSelectors`.

diff --git a/website/content/docs/v0.2/Configuration/servers.md b/website/content/docs/v0.2/Configuration/servers.md
@@ -1,10 +1,9 @@
 ---
 description: ""
 weight: 2
+title: Servers
 ---
 
-# Servers
-
 Servers are the basic resource of bare metal in the Metal Controller Manager.
 These are created by PXE booting the servers and allowing them to send a registration request to the management plane.
 

diff --git a/website/content/docs/v0.2/Getting Started/architecture.md b/website/content/docs/v0.2/Getting Started/architecture.md
@@ -1,10 +1,9 @@
 ---
 description: ""
 weight: 3
+title: Architecture
 ---
 
-# Architecture
-
 The overarching architecture of Sidero centers around a "management plane".
 This plane is expected to serve as a single interface upon which administrators can create, scale, upgrade, and delete Kubernetes clusters.
 At a high level view, the management plane + created clusters should look something like:

diff --git a/website/content/docs/v0.2/Getting Started/installation.md b/website/content/docs/v0.2/Getting Started/installation.md
@@ -1,10 +1,9 @@
 ---
 description: ""
 weight: 2
+title: Installation
 ---
 
-# Installation
-
 As of Cluster API version 0.3.9, Sidero is included as a default infrastructure provider in clusterctl.
 
 To install Sidero and the other Talos providers, simply issue:

diff --git a/website/content/docs/v0.2/Getting Started/introduction.md b/website/content/docs/v0.2/Getting Started/introduction.md
@@ -1,10 +1,9 @@
 ---
 description: ""
 weight: 1
+title: Introduction
 ---
 
-# Introduction
-
 Sidero ("Iron" in Greek) is a project created by the [Talos Systems](https://www.talos-systems.com/) team.
 The goal of this project is to provide lightweight, composable tools that can be used to create bare-metal Talos + Kubernetes clusters.
 These tools are built around the Cluster API project.

diff --git a/website/content/docs/v0.2/Getting Started/resources.md b/website/content/docs/v0.2/Getting Started/resources.md
@@ -1,10 +1,9 @@
 ---
 description: ""
 weight: 4
+title: Resources
 ---
 
-# Resources
-
 Sidero, the Talos bootstrap/controlplane providers, and Cluster API each provide several custom resources (CRDs) to Kubernetes.
 These CRDs are crucial to understanding the connections between each provider and in troubleshooting problems.
 It may also help to look at the [cluster template](https://github.com/talos-systems/sidero/blob/master/templates/cluster-template.yaml) to get an idea of the relationships between these.

diff --git a/website/content/docs/v0.2/Guides/bootstrapping.md b/website/content/docs/v0.2/Guides/bootstrapping.md
@@ -1,10 +1,9 @@
 ---
 description: "A guide for bootstrapping Sidero management plane"
 weight: 1
+title: Bootstrapping
 ---
 
-# Bootstrapping
-
 ## Introduction
 
 Imagine a scenario in which you have shown up to a datacenter with only a laptop and your task is to transition a rack of bare metal machines into an HA management plane and multiple Kubernetes clusters created by that management plane.

diff --git a/website/content/docs/v0.2/Guides/first-cluster.md b/website/content/docs/v0.2/Guides/first-cluster.md
@@ -1,10 +1,9 @@
 ---
 description: "A guide for creating your first cluster with the Sidero management plane"
 weight: 2
+title: Creating Your First Cluster
 ---
 
-# Creating Your First Cluster
-
 ## Introduction
 
 This guide will detail the steps needed to provision your first bare metal Talos cluster after completing the bootstrap and pivot steps detailed in the previous guide.
@@ -30,7 +29,7 @@ kubectl patch deploy -n sidero-system sidero-controller-manager --type='json' -p
 Metadata Server:
 
 ```bash
-# Convert metadata server service to nodeport
+## Convert metadata server service to nodeport
 kubectl patch service -n sidero-system sidero-metadata-server --type='json' -p='[{"op": "replace", "path": "/spec/type", "value": "NodePort"}]'
 
 ## Set a known nodeport for metadata server

diff --git a/website/content/docs/v0.2/Guides/flow.md b/website/content/docs/v0.2/Guides/flow.md
@@ -1,10 +1,9 @@
 ---
 description: "Diagrams for various flows in Sidero."
 weight: 4
+title: Provisioning Flow
 ---
 
-# Provisioning Flow
-
 ```mermaid
 graph TD;
     Start(Start);

diff --git a/website/content/docs/v0.2/Guides/patching.md b/website/content/docs/v0.2/Guides/patching.md
@@ -1,10 +1,9 @@
 ---
 description: "A guide describing patching"
 weight: 3
+title: Patching
 ---
 
-# Patching
-
 Server resources can be updated by using the `configPatches` section of the custom resource.
 Any field of the [Talos machine config](https://www.talos.dev/docs/v0.8/reference/configuration/)
 can be overridden on a per-machine basis using this method.

diff --git a/website/content/docs/v0.2/Guides/upgrades.md b/website/content/docs/v0.2/Guides/upgrades.md
@@ -1,10 +1,9 @@
 ---
 description: "A guide describing upgrades"
 weight: 3
+title: Upgrading
 ---
 
-# Upgrading
-
 Upgrading a running workload cluster or management plane is the same process as describe in the Talos documentation.
 
 To upgrade the Talos OS, see [here](https://www.talos.dev/docs/v0.9/guides/upgrading-talos).

diff --git a/website/content/docs/v0.2/index.md b/website/content/docs/v0.2/index.md
@@ -1,4 +1,6 @@
-# Documentation
+---
+title: "Welcome"
+---
 
 Welcome to the Sidero documentation.
 

diff --git a/website/content/docs/v0.3/Configuration/environments.md b/website/content/docs/v0.3/Configuration/environments.md
@@ -1,10 +1,9 @@
 ---
 description: ""
 weight: 1
+title: Environments
 ---
 
-# Environments
-
 Environments are a custom resource provided by the Metal Controller Manager.
 An environment is a codified description of what should be returned by the PXE server when a physical server attempts to PXE boot.
 

diff --git a/website/content/docs/v0.3/Configuration/metadata.md b/website/content/docs/v0.3/Configuration/metadata.md
@@ -1,10 +1,9 @@
 ---
 description: ""
 weight: 4
+title: Metadata
 ---
 
-# Metadata
-
 The Metadata server manages the Machine metadata.
 In terms of Talos (the OS on which the Kubernetes cluster is formed), this is the
 "[machine config](https://www.talos.dev/docs/v0.10/reference/configuration/)",

diff --git a/website/content/docs/v0.3/Configuration/serverclasses.md b/website/content/docs/v0.3/Configuration/serverclasses.md
@@ -1,10 +1,9 @@
 ---
 description: ""
 weight: 3
+title: Server Classes
 ---
 
-# Server Classes
-
 Server classes are a way to group distinct server resources.
 The `qualifiers` and `selector` keys allow the administrator to specify criteria upon which to group these servers.
 If both of these keys are missing, the server class matches all servers that it is watching.

diff --git a/website/content/docs/v0.3/Configuration/servers.md b/website/content/docs/v0.3/Configuration/servers.md
@@ -1,10 +1,9 @@
 ---
 description: ""
 weight: 2
+title: Servers
 ---
 
-# Servers
-
 Servers are the basic resource of bare metal in the Metal Controller Manager.
 These are created by PXE booting the servers and allowing them to send a registration request to the management plane.
 

diff --git a/website/content/docs/v0.3/Getting Started/architecture.md b/website/content/docs/v0.3/Getting Started/architecture.md
@@ -1,10 +1,9 @@
 ---
 description: ""
 weight: 3
+title: "Architecture"
 ---
 
-# Architecture
-
 The overarching architecture of Sidero centers around a "management plane".
 This plane is expected to serve as a single interface upon which administrators can create, scale, upgrade, and delete Kubernetes clusters.
 At a high level view, the management plane + created clusters should look something like: