Doc 686 Add initial docs for how to use the Connect Helm chart (#89)

Author: JakeSCahill

.github/workflows/generate-helm-spec.yml

@@ -0,0 +1,93 @@
+---
+  name: Generate Helm Spec Docs
+  on:
+    repository_dispatch:  # Allows other repositories to trigger this workflow
+      types: [generate-helm-spec-docs]
+    workflow_dispatch:  # Allows manual trigger of the workflow
+  jobs:
+    trigger:
+      runs-on: ubuntu-latest
+      permissions:
+        id-token: write
+        contents: read
+      steps:
+        - uses: aws-actions/configure-aws-credentials@v4
+          with:
+            aws-region: ${{ vars.RP_AWS_CRED_REGION }}
+            role-to-assume: arn:aws:iam::${{ secrets.RP_AWS_CRED_ACCOUNT_ID }}:role/${{ vars.RP_AWS_CRED_BASE_ROLE_NAME }}${{ github.event.repository.name }}
+        - uses: aws-actions/aws-secretsmanager-get-secrets@v2
+          with:
+            secret-ids: |
+              ,sdlc/prod/github/actions_bot_token
+            parse-json-secrets: true
+        # Download the helm-docs tool which generates documentation from Helm charts.
+        - name: Download helm-docs
+          run: |
+            curl -sL https://github.com/norwoodj/helm-docs/releases/download/v1.14.2/helm-docs_1.14.2_Linux_x86_64.tar.gz | tar xz
+        # Add the helm-docs tool to the system's PATH for easy access.
+        - name: Add helm-docs to $PATH
+          run: |
+            echo "helm-docs" >> $GITHUB_PATH
+            sudo mv helm-docs /usr/local/bin/
+        # Checkout the main branch of the helm-charts repository.
+        - name: Checkout helm-charts repository
+          uses: actions/checkout@v4
+          with:
+            repository: redpanda-data/helm-charts
+            ref: main
+            path: helm-charts
+            token: ${{ env.ACTIONS_BOT_TOKEN }}
+        # Generate the Helm documentation using the helm-docs tool.
+        - name: Generate Helm docs
+          run: |
+            helm-docs
+          working-directory: ./helm-charts
+        # Install pandoc, a tool to convert between different markup formats.
+        - name: Install pandoc
+          run: |
+            sudo apt-get install pandoc
+        # Checkout the main branch of the redpanda-docs repository.
+        - name: Checkout documentation repository
+          uses: actions/checkout@v4
+          with:
+            repository: redpanda-data/rp-connect-docs
+            ref: main
+            path: redpanda-docs
+            token: ${{ env.ACTIONS_BOT_TOKEN }}
+        # Convert the generated Markdown Helm documentation to AsciiDoc format using pandoc.
+        - name: Convert Markdown to AsciiDoc
+          run: |
+            pandoc ./helm-charts/charts/connect/README.md -t asciidoc -o ./redpanda-docs/modules/reference/pages/k-connect-helm-spec.adoc
+        - name: Modify third-level headings format
+          run: |
+            sed -i 's/\(\[[0-9]*\)\]\./\1\\]\./g' ./redpanda-docs/modules/reference/pages/k-connect-helm-spec.adoc
+            sed -i 's/=== \(http\([^[]\|\%5[BbDd]\)*\)\[\([^]]*\)\]/=== link:++\1++\[\3\]/' ./redpanda-docs/modules/reference/pages/k-connect-helm-spec.adoc
+        - name: Correct AsciiDoc format
+          run: |
+            # Correct the title format
+            sed -i 's/^== # \(.*\)/= \1/' ./redpanda-docs/modules/reference/pages/k-connect-helm-spec.adoc
+            # Correct the description format
+            sed -i 's/^== description: \(.*\)/:description: \1/' ./redpanda-docs/modules/reference/pages/k-connect-helm-spec.adoc
+        # Check if any changes were made in the documentation.
+        - name: Check if changes were made
+          id: check_changes
+          run: |
+            cd ./redpanda-docs
+            changes=$(git status --porcelain)
+            if [ -z "$changes" ]; then
+              echo "has_changes=false" >> $GITHUB_ENV
+            else
+              echo "has_changes=true" >> $GITHUB_ENV
+            fi
+        # If changes were detected, commit those changes.
+        - name: Commit changes
+          if: env.has_changes == 'true'
+          run: |
+            cd ./redpanda-docs
+            git config --global user.email "[email protected]"
+            git config --global user.name "vbotbuildovich"
+            git add modules/reference/*
+            git commit -m "auto-docs: Update Helm spec"
+            git push origin main
+          env:
+            ACCESS_TOKEN: ${{ env.ACTIONS_BOT_TOKEN }}

antora.yml

@@ -1,7 +1,7 @@
 name: redpanda-connect
 title: Connect
 version: ~
-start_page: ROOT:about.adoc
+start_page: get-started:about.adoc
 nav:
 - modules/ROOT/nav.adoc
 asciidoc:

local-antora-playbook.yml

@@ -1,6 +1,6 @@
 site:
   title: Redpanda Docs
-  start_page: redpanda-connect:ROOT:about.adoc
+  start_page: redpanda-connect:get-started:about.adoc
   url: http://localhost:5002
   robots: disallow
 urls:

modules/ROOT/nav.adoc

@@ -1,5 +1,10 @@
-* xref:about.adoc[]
-** xref:whats_new_rpcn.adoc[]
+
+* xref:get-started:index.adoc[Get Started]
+** xref:get-started:about.adoc[]
+** xref:get-started:whats-new.adoc[What's New]
+** xref:get-started:quickstarts/index.adoc[Quickstarts]
+*** xref:get-started:quickstarts/rpk.adoc[CLI]
+*** xref:get-started:quickstarts/helm-chart.adoc[Helm Chart]
 
 * xref:configuration:about.adoc[]
 ** xref:configuration:resources.adoc[]
@@ -295,7 +300,6 @@
 ** xref:components:logger/about.adoc[]
 
 * xref:guides:index.adoc[]
-** xref:guides:getting_started.adoc[]
 ** xref:guides:bloblang/about.adoc[]
 *** xref:guides:bloblang/walkthrough.adoc[]
 *** xref:guides:bloblang/functions.adoc[]
@@ -318,6 +322,7 @@
 *** xref:guides:migration/v4.adoc[]
 *** xref:guides:migration/v3.adoc[]
 *** xref:guides:migration/v2.adoc[]
+
 * xref:cookbooks:index.adoc[]
 ** xref:cookbooks:custom_metrics.adoc[]
 ** xref:cookbooks:discord_bot.adoc[]
@@ -326,3 +331,6 @@
 ** xref:cookbooks:joining_streams.adoc[]
 ** xref:cookbooks:rag.adoc[]
 ** xref:cookbooks:redpanda_migrator.adoc[]
+
+* xref:reference:index.adoc[]
+** xref:reference:k-connect-helm-spec.adoc[Helm Chart Specification]

modules/ROOT/pages/about.adoc renamed to modules/get-started/pages/about.adoc

@@ -1,5 +1,5 @@
 = Introduction to Redpanda Connect
-:page-aliases: guides:delivery_guarantee.adoc
+:page-aliases: guides:delivery_guarantee.adoc, ROOT:about.adoc
 
 Redpanda Connect is a declarative data streaming service that solves a wide range of data engineering problems with simple, chained, stateless xref:components:processors/about.adoc[processing steps]. It implements transaction-based resiliency with back pressure, so when connecting to at-least-once sources and sinks it's able to guarantee at-least-once delivery without needing to persist messages during transit.
 

modules/get-started/pages/index.adoc

@@ -0,0 +1,5 @@
+= Get Started
+:description: Explore these topics to get started with Redpanda Connect.
+:page-layout: index
+
+{description}