Skip to content
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.

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

Unified quickstart that uses Enterprise features #937

Open
wants to merge 37 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from 30 commits
Commits
Show all changes
37 commits
Select commit Hold shift + click to select a range
043ccf1
Single quickstart that uses Enterprise features
JakeSCahill Dec 20, 2024
2a3deea
Merge branch 'main' of https://github.com/redpanda-data/docs into DOC…
JakeSCahill Dec 20, 2024
32de465
Run tests
JakeSCahill Dec 20, 2024
2a030f4
Fix action
JakeSCahill Dec 20, 2024
081bfb0
Add back quickstart index
JakeSCahill Dec 20, 2024
be92178
Update TAR
JakeSCahill Dec 20, 2024
c41a6d4
Replace external URL with internal
JakeSCahill Dec 20, 2024
9f45509
Update minio password to avoid insecure password warnings
JakeSCahill Dec 20, 2024
030d248
Add details about the data transform
JakeSCahill Dec 20, 2024
05b0f1f
Merge branch 'main' into DOC-777
JakeSCahill Dec 20, 2024
f80c5e2
Remove disused file
JakeSCahill Dec 20, 2024
78fa148
Merge branch 'DOC-777' of https://github.com/redpanda-data/docs into …
JakeSCahill Dec 20, 2024
597be50
Merge branch 'main' into DOC-777
JakeSCahill Dec 26, 2024
10e9d24
Improve code comments
JakeSCahill Jan 6, 2025
8c99b9f
Merge branch 'main' of https://github.com/redpanda-data/docs into DOC…
JakeSCahill Jan 10, 2025
1e8bd4d
Use new extension that auto-archives the attachments
JakeSCahill Jan 10, 2025
44aeb77
Merge branch 'main' into DOC-777
JakeSCahill Jan 10, 2025
26272a3
Apply suggestions from code review
JakeSCahill Jan 16, 2025
2ff994c
Set caption to Windows users
JakeSCahill Jan 16, 2025
482d0a2
Apply suggestions from code review
JakeSCahill Jan 17, 2025
4cde042
Apply suggestions from review
JakeSCahill Jan 22, 2025
44d7378
Apply suggestions from code review
JakeSCahill Jan 22, 2025
0dce7ba
Apply suggestions from code review
JakeSCahill Jan 22, 2025
22e24b3
Apply suggestions from code review
JakeSCahill Jan 22, 2025
c27d588
Apply suggestions from code review
JakeSCahill Jan 23, 2025
5496f03
Apply feedback suggestions
JakeSCahill Jan 23, 2025
a5b7753
Merge branch 'DOC-777' of https://github.com/redpanda-data/docs into …
JakeSCahill Jan 23, 2025
52eb0b3
Apply suggestions from code review
JakeSCahill Jan 23, 2025
7f72717
Update modules/get-started/pages/quick-start.adoc
JakeSCahill Jan 23, 2025
6801990
Remove single broker
JakeSCahill Jan 28, 2025
ce125de
Merge branch 'main' into DOC-777
JakeSCahill Jan 29, 2025
06268d9
Upgrade Doc Detective
JakeSCahill Feb 4, 2025
b5ea8e7
Merge branch 'main' of https://github.com/redpanda-data/docs into DOC…
JakeSCahill Feb 4, 2025
baeb9bd
Use viewport width and height to fix false positives in CI tests that…
JakeSCahill Feb 4, 2025
4ef9999
Allow more variation in images
JakeSCahill Feb 4, 2025
248fa73
Add links to source
JakeSCahill Feb 4, 2025
f37de1b
Allow more variation in images
JakeSCahill Feb 4, 2025
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
20 changes: 5 additions & 15 deletions .github/workflows/test-docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -58,30 +58,20 @@ jobs:
if: ${{ github.event_name == 'workflow_dispatch' || github.event_name == 'repository_dispatch' }}
uses: doc-detective/github-action@v1
with:
input: ../modules
working_directory: redpanda-docs/setup-tests
input: ../../modules
working_directory: redpanda-docs/tests/setup-tests
exit_on_fail: true
# create a PR/issue only if the workflow wasn't already triggered by a PR
create_pr_on_change: true
create_issue_on_fail: true
token: ${{ env.ACTIONS_BOT_TOKEN }}

- name: Test Redpanda Console docs
if: needs.setup.outputs.console == 'true'
uses: doc-detective/github-action@v1
with:
input: ../modules/console
working_directory: redpanda-docs/setup-tests
exit_on_fail: true
env:
REDPANDA_GITHUB_TOKEN: ${{ env.ACTIONS_BOT_TOKEN }}

- name: Test Redpanda Self-Managed quickstart
if: needs.setup.outputs.quickstart == 'true'
if: ${{ needs.setup.outputs.quickstart == 'true' || needs.setup.outputs.console == 'true' }}
uses: doc-detective/github-action@v1
with:
input: ../modules/get-started/pages/quick-start.adoc
working_directory: redpanda-docs/setup-tests
input: ../../modules/get-started/pages/quick-start.adoc
working_directory: redpanda-docs/tests/setup-tests
exit_on_fail: true
env:
REDPANDA_GITHUB_TOKEN: ${{ env.ACTIONS_BOT_TOKEN }}
Expand Down
23 changes: 19 additions & 4 deletions local-antora-playbook.yml
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,9 @@ antora:
extensions:
- require: '@redpanda-data/docs-extensions-and-macros/extensions/generate-rp-connect-info'
- require: '@redpanda-data/docs-extensions-and-macros/extensions/unpublish-pages'
- require: '@redpanda-data/docs-extensions-and-macros/extensions/add-global-attributes'
- require: '@redpanda-data/docs-extensions-and-macros/extensions/version-fetcher/set-latest-version'
- require: '@redpanda-data/docs-extensions-and-macros/extensions/validate-attributes'
- require: '@redpanda-data/docs-extensions-and-macros/extensions/generate-index-data'
data:
sets:
Expand All @@ -49,14 +52,26 @@ antora:
filter: docker-compose
env_type: Docker
attribute_name: docker-labs-index
- require: '@redpanda-data/docs-extensions-and-macros/extensions/archive-attachments'
data:
archives:
- component: 'ROOT'
output_archive: 'redpanda-quickstart.tar.gz'
file_patterns:
- '**/test-resources/**/docker-compose/**'
- require: '@redpanda-data/docs-extensions-and-macros/extensions/replace-attributes-in-attachments'
data:
replacements:
- components:
- 'ROOT'
- 'redpanda-labs'
file_patterns:
- '**/docker-compose.yaml'
- '**/docker-compose.yml'
- require: '@redpanda-data/docs-extensions-and-macros/extensions/collect-bloblang-samples'
- require: '@redpanda-data/docs-extensions-and-macros/extensions/generate-rp-connect-categories'
- require: '@redpanda-data/docs-extensions-and-macros/extensions/modify-redirects'
- require: '@redpanda-data/docs-extensions-and-macros/extensions/unlisted-pages'
- require: '@redpanda-data/docs-extensions-and-macros/extensions/add-global-attributes'
- require: '@redpanda-data/docs-extensions-and-macros/extensions/version-fetcher/set-latest-version'
- require: '@redpanda-data/docs-extensions-and-macros/extensions/replace-attributes-in-attachments'
- require: '@redpanda-data/docs-extensions-and-macros/extensions/validate-attributes'
- require: '@redpanda-data/docs-extensions-and-macros/extensions/find-related-docs'
- require: '@redpanda-data/docs-extensions-and-macros/extensions/find-related-labs'
- require: '@redpanda-data/docs-extensions-and-macros/extensions/aggregate-terms'
1 change: 0 additions & 1 deletion modules/ROOT/nav.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,6 @@
** xref:get-started:install-beta.adoc[Install Beta]
** xref:get-started:quickstarts.adoc[Quickstarts]
*** xref:get-started:quick-start.adoc[Redpanda Self-Managed]
*** xref:console:quickstart.adoc[Redpanda Console]
*** xref:get-started:docker-compose-labs.adoc[Docker Compose Labs]
** xref:get-started:licensing/index.adoc[Redpanda Licensing]
*** xref:get-started:licensing/overview.adoc[Editions and Enterprise Features]
Expand Down
1 change: 0 additions & 1 deletion modules/console/attachments/bootstrap.yml

This file was deleted.

1 change: 0 additions & 1 deletion modules/console/attachments/docker-compose.yml

This file was deleted.

1 change: 0 additions & 1 deletion modules/console/attachments/transactions-schema.json

This file was deleted.

Binary file modified modules/console/images/broker-overview.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added modules/console/images/degraded-cluster.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified modules/console/images/js-filter.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified modules/console/images/license.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified modules/console/images/overview.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified modules/console/images/schema-reg.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified modules/console/images/topic-documentation.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified modules/console/images/topic.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added modules/console/images/transforms.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified modules/console/images/user.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion modules/console/pages/index.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -60,4 +60,4 @@ Redpanda Console is designed for:

== Next steps

xref:console:quickstart.adoc[Get started]
xref:get-started:quick-start.adoc[Get started]
Loading