Skip to content

Commit 204da32

Browse files
JakeSCahillFeediver1micheleRPvbotbuildovich
authored
Add index page for all Docker Compose labs (#915)
Co-authored-by: Joyce Fee <[email protected]> Co-authored-by: Michele Cyran <[email protected]> Co-authored-by: vbotbuildovich <[email protected]>
1 parent b09116a commit 204da32

File tree

3 files changed

+28
-0
lines changed

3 files changed

+28
-0
lines changed

local-antora-playbook.yml

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -40,6 +40,15 @@ antora:
4040
extensions:
4141
- require: '@redpanda-data/docs-extensions-and-macros/extensions/generate-rp-connect-info'
4242
- require: '@redpanda-data/docs-extensions-and-macros/extensions/unpublish-pages'
43+
- require: '@redpanda-data/docs-extensions-and-macros/extensions/generate-index-data'
44+
data:
45+
sets:
46+
docker_labs:
47+
component: redpanda-labs
48+
family: page
49+
filter: docker-compose
50+
env_type: Docker
51+
attribute_name: docker-labs-index
4352
- require: '@redpanda-data/docs-extensions-and-macros/extensions/collect-bloblang-samples'
4453
- require: '@redpanda-data/docs-extensions-and-macros/extensions/generate-rp-connect-categories'
4554
- require: '@redpanda-data/docs-extensions-and-macros/extensions/modify-redirects'

modules/ROOT/nav.adoc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@
88
** xref:get-started:quickstarts.adoc[Quickstarts]
99
*** xref:get-started:quick-start.adoc[Redpanda Self-Managed]
1010
*** xref:console:quickstart.adoc[Redpanda Console]
11+
*** xref:get-started:docker-compose-labs.adoc[Docker Compose Labs]
1112
** xref:get-started:licensing/index.adoc[Redpanda Licensing]
1213
*** xref:get-started:licensing/overview.adoc[Editions and Enterprise Features]
1314
*** xref:get-started:licensing/add-license-redpanda/index.adoc[Add License]
Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
= Docker Compose Labs
2+
:page-index-data: docker-labs-index
3+
:page-role: index-list
4+
:description: Explore this collection of hands-on labs for deploying and testing Redpanda Self-Managed using Docker Compose. Whether you're a beginner looking to get started or an experienced user aiming to deepen your knowledge, these labs provide step-by-step instructions and practical examples to enhance your skills.
5+
6+
{description}
7+
8+
// This page looks empty because the list of labs isn't hardcoded here.
9+
// Instead, the `generate-index-data` extension dynamically gathers all Docker Compose labs
10+
// from the `redpanda-labs` component during the Antora build process.
11+
// It then assigns the resulting JSON data to the `docker-labs-index` attribute.
12+
//
13+
// The UI template checks the `:index-data:` attribute on this page and includes a predefined partial
14+
// that transforms this JSON data into a rendered list of links and descriptions.
15+
//
16+
// As a result, you define the role and index-data attribute here, and the extension/UI
17+
// handle the rest. This approach keeps the source clean and easy to maintain,
18+
// even as the number of labs grows or changes over time.

0 commit comments

Comments
 (0)