Skip to content

Commit f5404b2

Browse files
Unified quickstart that uses Enterprise features (#937)
Co-authored-by: Michele Cyran <[email protected]>
1 parent 1ca009e commit f5404b2

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

53 files changed

+4550
-5434
lines changed

.github/workflows/test-docs.yml

Lines changed: 5 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -58,30 +58,20 @@ jobs:
5858
if: ${{ github.event_name == 'workflow_dispatch' || github.event_name == 'repository_dispatch' }}
5959
uses: doc-detective/github-action@v1
6060
with:
61-
input: ../modules
62-
working_directory: redpanda-docs/setup-tests
61+
input: ../../modules
62+
working_directory: redpanda-docs/tests/setup-tests
6363
exit_on_fail: true
6464
# create a PR/issue only if the workflow wasn't already triggered by a PR
6565
create_pr_on_change: true
6666
create_issue_on_fail: true
6767
token: ${{ env.ACTIONS_BOT_TOKEN }}
6868

69-
- name: Test Redpanda Console docs
70-
if: needs.setup.outputs.console == 'true'
71-
uses: doc-detective/github-action@v1
72-
with:
73-
input: ../modules/console
74-
working_directory: redpanda-docs/setup-tests
75-
exit_on_fail: true
76-
env:
77-
REDPANDA_GITHUB_TOKEN: ${{ env.ACTIONS_BOT_TOKEN }}
78-
7969
- name: Test Redpanda Self-Managed quickstart
80-
if: needs.setup.outputs.quickstart == 'true'
70+
if: ${{ needs.setup.outputs.quickstart == 'true' || needs.setup.outputs.console == 'true' }}
8171
uses: doc-detective/github-action@v1
8272
with:
83-
input: ../modules/get-started/pages/quick-start.adoc
84-
working_directory: redpanda-docs/setup-tests
73+
input: ../../modules/get-started/pages/quick-start.adoc
74+
working_directory: redpanda-docs/tests/setup-tests
8575
exit_on_fail: true
8676
env:
8777
REDPANDA_GITHUB_TOKEN: ${{ env.ACTIONS_BOT_TOKEN }}

local-antora-playbook.yml

Lines changed: 19 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -40,6 +40,9 @@ 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/add-global-attributes'
44+
- require: '@redpanda-data/docs-extensions-and-macros/extensions/version-fetcher/set-latest-version'
45+
- require: '@redpanda-data/docs-extensions-and-macros/extensions/validate-attributes'
4346
- require: '@redpanda-data/docs-extensions-and-macros/extensions/generate-index-data'
4447
data:
4548
sets:
@@ -49,6 +52,22 @@ antora:
4952
filter: docker-compose
5053
env_type: Docker
5154
attribute_name: docker-labs-index
55+
- require: '@redpanda-data/docs-extensions-and-macros/extensions/archive-attachments'
56+
data:
57+
archives:
58+
- component: 'ROOT'
59+
output_archive: 'redpanda-quickstart.tar.gz'
60+
file_patterns:
61+
- '**/test-resources/**/docker-compose/**'
62+
- require: '@redpanda-data/docs-extensions-and-macros/extensions/replace-attributes-in-attachments'
63+
data:
64+
replacements:
65+
- components:
66+
- 'ROOT'
67+
- 'redpanda-labs'
68+
file_patterns:
69+
- '**/docker-compose.yaml'
70+
- '**/docker-compose.yml'
5271
- require: '@sntke/antora-mermaid-extension'
5372
mermaid_library_url: https://cdn.jsdelivr.net/npm/mermaid@10/dist/mermaid.esm.min.mjs
5473
script_stem: mermaid-scripts
@@ -62,18 +81,6 @@ antora:
6281
- require: '@redpanda-data/docs-extensions-and-macros/extensions/generate-rp-connect-categories'
6382
- require: '@redpanda-data/docs-extensions-and-macros/extensions/modify-redirects'
6483
- require: '@redpanda-data/docs-extensions-and-macros/extensions/unlisted-pages'
65-
- require: '@redpanda-data/docs-extensions-and-macros/extensions/add-global-attributes'
66-
- require: '@redpanda-data/docs-extensions-and-macros/extensions/version-fetcher/set-latest-version'
67-
- require: '@redpanda-data/docs-extensions-and-macros/extensions/replace-attributes-in-attachments'
68-
data:
69-
replacements:
70-
- components:
71-
- 'ROOT'
72-
- 'redpanda-labs'
73-
file_patterns:
74-
- '**/docker-compose.yaml'
75-
- '**/docker-compose.yml'
76-
- require: '@redpanda-data/docs-extensions-and-macros/extensions/validate-attributes'
7784
- require: '@redpanda-data/docs-extensions-and-macros/extensions/find-related-docs'
7885
- require: '@redpanda-data/docs-extensions-and-macros/extensions/find-related-labs'
7986
- require: '@redpanda-data/docs-extensions-and-macros/extensions/aggregate-terms'

modules/ROOT/nav.adoc

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,6 @@
77
** xref:get-started:install-beta.adoc[Install Beta]
88
** xref:get-started:quickstarts.adoc[Quickstarts]
99
*** xref:get-started:quick-start.adoc[Redpanda Self-Managed]
10-
*** xref:console:quickstart.adoc[Redpanda Console]
1110
*** xref:get-started:rpk-quickstart.adoc[]
1211
*** xref:get-started:docker-compose-labs.adoc[Docker Compose Labs]
1312
** xref:get-started:licensing/index.adoc[Redpanda Licensing]

modules/console/attachments/bootstrap.yml

Lines changed: 0 additions & 1 deletion
This file was deleted.

modules/console/attachments/docker-compose.yml

Lines changed: 0 additions & 1 deletion
This file was deleted.

modules/console/attachments/transactions-schema.json

Lines changed: 0 additions & 1 deletion
This file was deleted.
141 KB
Loading
31.8 KB
Loading
142 KB
Loading
42.6 KB
Loading

0 commit comments

Comments
 (0)