Merge pull request #1064 from EnterpriseDB/release/2021-03-12

Release/2021 03 12

.github/pull_request_template.md

@@ -0,0 +1,17 @@
+## What Changed?
+
+Please list, at a high level, what changed in your branch. If you changed content, include the product, guide, and version as applicable.
+
+**Examples**
+- Fixed typo in EPAS 13 epas_inst_linux guide
+- Added more detail to ARK 3.5 getting started guide introduction
+- Fixed broken link on `/supported-open-source/pgbackrest/05-retention_policy/` page
+
+## Checklist
+
+Please check all boxes that apply (`[ ]` is unchecked, `[x]` is checked)
+
+**Content**
+- [ ] This PR adds new content
+- [ ] This PR changes existing content
+- [ ] This PR removes existing content

.github/workflows/deploy-develop.yml

@@ -26,16 +26,16 @@ jobs:
       env:
         NODE_ENV: ${{ secrets.NODE_ENV }}
 
-    - name: Checking Gatsby cache
-      id: gatsby-cache-build
-      uses: actions/cache@v2
-      with:
-        path: |
-          public
-          .cache
-        key: ${{ runner.os }}-gatsby-build-develop-${{ github.run_id }}
-        restore-keys: |
-          ${{ runner.os }}-gatsby-build-develop-
+    # - name: Checking Gatsby cache
+    #   id: gatsby-cache-build
+    #   uses: actions/cache@v2
+    #   with:
+    #     path: |
+    #       public
+    #       .cache
+    #     key: ${{ runner.os }}-gatsby-build-develop-${{ github.run_id }}
+    #     restore-keys: |
+    #       ${{ runner.os }}-gatsby-build-develop-
 
     - name: Fix mtimes
       run: yarn fix-mtimes --force

.github/workflows/deploy-main.yml

@@ -26,16 +26,16 @@ jobs:
       env:
         NODE_ENV: ${{ secrets.NODE_ENV }}
 
-    - name: Checking Gatsby cache
-      id: gatsby-cache-build
-      uses: actions/cache@v2
-      with:
-        path: |
-          public
-          .cache
-        key: ${{ runner.os }}-gatsby-build-main-${{ github.run_id }}
-        restore-keys: |
-          ${{ runner.os }}-gatsby-build-main-
+    # - name: Checking Gatsby cache
+    #   id: gatsby-cache-build
+    #   uses: actions/cache@v2
+    #   with:
+    #     path: |
+    #       public
+    #       .cache
+    #     key: ${{ runner.os }}-gatsby-build-main-${{ github.run_id }}
+    #     restore-keys: |
+    #       ${{ runner.os }}-gatsby-build-main-
 
     - name: Fix mtimes
       run: yarn fix-mtimes --force

.github/workflows/update-pdfs-on-develop.yml

@@ -32,7 +32,7 @@ jobs:
         sudo apt-get install ./wkhtmltopdf.deb
 
     - name: Build all pdfs
-      run: npm run build-all-pdfs
+      run: npm run build-all-pdfs-ci
 
     - run: git status
     - run: git pull

README.md

@@ -40,13 +40,9 @@ We recommend using MacOS to work with the EDB Docs application.
 
 ### Installation of PDF / Doc Conversion Tools (optional)
 
-If you need to build PDFs locally, or run parts of the RST to MDX conversion pipeline, you'll need a couple more tools installed.
+If you need to build PDFs locally, you'll need to install Docker via Homebrew: `brew install docker`.
 
-1. Install `wkhtmltopdf`, a tool that converts html documents to pdf documents. You can install this with `brew install wkhtmltopdf`. Currently we are using version `0.12.6` - you can check the installed version with `wkhtmltopdf -V`. Newer versions are likely to work fine as well.
-
-1. Install `pandoc`, a general purpose document conversion tool. This can also be installed with homebrew - `brew install pandoc`.
-
-1. To confirm that both tools are working, you can trying building a PDF. `yarn build-pdf product_docs/docs/epas/13/` will build `epas_v13_documentation.pdf` in the `epas/13/` folder. You may see a few warnings, but the process should finish with `✨  Done in 43.25s.` or similar.
+If you need to run parts of the RST to MDX conversion pipeline, you'll need to install `pandoc`, a general purpose document conversion tool. This can also be installed with homebrew - `brew install pandoc`.
 
 ## Windows Installation
 

advocacy_docs/supported-open-source/barman/index.mdx

@@ -2,7 +2,6 @@
 title: Barman
 navTitle: Barman
 description: EDB supports Barman.
-product: barman
 tags:
     - barman
     - backup
@@ -12,6 +11,7 @@ tags:
     - postgresql
 directoryDefaults:
   iconName: coffee
+  product: barman
 ---
 
 Barman (Backup and Recovery Manager) is an open-source administration tool for remote backups and disaster recovery of PostgreSQL servers in business-critical environments. It relies on PostgreSQL’s robust and reliable Point In Time Recovery technology, allowing DBAs to remotely manage a complete catalogue of backups and the recovery phase of multiple remote servers – all from one location. Barman is distributed under GNU GPL 3 and maintained by EDB.

advocacy_docs/supported-open-source/barman/single-server-streaming/index.mdx

@@ -2,8 +2,6 @@
 title: "Backup and Recovery: Single-Server Streaming with Barman"
 description: "A quick demonstration of Barman installation, configuration, and basic backup and restore operations"
 navTitle: "Demo: Single-Server Streaming"
-product: barman
-platform: ubuntu
 tags:
     - ubuntu
     - barman
@@ -12,6 +10,7 @@ tags:
     - live-demo
 iconName: coffee
 directoryDefaults:
+  platform: ubuntu
   prevNext: true
 ---
 
@@ -22,4 +21,4 @@ This section demonstrates setting up a backup and recovery scenario using a Barm
 3. Running a full backup
 4. Restoring a full backup
 
-Each of these steps is interactive, with the prerequisites and results of the previous step captured in a Docker image. You can work through the entire scenario in order, or skip to the step that interests you.
+Each of these steps is interactive, with the prerequisites and results of the previous step captured in a Docker image. You can work through the entire scenario in order, or skip to the step that interests you.

advocacy_docs/supported-open-source/barman/single-server-streaming/step02-backup-setup.mdx

@@ -2,8 +2,6 @@
 title: "Backup and Recovery: Single-Server Streaming - Installing and Configuring Barman"
 description: "Installing Barman on an Ubuntu-based backup server, creating a configuration file and testing the connection"
 navTitle: "Barman Installation & Configuration"
-product: barman
-platform: ubuntu
 tags:
     - ubuntu
     - barman

advocacy_docs/supported-open-source/barman/single-server-streaming/step03-backup.mdx

@@ -2,8 +2,6 @@
 title: "Backup and Recovery: Single-Server Streaming - Running a Base Backup"
 description: "Running a full backup using Barman"
 navTitle: "Base Backup"
-product: barman
-platform: ubuntu
 tags:
     - ubuntu
     - barman

advocacy_docs/supported-open-source/barman/single-server-streaming/step04-restore.mdx

@@ -2,8 +2,6 @@
 title: "Backup and Recovery: Single-Server Streaming - Recovery"
 description: "Recovering from data loss by using Barman to restore a full backup remotely"
 navTitle: "Restore"
-product: barman
-platform: ubuntu
 tags:
     - ubuntu
     - barman

advocacy_docs/supported-open-source/pgadmin/index.mdx

@@ -2,9 +2,9 @@
 title: pgAdmin
 navTitle: pgAdmin
 description: EDB supports pgAdmin.
-product: pgAdmin
 directoryDefaults:
   iconName: postgresql
+  product: pgAdmin
 ---
 
 pgAdmin is an open source, multi-platform console for PostgreSQL management and administration.

advocacy_docs/supported-open-source/pgbackrest/02-installation.mdx

@@ -1,7 +1,6 @@
 ---
 title: 'Installation'
 description: 'Instructions for installing pgBackRest on supported systems, including EDB Postgres Advanced Server'
-product: 'pgBackRest'
 tags:
   - installation
   - EPAS

advocacy_docs/supported-open-source/pgbackrest/03-quick_start.mdx

@@ -1,7 +1,6 @@
 ---
 title: 'Quick Start'
 description: "A walkthrough: configuring pgBackRest, then running, examining and restoring a backup of a database cluster"
-product: 'pgBackRest'
 tags:
   - configuration
   - backup

advocacy_docs/supported-open-source/pgbackrest/04-recommended_settings.mdx

@@ -1,7 +1,6 @@
 ---
 title: 'Recommended Settings'
 description: "Recommendations & rationale for pgBackRest configuration settings"
-product: 'pgBackRest'
 ---
 
 This section walks you through the recommended settings while using pgBackRest.

advocacy_docs/supported-open-source/pgbackrest/05-retention_policy.mdx

@@ -1,7 +1,6 @@
 ---
 title: 'Retention Policy'
 description: "Configuration options and considerations for the removal of obsolete backups and WAL archives"
-product: 'pgBackRest'
 ---
 
 Setting retention policy options allows to remove obsolete backups. Those settings will then be a trade-off between saving space and data retention.

advocacy_docs/supported-open-source/pgbackrest/06-use_case_1.mdx

@@ -2,7 +2,6 @@
 title: 'Use Case 1: Running pgBackRest Locally on the Database Host'
 navTitle: 'Use Case 1'
 description: "Examines a configuration used to run pgBackRest locally, on the database host"
-product: 'pgBackRest'
 tags:
   - configuration
   - pgBackRest

advocacy_docs/supported-open-source/pgbackrest/07-use_case_2.mdx

@@ -2,7 +2,6 @@
 title: 'Use Case 2: Running pgBackRest from a Dedicated Repository Host'
 navTitle: 'Use Case 2'
 description: "Examines a configuration used to run pgBackRest from a dedicated repository host"
-product: 'pgBackRest'
 tags:
   - configuration
   - pgBackRest

advocacy_docs/supported-open-source/pgbackrest/98-appendix.mdx

@@ -1,7 +1,6 @@
 ---
 title: 'Appendix'
 description: "Definitions for terms and concepts used in this guide, along with notes on configuration terminology"
-product: 'pgBackRest'
 ---
 
 ### Concepts

advocacy_docs/supported-open-source/pgbackrest/99-faq.mdx

@@ -2,7 +2,6 @@
 title: 'Frequently Asked Questions'
 navTitle: 'FAQ'
 description: 'Answers to Frequently Asked Questions'
-product: 'pgBackRest'
 ---
 
 - Why do we have to specify the `--stanza` option even if only one stanza is defined in the configuration file?

advocacy_docs/supported-open-source/pgbackrest/index.mdx

@@ -1,7 +1,6 @@
 ---
 title: 'pgBackRest'
 description: 'Introduction to pgBackRest, a reliable PostgreSQL backup & restore tool'
-product: 'pgBackRest'
 tags:
   - backup
   - restore
@@ -10,6 +9,7 @@ tags:
 indexCards: simple
 directoryDefaults:
   iconName: 'postgressupport'
+  product: 'pgBackRest'
 ---
 
 pgBackRest is an easy-to-use backup and restore tool that aims to enable your organization to implement disaster recovery solutions for PostgreSQL databases. 

advocacy_docs/supported-open-source/postgresql/index.mdx

@@ -2,9 +2,9 @@
 title: PostgreSQL
 navTitle: PostgreSQL
 description: EDB supports PostgreSQL.
-product: PostgreSQL
 directoryDefaults:
   iconName: postgresql
+  product: PostgreSQL
 ---
 
 PostgreSQL is a popular, free, open-source relational database management system (RDBMS). It has earned a reputation for reliability, performance, and extensibility, with a robust feature set to securely store and scale even the most complex workloads.

advocacy_docs/supported-open-source/postgresql/installer/01_requirements_overview.mdx

@@ -1,6 +1,5 @@
 ---
 title: "Requirements Overview"
-product: PostgreSQL
 legacyRedirects:
   - "/edb-docs/d/postgresql/installation-getting-started/installation-guide/13.0/requirements_overview.html"
 ---

advocacy_docs/supported-open-source/postgresql/installer/02_installing_postgresql_with_the_graphical_installation_wizard/01_invoking_the_graphical_installer.mdx

@@ -1,6 +1,5 @@
 ---
 title: "Invoking the Graphical Installer"
-product: PostgreSQL
 legacyRedirects:
   - "/edb-docs/d/postgresql/installation-getting-started/installation-guide/13.0/invoking_the_graphical_installer.html"
 ---

advocacy_docs/supported-open-source/postgresql/installer/02_installing_postgresql_with_the_graphical_installation_wizard/index.mdx

@@ -1,6 +1,5 @@
 ---
 title: "Installing PostgreSQL with the Graphical Installation Wizard"
-product: PostgreSQL
 legacyRedirects:
   - "/edb-docs/d/postgresql/installation-getting-started/installation-guide/13.0/installing_postgresql_with_the_graphical_installation_wizard.html"
 ---

advocacy_docs/supported-open-source/postgresql/installer/03_using_stackbuilder.mdx

@@ -1,6 +1,5 @@
 ---
 title: "Using Stack Builder"
-product: PostgreSQL
 legacyRedirects:
   - "/edb-docs/d/postgresql/installation-getting-started/installation-guide/13.0/using_stackbuilder.html"
 ---

advocacy_docs/supported-open-source/postgresql/installer/04_installation_troubleshooting.mdx

@@ -1,6 +1,5 @@
 ---
 title: "Installation Troubleshooting"
-product: PostgreSQL
 legacyRedirects:
   - "/edb-docs/d/postgresql/installation-getting-started/installation-guide/13.0/installation_troubleshooting.html"
 ---

advocacy_docs/supported-open-source/postgresql/installer/05_uninstalling_postgresql.mdx

@@ -1,6 +1,5 @@
 ---
 title: "Uninstalling PostgreSQL"
-product: PostgreSQL
 legacyRedirects:
   - "/edb-docs/d/postgresql/installation-getting-started/installation-guide/13.0/uninstalling_postgresql.html"
 ---

advocacy_docs/supported-open-source/postgresql/installer/index.mdx

@@ -1,7 +1,6 @@
 ---
 title: "EDB Installers"
 description: "The PostgreSQL installers created by EnterpriseDB are designed to make it quick and simple to install PostgreSQL on your computer."
-product: PostgreSQL
 ---
 
 The PostgreSQL installers created by EnterpriseDB are designed to make it quick and simple to install PostgreSQL on your computer. The installer provides:

docker/docker-compose.build-pdf.yaml

@@ -0,0 +1,13 @@
+version: '3.8'
+
+services:
+  pdf-builder:
+    build:
+      context: ../
+      dockerfile: docker/images/Dockerfile.pdf-builder
+    image: edb/x-docs-pdf-builder
+    container_name: pdf-builder
+    hostname: pdf-builder
+    working_dir: /app
+    volumes:
+      - ../:/app

docker/images/Dockerfile.pdf-builder

@@ -0,0 +1,27 @@
+FROM ubuntu:focal
+
+ARG PANDOC_VERSION=2.12
+ARG PANDOC_DEB=pandoc-2.12-1-amd64.deb
+ARG WKHTML_TO_PDF_VERSION=0.12.6-1
+ARG WKHTML_TO_PDF_DEB=wkhtmltox_${WKHTML_TO_PDF_VERSION}.focal_amd64.deb
+
+RUN apt-get update && apt-get install --no-install-recommends -y \
+  python3 \
+  wget \
+  && apt-get clean \
+  && rm -rf /var/lib/apt/lists/*
+
+# Install Pandoc
+RUN wget --no-check-certificate -P /tmp https://github.com/jgm/pandoc/releases/download/${PANDOC_VERSION}/${PANDOC_DEB} \
+  && apt-get install --no-install-recommends -y /tmp/${PANDOC_DEB} \
+  && apt-get clean \
+  && rm -rf /var/lib/apt/lists/* \
+  && rm -rf /tmp/*
+
+# Install wkhtmltopdf
+RUN wget --no-check-certificate -P /tmp https://github.com/wkhtmltopdf/packaging/releases/download/${WKHTML_TO_PDF_VERSION}/${WKHTML_TO_PDF_DEB} \
+  && apt-get update \
+  && apt-get install --no-install-recommends -y /tmp/${WKHTML_TO_PDF_DEB} \
+  && apt-get clean \
+  && rm -rf /var/lib/apt/lists/* \
+  && rm -rf /tmp/*

gatsby-config.js

@@ -11,7 +11,7 @@ const ANSI_STOP = '\033[0m';
 
 const isBuild = process.env.NODE_ENV === 'production';
 const isProduction = process.env.APP_ENV === 'production';
-const algoliaIndex = process.env.ALGOLIA_INDEX_NAME || 'edb-docs-staging';
+const algoliaIndex = process.env.ALGOLIA_INDEX_NAME || 'edb-docs-test';
 
 /******** Sourcing *********/
 const sourceFilename = isBuild ? 'build-sources.json' : 'dev-sources.json';
@@ -111,6 +111,10 @@ const indexQuery = `
         product
         platform
         tags
+        directoryDefaults {
+          product
+          platform
+        }
       }
       id
       fields {

gatsby-node.js

@@ -104,6 +104,8 @@ exports.createPages = async ({ actions, graphql, reporter }) => {
               description
               prevNext
               iconName
+              product
+              platform
             }
           }
           fields {

package.json

@@ -15,8 +15,9 @@
     "build": "gatsby build --prefix-paths",
     "serve-build": "gatsby serve --prefix-paths",
     "update-icons": "git submodule update --init --remote && node scripts/createIconTypes.js && node scripts/createIconNames.js",
-    "build-pdf": "python3 scripts/pdf/generate_pdf.py",
-    "build-all-pdfs": "for i in product_docs/docs/**/*/ ; do echo \"$i\"; python3 scripts/pdf/generate_pdf.py ${i%} || exit 1; done",
+    "build-pdf": "docker-compose -f docker/docker-compose.build-pdf.yaml run --rm --entrypoint scripts/pdf/generate_pdf.py pdf-builder",
+    "build-all-pdfs": "for i in product_docs/docs/**/*/ ; do echo \"$i\"; yarn build-pdf ${i%} || exit 1; done",
+    "build-all-pdfs-ci": "for i in product_docs/docs/**/*/ ; do echo \"$i\"; python3 scripts/pdf/generate_pdf.py ${i%} || exit 1; done",
     "fix-mtimes": "python3 scripts/source/git-restore-mtime.py",
     "count": "find product_docs/docs/ advocacy_docs/ external_sources/ -name '*.mdx' | wc -l",
     "heroku-postbuild": "gatsby build",