Skip to content

Commit d2742fe

Browse files
authored
Update the overlay docs index page to properly link to the overlay pages (#19)
Signed-off-by: Thomas Cooper <code@tomcooper.dev>
1 parent 327403c commit d2742fe

1 file changed

Lines changed: 10 additions & 4 deletions

File tree

docs/overlays/_index.md

Lines changed: 10 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,13 @@ curl -sL https://raw.githubusercontent.com/streamshub/developer-quickstart/main/
2020

2121
## Available Overlays
2222

23-
| Overlay | Description |
24-
|-----------------------|--------------------------------------------------------------------------------------------------------------------------------------|
25-
| [core](core.md) | The default stack: Strimzi, Kafka, Apicurio Registry, and StreamsHub Console. No `OVERLAY` variable needed. |
26-
| [metrics](metrics.md) | Adds Prometheus Operator, a Prometheus instance, and Kafka metrics collection via PodMonitors. Wires the Console to display metrics. |
23+
| Overlay | Description |
24+
|---------------------------------|--------------------------------------------------------------------------------------------------------------------------------------|
25+
| [core](core.md) | The default stack: Strimzi, Kafka, Apicurio Registry, and StreamsHub Console. No `OVERLAY` variable needed. |
26+
| [metrics](metrics.md) | Adds Prometheus Operator, a Prometheus instance, and Kafka metrics collection via PodMonitors. Wires the Console to display metrics. |
27+
| [mcp](mcp.md) | Adds the StreamsHub MCP server, giving AI assistants read-only access to the Strimzi-managed Kafka cluster. |
28+
| [mcp-metrics](mcp-metrics.md) | Combines Prometheus monitoring with the StreamsHub MCP server. The MCP server uses Prometheus as its centralized metrics provider. |
29+
30+
## Developing Overlays
31+
32+
See [Developing Overlays](developing.md) for the directory structure, resource limit requirements, and CI checks that apply when adding or modifying overlays.

0 commit comments

Comments
 (0)