Unified quickstart that uses Enterprise features (#937)

Co-authored-by: Michele Cyran <[email protected]>

Author: JakeSCahill

.github/workflows/test-docs.yml

@@ -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 }}

local-antora-playbook.yml

@@ -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:
@@ -49,6 +52,22 @@ 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: '@sntke/antora-mermaid-extension'
     mermaid_library_url: https://cdn.jsdelivr.net/npm/mermaid@10/dist/mermaid.esm.min.mjs
     script_stem: mermaid-scripts
@@ -62,18 +81,6 @@ antora:
   - 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'
-    data:
-      replacements:
-        - components:
-            - 'ROOT'
-            - 'redpanda-labs'
-          file_patterns:
-            - '**/docker-compose.yaml'
-            - '**/docker-compose.yml'
-  - 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'

modules/ROOT/nav.adoc

@@ -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:rpk-quickstart.adoc[]
 *** xref:get-started:docker-compose-labs.adoc[Docker Compose Labs]
 ** xref:get-started:licensing/index.adoc[Redpanda Licensing]

modules/console/attachments/bootstrap.yml

@@ -4,9 +4,9 @@
 
 Redpanda Console loads configuration properties from three sources, in the following order of precedence:
 
-* Environment variables
-* YAML file configuration (recommended)
-* Command-line arguments
+. Environment variables
+. YAML file configuration (recommended)
+. Command-line arguments
 
 Environment variables and YAML configurations can overwrite input that is set on the command line.
 
@@ -18,7 +18,7 @@ A reference configuration file is provided under <<Example Redpanda Console conf
 
 In Linux package installations, this file is located in `/etc/redpanda/redpanda-console-config.yaml` by default and Redpanda Console is configured to read from this file path.
 
-In containerized environments, you must ensure that the configuration file is mounted to a directory accessible by the Redpanda Console container. When the file is mounted, you can specify its file path using the `-config.filepath` flag or the `CONFIG_FILEPATH` environment variable.
+In containerized environments, ensure that the configuration file is mounted to a directory accessible by the Redpanda Console container. When the file is mounted, you can specify its file path using the `-config.filepath` flag or the `CONFIG_FILEPATH` environment variable.
 
 == Environment variables
 
@@ -46,7 +46,28 @@ KAFKA_BROKERS=redpanda-0:9092,redpanda-1:9092,redpanda-2:9092
 NOTE: You cannot use environment variables to configure object arrays, such as the configuration
 for Kafka Connect clusters. In this case, use a YAML file, and provide secrets using environment variables or command line arguments.
 
-== Example Redpanda Console configuration file
+== Docker Compose example
+
+If you are using Docker Compose, you can mount the configuration file and set the environment variable in your `docker-compose.yml` file:
+
+```yaml
+console:
+    container_name: redpanda-console
+    image: docker.redpanda.com/redpandadata/console:latest
+    entrypoint: /bin/sh
+    command: -c 'echo "$$CONSOLE_CONFIG_FILE" > /tmp/config.yml
+    volumes:
+      - ./config:/tmp/config/
+    environment:
+      CONFIG_FILEPATH: ${CONFIG_FILEPATH:-/tmp/config.yml}
+      CONSOLE_CONFIG_FILE: |
+        # Configure a connection to the Redpanda cluster
+        # See https://docs.redpanda.com/current/console/config/connect-to-redpanda/
+        kafka:
+          brokers: ["redpanda-0:9092","redpanda-1:9092","redpanda-2:9092"]
+```
+
+== Complete configuration file example
 
 The following YAML file contains a complete list of all Redpanda Console configuration properties and their descriptions. All values are default values.
 

modules/console/attachments/docker-compose.yml

@@ -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]