Skip to content

Commit d404e40

Browse files
authored
Remove level 1 headers from docs as it duplicates title frontmatter (#14)
Signed-off-by: Thomas Cooper <code@tomcooper.dev>
1 parent d2a9b99 commit d404e40

11 files changed

Lines changed: 3 additions & 25 deletions

docs/_index.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,6 @@ weight = 0
66
type = 'docs'
77
+++
88

9-
# Developer Quick-Start
10-
119
Please make sure you have all the [prerequisites](prerequisites.md) covered first.
1210
Then you can deploy a complete, open-source, event-streaming stack on your local Kubernetes cluster (e.g. MiniKube, KIND) with a single command:
1311

docs/accessing-services.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,6 @@ title = 'Accessing Services'
33
weight = 3
44
+++
55

6-
# Accessing Services
7-
86
## StreamsHub Console
97

108
### Ingress Access

docs/architecture.md

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,6 @@ title = 'Architecture'
33
weight = 6
44
+++
55

6-
# Architecture
7-
86
## Two-Phase Deployment
97

108
The event stack is deployed in two sequential phases:
@@ -17,9 +15,9 @@ Operators must be running to process these resources.
1715

1816
This separation exists for three reasons:
1917

20-
1. **CRD registration** — Kubernetes must register CRDs before it can accept custom resources of that type
21-
2. **Operator readiness** — operators must be running to reconcile their custom resources
22-
3. **Safe teardown** — during uninstall, operands are deleted first while operators are still alive to process finalizers
18+
1. CRD registration — Kubernetes must register CRDs before it can accept custom resources of that type
19+
2. Operator readiness — operators must be running to reconcile their custom resources
20+
3. Safe teardown — during uninstall, operands are deleted first while operators are still alive to process finalizers
2321

2422
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.
2523

docs/installation.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,6 @@ title = 'Installation'
33
weight = 2
44
+++
55

6-
# Installation
7-
86
## Quick-Start Install
97

108
Deploy the entire core stack with a single command:

docs/overlays/_index.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,6 @@ title = 'Overlays'
33
weight = 4
44
+++
55

6-
# Overlays
7-
86
The developer quick-start uses [Kustomize overlays](architecture.md) to provide optional extensions on top of the core stack.
97
Each overlay adds components that integrate with the base deployment.
108

docs/overlays/core.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,6 @@ cpu_total = '3 CPU cores'
55
memory_total = '4.5 GiB'
66
+++
77

8-
# Core Overlay
9-
108
The core overlay is the default deployment.
119
It installs the base event-streaming stack without any optional extensions.
1210

docs/overlays/developing.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,6 @@ title = 'Developing Overlays'
33
weight = 100
44
+++
55

6-
# Developing Overlays
7-
86
This page covers the requirements for adding or modifying overlays.
97
CI enforces various checks on the overlays automatically on every pull request.
108

docs/overlays/metrics.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,6 @@ cpu_total = '3 CPU cores'
55
memory_total = '5.5 GiB'
66
+++
77

8-
# Metrics Overlay
9-
108
The metrics overlay extends the core stack with Prometheus-based monitoring.
119

1210
## Quick-Start Install

docs/prerequisites.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,6 @@ title = 'Prerequisites'
33
weight = 1
44
+++
55

6-
# Prerequisites
7-
86
## Required
97

108
- **kubectl v1.27 or later** — the install scripts use Kustomize v5.0 features (the `labels` transformer) which require kubectl 1.27+.

docs/troubleshooting.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,6 @@ title = 'Troubleshooting'
33
weight = 7
44
+++
55

6-
# Troubleshooting
7-
86
## Operator Not Becoming Ready
97

108
If an operator deployment does not reach `Ready`/`Available` within the timeout:

0 commit comments

Comments
 (0)