PMM-13597 Move documentation v2 to monorepo (#3379)

* PMM-13597 Move documentation v2 to monorepo

* PMM-13597 Turn on the version selector

* PMM-13597 Apply PR #1340

* PMM-13597 Add make pdf target

* PMM-13597 Update github actions

* PMM-13597 Move over PR-1343 from pmm-doc

* PMM-13597 Make styles the same as on other doc sites

* PMM-13597 Make styles the same as on other doc sites

* PMM-13597 Remove "PMM" from version selector

* PMM-13597 Remove underscore from pdf directory

* PMM-13597 Follow up on review comments

* PMM-13597 Follow up on review comments

.github/CODEOWNERS

@@ -1,5 +1,6 @@
 *                                       @percona/pmm-review-be
 /docs/                                  @percona/pmm-docs
+/documentation/                         @percona/pmm-docs
 /ui/                                    @percona/pmm-review-fe
 /agent/agents/postgres/                 @JiriCtvrtka @percona/pmm-review-be
 /api/                                   @BupycHuk @percona/pmm-review-be

.github/ISSUE_TEMPLATE/doc-md-template.md

@@ -0,0 +1,66 @@
+
+# Feature Name
+
+!!! caution alert alert-warning "Important/Caution"
+    Crucial points that need emphasis:
+
+    - Important: A significant point that deserves emphasis.
+    - Caution: Used to mean 'Continue with care'.
+
+## What is feature_name?
+
+!!! note alert alert-primary "Note"
+    Replace **feature_name** with the name of the feature.
+
+
+Describe the feature.
+
+## Prerequisites
+List the requirements before installing/configuring/using the feature.
+
+**Example**
+
+Install a particular software or utility.
+
+Configure the software or utility.
+
+## Before you begin
+
+Do specific settings in PMM for the feature to work as expected.
+
+
+## Installing/Configuring/Using feature_name
+
+!!! note alert alert-primary "Note"
+    Replace **feature_name** with the name of the feature.
+
+Use numbered list to provide step by step instructions to install/confiigure/use the feature. Use just one instruction per step for clarity.
+
+ Use images (optional)
+
+![!](../images/image_name.png)
+
+
+**Note, Info (Optional)**
+
+To give your users important or useful information that isn't part of the flow of the text, you can offset the information with a note. 
+
+Preferred use is without the label (first form).
+
+
+!!! note alert alert-primary ""
+    Note ...
+
+!!! note alert alert-primary "Note"
+    Text ...
+
+!!! note alert alert-primary "Info"
+    Text ...  
+
+**Caution, Warning, Important**
+
+Uses same type but different label text:
+
+- Caution: Used to mean 'Continue with care'.
+
+- Important: A significant point that deserves emphasis.

.github/ISSUE_TEMPLATE/doc-rn-template.md

@@ -0,0 +1,84 @@
+---
+name: Percona Monitoring and Management <version>
+about: Release Notes Template for PMM
+
+---
+
+| **Release date:** | [Month DD, YYYY]                                                                                    |
+| ----------------- | ----------------------------------------------------------------------------------------------- |
+| **Installation:** | [Installing Percona Monitoring and Management](https://www.percona.com/software/pmm/quickstart) |
+
+Percona Monitoring and Management (PMM) is an open source database monitoring, management, and observability solution for MySQL, PostgreSQL, and MongoDB.
+
+!!! caution alert alert-warning "Important/Caution"
+    Crucial points that need emphasis:
+
+    - Important: A significant point that deserves emphasis.
+    - Caution: Used to mean 'Continue with care'.
+
+
+## Release Highlights
+
+
+### Release Highlights1 
+Description of the feature with a link to the documentation
+
+
+### Release Highlights2
+Description of the feature  with a link to the documentation
+
+Add more subsections for more release highlights.
+
+
+### Components Upgrade
+- List the components which are upgraded as part of the Release.
+
+## New Features
+
+- List of new features with a comprehensive description of the feature and link to the JIRA ticket.
+
+    Example:
+
+    [PMM-XXXX](https://jira.percona.com/browse/PMM-XXXX) - Comprehensive description.
+
+
+
+## Improvements
+
+- ​​List of improvements with a comprehensive description and link to the JIRA ticket.
+
+    Example:
+
+    [PMM-XXXX](https://jira.percona.com/browse/PMM-XXXX) - Comprehensive description.
+
+
+## Bugs Fixed
+
+- ​​List of bugs with a comprehensive description and link to the JIRA ticket.
+
+    Example:
+
+    [PMM-XXXX](https://jira.percona.com/browse/PMM-XXXX) - Comprehensive description.
+
+
+
+## Known issues
+
+- ​List of known issues with a  comprehensive description and link to the JIRA ticket.
+
+    Example:
+
+    [PMM-XXXX](https://jira.percona.com/browse/PMM-XXXX) - Comprehensive description.
+
+
+    **Solution**
+
+    Description of the solution.
+
+
+## Coming Soon
+
+  Share what are the upcoming features on your roadmap to keep users excited:
+
+- Planned item 1
+- Planned item 2

.github/workflows/admin.yml

@@ -7,12 +7,15 @@ on:
       - pmm-*
     tags:
       - v[0-9]+.[0-9]+.[0-9]+*
+    paths-ignore:
+      - "documentation/**"
 
   pull_request:
     paths-ignore:
       - "agent/**"
       - "api-tests/**"
       - "docs/**"
+      - "documentation/**"
       - "managed/**"
       - "qan-api2/**"
       - "update/**"

.github/workflows/agent.yml

@@ -7,13 +7,16 @@ on:
       - pmm-*
     tags:
       - v[0-9]+.[0-9]+.[0-9]+*
+    paths-ignore:
+      - "documentation/**"
 
   pull_request:
     paths-ignore:
       - "admin/**"
       - "api-tests/**"
       - "cli-tests/**"
       - "docs/**"
+      - "documentation/**"
       - "managed/**"
       - "qan-api2/**"
       - "update/**"

.github/workflows/documentation.yml

@@ -0,0 +1,59 @@
+name: PMM Docs 2.x
+
+on:
+  push:
+    branches:
+      - main
+    paths:
+      - "documentation/**"
+
+  workflow_dispatch:
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Check out code
+        uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
+        with:
+          fetch-depth: 0 # read more about why this is necessary at https://github.com/jimporter/mike/issues/60
+          sparse-checkout: |
+            .github
+            documentation
+            Makefile
+            Makefile.include
+
+      - name: Setup Python
+        uses: actions/setup-python@0b93645e9fea7318ecaed2b359559ac225c90a2b # v5.3.0
+        with:
+          python-version: '3.x'
+          cache: 'pip'
+
+      - name: Setup MkDocs
+        working-directory: documentation
+        run: |
+          python -m pip install --upgrade pip
+          pip install wheel
+          test -f requirements.txt && pip install -r requirements.txt
+
+      - name: Configure git
+        env:
+          ROBOT_TOKEN: ${{ secrets.ROBOT_TOKEN }}
+        run: |
+          git config --global url."https://percona-platform-robot:${ROBOT_TOKEN}@github.com".insteadOf "https://github.com"
+          git config user.name "GitHub Action"
+          git config user.email "[email protected]"
+          git config user.password "${ROBOT_TOKEN}"
+          echo "GIT_USER=percona-platform-robot:${ROBOT_TOKEN}" >> $GITHUB_ENV
+
+      - name: Check for unused images
+        run: make doc-check-images
+
+          # Builds Material-themed static web site in 'publish' branch
+      - name: Build a themed site (2.x)
+        working-directory: documentation
+        run: |
+          mike deploy 2 -b publish -p
+          mike set-default 2 -b publish -p
+          mike retitle 2 "2.x (LATEST)" -b publish -p

.github/workflows/helm-tests.yml

@@ -0,0 +1,64 @@
+name: Test helm.md
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+    paths:
+      - 'documentation/docs/setting-up/server/helm.md'
+
+  workflow_dispatch:
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Check out code
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 1
+
+      - name: Install pandoc
+        run: |
+          wget https://github.com/jgm/pandoc/releases/download/2.18/pandoc-2.18-1-amd64.deb
+          sudo apt-get install -y ./pandoc-2.18-1-amd64.deb
+          rm ./pandoc-2.18-1-amd64.deb
+
+      - name: Copy test template
+        working-directory: ${{ github.workspace }}/documentation
+        run: cp resources/bin/doc_test_template.sh ./docs_test_helm.sh
+
+      - name: Get CodeBlocks and push them to test template
+        working-directory: ${{ github.workspace }}/documentation
+        run: pandoc -i docs/setting-up/server/helm.md --lua-filter resources/bin/CodeBlock.lua -t html -o /dev/null >> docs_test_helm.sh
+
+      - name: Start k8s cluster
+        working-directory: ${{ github.workspace }}/documentation
+        run: minikube start
+
+      - name: Setup storage driver for snapshots
+        working-directory: ${{ github.workspace }}/documentation
+        run: |
+          minikube addons disable storage-provisioner
+          kubectl delete storageclass standard
+          minikube addons enable csi-hostpath-driver
+          minikube addons enable volumesnapshots
+          kubectl patch storageclass csi-hostpath-sc -p '{"metadata": {"annotations":{"storageclass.kubernetes.io/is-default-class":"true"}}}'
+
+      - name: Run helm tests
+        working-directory: ${{ github.workspace }}/documentation
+        run: ./docs_test_helm.sh
+
+      - name: Get debug
+        if: ${{ failure() }}
+        working-directory: ${{ github.workspace }}/documentation
+        run: |
+          cat ./docs_test_helm.sh
+          pandoc --version
+          helm version
+          kubectl get pods
+          kubectl describe pod --selector=app.kubernetes.io/name=pmm || true
+          kubectl get events --sort-by=lastTimestamp 
+          kubectl logs --all-containers --timestamps --selector=app.kubernetes.io/name=pmm || true

.github/workflows/managed.yml

@@ -6,6 +6,8 @@ on:
       - pmm-*
     tags:
       - v[0-9]+.[0-9]+.[0-9]+*
+    paths-ignore:
+      - 'documentation/**'
 
   pull_request:
     paths-ignore:
@@ -14,6 +16,7 @@ on:
       - 'api-tests/**'
       - 'cli-tests/**'
       - 'docs/**'
+      - 'documentation/**'
       - 'qan-api2/**'
       - 'update/**'
       - 'vmproxy/**'

.github/workflows/podman-tests.yml

@@ -0,0 +1,53 @@
+name: Test podman.md
+
+on:
+  push:
+    branches:
+      - main
+    paths:
+      - 'documentation/docs/setting-up/server/podman.md'
+  pull_request:
+    paths:
+      - 'documentation/docs/setting-up/server/podman.md'
+
+  workflow_dispatch:
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Check out code
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 1
+
+      - name: Install pandoc
+        run: |
+          wget https://github.com/jgm/pandoc/releases/download/2.18/pandoc-2.18-1-amd64.deb
+          sudo apt-get install -y ./pandoc-2.18-1-amd64.deb
+          rm ./pandoc-2.18-1-amd64.deb
+
+      - name: Copy test template
+        working-directory: ${{ github.workspace }}/documentation
+        run: cp _resources/bin/doc_test_template.sh ./docs_test_podman.sh
+
+      - name: Get CodeBlocks and push them to test template
+        working-directory: ${{ github.workspace }}/documentation
+        run: pandoc -i docs/setting-up/server/podman.md --lua-filter _resources/bin/CodeBlock.lua -t html -o /dev/null >> docs_test_podman.sh
+
+      - name: Run podman tests
+        working-directory: ${{ github.workspace }}/documentation
+        run: ./docs_test_podman.sh
+
+      - name: Get debug
+        if: ${{ failure() }}
+        working-directory: ${{ github.workspace }}/documentation
+        run: |
+          cat ./docs_test_podman.sh
+          pandoc --version
+          podman version
+          podman ps --all || true
+          systemctl status --user pmm-server || true
+          podman inspect pmm-server || true
+          journalctl -r || true