docs: Clarify the documentation

.codespellignore

@@ -0,0 +1 @@
+socio-economic

.github/CODEOWNERS

@@ -0,0 +1,4 @@
+# Order is important. The last matching pattern has the most precedence. In each subsection folders are ordered first by depth, then alphabetically
+
+/.github/                                                      @philippemnoel
+/charts/                                                       @philippemnoel

.github/FUNDING.yml

@@ -0,0 +1,12 @@
+# These are supported funding model platforms
+
+github: [paradedb] # Replace with up to 4 GitHub Sponsors-enabled usernames e.g., [user1, user2]
+patreon: # Replace with a single Patreon username
+open_collective: # Replace with a single Open Collective username
+ko_fi: # Replace with a single Ko-fi username
+tidelift: # Replace with a single Tidelift platform-name/package-name e.g., npm/babel
+community_bridge: # Replace with a single Community Bridge project-name e.g., cloud-foundry
+liberapay: # Replace with a single Liberapay username
+issuehunt: # Replace with a single IssueHunt username
+otechie: # Replace with a single Otechie username
+custom: # Replace with up to 4 custom sponsorship URLs e.g., ['link1', 'link2']

.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,16 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: ""
+labels: ""
+assignees: ""
+---
+
+**Bug Description**
+Please describe the bug.
+
+**How To Reproduce**
+Please describe how to reproduce the bug.
+
+**Proposed Fix**
+Please describe how you think this bug could be fixed.

.github/ISSUE_TEMPLATE/config.yml

@@ -0,0 +1 @@
+blank_issues_enabled: false

.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,16 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+title: ""
+labels: ""
+assignees: ""
+---
+
+**What**
+Please describe the feature.
+
+**Why**
+Please describe why this feature is important.
+
+**How**
+Please describe how you'd implement this feature.

.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,11 @@
+# Ticket(s) Closed
+
+- Closes #
+
+## What
+
+## Why
+
+## How
+
+## Tests

.github/actions/deploy-operator/action.yml

@@ -6,11 +6,11 @@ runs:
     - name: Deploy the operator
       shell: bash
       run:
-        helm dependency update charts/cloudnative-pg
+        helm repo add cnpg https://cloudnative-pg.github.io/charts
 
         helm upgrade
         --install 
         --namespace cnpg-system
         --create-namespace
         --wait
-        cnpg charts/cloudnative-pg
+        cnpg cnpg/cloudnative-pg

.github/config/cr.yaml

@@ -0,0 +1,12 @@
+## Reference: https://github.com/helm/chart-releaser
+index-path: "./index.yaml"
+
+# PGP signing
+sign: true
+key: ParadeDB
+# keyring:          # Set via env variable CR_KEYRING
+# passphrase-file:  # Set via env variable CR_PASSPHRASE_FILE
+
+# Enable automatic generation of release notes using GitHub's release notes generator.
+# see: https://docs.github.com/en/repositories/releasing-projects-on-github/automatically-generated-release-notes
+generate-release-notes: true

.github/dependabot.yml

@@ -0,0 +1,14 @@
+version: 2
+
+updates:
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      interval: "monthly"
+    ignore:
+      - dependency-name: "*"
+        update-types: ["version-update:semver-patch"]
+    groups:
+      github-actions-dependencies:
+        patterns:
+          - "*"

.github/workflows/check-typo.yml

@@ -0,0 +1,31 @@
+# workflows/check-typo.yml
+#
+# Check Typo
+# Check Typo using codespell.
+
+name: Check Typo
+
+on:
+  pull_request:
+    types: [opened, synchronize, reopened, ready_for_review]
+  workflow_dispatch:
+
+concurrency:
+  group: check-typo-${{ github.head_ref || github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  check-typo:
+    name: Check Typo using codespell
+    runs-on: depot-ubuntu-latest-2
+    if: github.event.pull_request.draft == false
+
+    steps:
+      - name: Checkout Git Repository
+        uses: actions/checkout@v4
+
+      - name: Check Typo using codespell
+        uses: codespell-project/actions-codespell@v2
+        with:
+          check_filenames: true
+          ignore_words_file: .codespellignore

.github/workflows/paradedb-publish-chart.yml

@@ -0,0 +1,109 @@
+# workflows/paradedb-publish-chart.yml
+#
+# ParadeDB Publish Chart
+# Publish the ParadeDB Helm chart to paradedb.github.io via GitHub Pages. This workflow also
+# triggers the creation of a GitHub Release. It only runs on pushes to `main` or when we trigger
+# a workflow_dispatch event, either manually or via creating a release in `paradedb/paradedb`.
+
+name: ParadeDB Publish Chart
+
+on:
+  push:
+    branches:
+      - main
+  workflow_dispatch:
+    inputs:
+      appVersion:
+        description: "The ParadeDB version to publish in the Helm Chart (e.g. 0.1.0)"
+        required: true
+        default: ""
+
+concurrency:
+  group: paradedb-publish-chart-${{ github.head_ref || github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  paradedb-publish-chart:
+    name: Publish ParadeDB Helm Charts to GitHub Pages
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Configure Git
+        run: |
+          git config user.name "$GITHUB_ACTOR"
+          git config user.email "[email protected]"
+
+      - name: Set Helm Chart Release Versions
+        id: set_versions
+        working-directory: charts/paradedb/
+        env:
+          GH_TOKEN: ${{ secrets.GHA_CREATE_RELEASE_PAT }}
+        run: |
+          # If no appVersion is provided, we use the latest ParadeDB version
+          if [ -z "${{ github.event.inputs.appVersion }}" ]; then
+            LATEST_TAG=$(curl -s https://api.github.com/repos/paradedb/paradedb/tags | jq -r '.[0].name')
+            APP_VERSION=${LATEST_TAG#v}
+          else
+            APP_VERSION=${{ github.event.inputs.appVersion }}
+          fi
+          # Update appVersion to the GitHub Release version and version to the Helm Chart version
+          sed -i "s/^[[:space:]]*paradedb: .*/  paradedb: \"$APP_VERSION\"/" values.yaml
+          sed -i "s/^version: .*/version: ${{ vars.CHART_VERSION_MAJOR }}.${{ vars.CHART_VERSION_MINOR }}.${{ vars.CHART_VERSION_PATCH }}/" Chart.yaml
+          echo "values.yaml:"
+          cat values.yaml
+          echo "----------------------------------------"
+          echo "Chart.yaml:"
+          cat Chart.yaml
+
+          # Set output to update post-release, increasing the Helm Chart version patch number by one to update in GitHub Actions Variables
+          echo "new_chart_version_patch=$(( ${{ vars.CHART_VERSION_PATCH }} + 1 ))" >> $GITHUB_OUTPUT
+
+      # The GitHub repository secret `PARADEDB_PGP_PRIVATE_KEY` contains the private key
+      # in ASCII-armored format. To export a (new) key, run this command:
+      # `gpg --armor --export-secret-key <my key>`
+      - name: Prepare ParadeDB PGP Key
+        env:
+          PGP_PRIVATE_KEY: "${{ secrets.PARADEDB_PGP_PRIVATE_KEY }}"
+          PGP_PASSPHRASE: "${{ secrets.PARADEDB_PGP_PASSPHRASE }}"
+        run: |
+          IFS=""
+          echo "$PGP_PRIVATE_KEY" | gpg --dearmor --verbose > /tmp/secring.gpg
+          echo "$PGP_PASSPHRASE" > /tmp/passphrase.txt
+
+          # Tell chart-releaser-action where to find the key and its passphrase
+          echo "CR_KEYRING=/tmp/secring.gpg" >> "$GITHUB_ENV"
+          echo "CR_PASSPHRASE_FILE=/tmp/passphrase.txt" >> "$GITHUB_ENV"
+
+      - name: Add Grafana Chart Dependencies
+        run: helm repo add cnpg-grafana-dashboard https://cloudnative-pg.github.io/grafana-dashboards
+
+      - name: Run chart-releaser
+        uses: helm/[email protected]
+        with:
+          config: "./.github/config/cr.yaml"
+        env:
+          CR_TOKEN: "${{ secrets.GHA_CREATE_RELEASE_PAT }}"
+
+      # We have a separate version for our Helm Chart, since it needs to always increment by
+      # one for every production release, independently of the ParadeDB version. Any non-patch
+      # version increment should be done manually in GitHub Actions Variables.
+      - name: Increment Helm Chart Version Number in GitHub Actions Variables
+        env:
+          GH_TOKEN: ${{ secrets.GHA_CREATE_RELEASE_PAT }}
+        run: |
+          gh api \
+            --method PATCH \
+            -H "Accept: application/vnd.github+json" \
+            -H "X-GitHub-Api-Version: 2022-11-28" \
+            /repos/paradedb/charts/actions/variables/CHART_VERSION_PATCH \
+            -f name='CHART_VERSION_PATCH' \
+            -f value='${{ steps.set_versions.outputs.new_chart_version_patch }}'
+
+      - name: Securely Delete the PGP Key and Passphrase
+        if: always()
+        run: shred --remove=wipesync /tmp/secring.gpg /tmp/passphrase.txt