From a31de4c280ab4f3d37b57d05356f1bd5fb99e477 Mon Sep 17 00:00:00 2001 From: Thomas Cooper Date: Wed, 15 Apr 2026 17:23:26 +0100 Subject: [PATCH] Remove level 1 headers from docs as it duplicates title frontmatter Signed-off-by: Thomas Cooper --- docs/_index.md | 2 -- docs/accessing-services.md | 2 -- docs/architecture.md | 8 +++----- docs/installation.md | 2 -- docs/overlays/_index.md | 2 -- docs/overlays/core.md | 2 -- docs/overlays/developing.md | 2 -- docs/overlays/metrics.md | 2 -- docs/prerequisites.md | 2 -- docs/troubleshooting.md | 2 -- docs/uninstallation.md | 2 -- 11 files changed, 3 insertions(+), 25 deletions(-) diff --git a/docs/_index.md b/docs/_index.md index 083c137..1ae1cb5 100644 --- a/docs/_index.md +++ b/docs/_index.md @@ -6,8 +6,6 @@ weight = 0 type = 'docs' +++ -# Developer Quick-Start - Please make sure you have all the [prerequisites](prerequisites.md) covered first. Then you can deploy a complete, open-source, event-streaming stack on your local Kubernetes cluster (e.g. MiniKube, KIND) with a single command: diff --git a/docs/accessing-services.md b/docs/accessing-services.md index b5ba59d..ab58b38 100644 --- a/docs/accessing-services.md +++ b/docs/accessing-services.md @@ -3,8 +3,6 @@ title = 'Accessing Services' weight = 3 +++ -# Accessing Services - ## StreamsHub Console ### Ingress Access diff --git a/docs/architecture.md b/docs/architecture.md index 21527ec..e2ef5bd 100644 --- a/docs/architecture.md +++ b/docs/architecture.md @@ -3,8 +3,6 @@ title = 'Architecture' weight = 6 +++ -# Architecture - ## Two-Phase Deployment The event stack is deployed in two sequential phases: @@ -17,9 +15,9 @@ Operators must be running to process these resources. This separation exists for three reasons: -1. **CRD registration** — Kubernetes must register CRDs before it can accept custom resources of that type -2. **Operator readiness** — operators must be running to reconcile their custom resources -3. **Safe teardown** — during uninstall, operands are deleted first while operators are still alive to process finalizers +1. CRD registration — Kubernetes must register CRDs before it can accept custom resources of that type +2. Operator readiness — operators must be running to reconcile their custom resources +3. Safe teardown — during uninstall, operands are deleted first while operators are still alive to process finalizers The install script uses `kubectl apply --server-side` for Phase 1 to handle large CRDs (such as those from the Prometheus Operator) that exceed the annotation size limit used by client-side apply. diff --git a/docs/installation.md b/docs/installation.md index 529ade0..c74e0ad 100644 --- a/docs/installation.md +++ b/docs/installation.md @@ -3,8 +3,6 @@ title = 'Installation' weight = 2 +++ -# Installation - ## Quick-Start Install Deploy the entire core stack with a single command: diff --git a/docs/overlays/_index.md b/docs/overlays/_index.md index aca8c7c..737a438 100644 --- a/docs/overlays/_index.md +++ b/docs/overlays/_index.md @@ -3,8 +3,6 @@ title = 'Overlays' weight = 4 +++ -# Overlays - The developer quick-start uses [Kustomize overlays](architecture.md) to provide optional extensions on top of the core stack. Each overlay adds components that integrate with the base deployment. diff --git a/docs/overlays/core.md b/docs/overlays/core.md index 7fd3feb..6f99a5f 100644 --- a/docs/overlays/core.md +++ b/docs/overlays/core.md @@ -5,8 +5,6 @@ cpu_total = '3 CPU cores' memory_total = '4.5 GiB' +++ -# Core Overlay - The core overlay is the default deployment. It installs the base event-streaming stack without any optional extensions. diff --git a/docs/overlays/developing.md b/docs/overlays/developing.md index 5efebea..7a0276f 100644 --- a/docs/overlays/developing.md +++ b/docs/overlays/developing.md @@ -3,8 +3,6 @@ title = 'Developing Overlays' weight = 100 +++ -# Developing Overlays - This page covers the requirements for adding or modifying overlays. CI enforces various checks on the overlays automatically on every pull request. diff --git a/docs/overlays/metrics.md b/docs/overlays/metrics.md index f3917a8..50be009 100644 --- a/docs/overlays/metrics.md +++ b/docs/overlays/metrics.md @@ -5,8 +5,6 @@ cpu_total = '3 CPU cores' memory_total = '5.5 GiB' +++ -# Metrics Overlay - The metrics overlay extends the core stack with Prometheus-based monitoring. ## Quick-Start Install diff --git a/docs/prerequisites.md b/docs/prerequisites.md index af50bc2..87b0ddd 100644 --- a/docs/prerequisites.md +++ b/docs/prerequisites.md @@ -3,8 +3,6 @@ title = 'Prerequisites' weight = 1 +++ -# Prerequisites - ## Required - **kubectl v1.27 or later** — the install scripts use Kustomize v5.0 features (the `labels` transformer) which require kubectl 1.27+. diff --git a/docs/troubleshooting.md b/docs/troubleshooting.md index 804617a..40118d6 100644 --- a/docs/troubleshooting.md +++ b/docs/troubleshooting.md @@ -3,8 +3,6 @@ title = 'Troubleshooting' weight = 7 +++ -# Troubleshooting - ## Operator Not Becoming Ready If an operator deployment does not reach `Ready`/`Available` within the timeout: diff --git a/docs/uninstallation.md b/docs/uninstallation.md index 7d15a8c..837bbd1 100644 --- a/docs/uninstallation.md +++ b/docs/uninstallation.md @@ -3,8 +3,6 @@ title = 'Uninstallation' weight = 5 +++ -# Uninstallation - ## Using the Uninstall Script The uninstall script provides safe teardown with shared-cluster awareness: