Skip to content

Update the overlay docs index page to properly link to the overlay pages #19

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
tomncooper merged 1 commit into from
Aug 13, 2026
Merged

Update the overlay docs index page to properly link to the overlay pages #19

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 10 additions & 4 deletions docs/overlays/_index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,13 @@ curl -sL https://raw.githubusercontent.com/streamshub/developer-quickstart/main/

## Available Overlays

| Overlay | Description |
|-----------------------|--------------------------------------------------------------------------------------------------------------------------------------|
| [core](core.md) | The default stack: Strimzi, Kafka, Apicurio Registry, and StreamsHub Console. No `OVERLAY` variable needed. |
| [metrics](metrics.md) | Adds Prometheus Operator, a Prometheus instance, and Kafka metrics collection via PodMonitors. Wires the Console to display metrics. |
| Overlay | Description |
|---------------------------------|--------------------------------------------------------------------------------------------------------------------------------------|
| [core](core.md) | The default stack: Strimzi, Kafka, Apicurio Registry, and StreamsHub Console. No `OVERLAY` variable needed. |
| [metrics](metrics.md) | Adds Prometheus Operator, a Prometheus instance, and Kafka metrics collection via PodMonitors. Wires the Console to display metrics. |
| [mcp](mcp.md) | Adds the StreamsHub MCP server, giving AI assistants read-only access to the Strimzi-managed Kafka cluster. |
| [mcp-metrics](mcp-metrics.md) | Combines Prometheus monitoring with the StreamsHub MCP server. The MCP server uses Prometheus as its centralized metrics provider. |

## Developing Overlays

See [Developing Overlays](developing.md) for the directory structure, resource limit requirements, and CI checks that apply when adding or modifying overlays.
Loading