Skip to content

Commit 7ff8735

Browse files
epbargerepbarger
authored
Merge pull request #1064 from EnterpriseDB/release/2021-03-12
Release/2021 03 12 Former-commit-id: 9c1b32a
2 parents 0326062 + bd18bc7 commit 7ff8735

File tree

53 files changed

+391
-327
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

53 files changed

+391
-327
lines changed

‎.github/pull_request_template.md

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

‎.github/workflows/deploy-develop.yml

+10-10
Original file line numberDiff line numberDiff line change
@@ -26,16 +26,16 @@ jobs:
2626
env:
2727
NODE_ENV: ${{ secrets.NODE_ENV }}
2828

29-
- name: Checking Gatsby cache
30-
id: gatsby-cache-build
31-
uses: actions/cache@v2
32-
with:
33-
path: |
34-
public
35-
.cache
36-
key: ${{ runner.os }}-gatsby-build-develop-${{ github.run_id }}
37-
restore-keys: |
38-
${{ runner.os }}-gatsby-build-develop-
29+
# - name: Checking Gatsby cache
30+
# id: gatsby-cache-build
31+
# uses: actions/cache@v2
32+
# with:
33+
# path: |
34+
# public
35+
# .cache
36+
# key: ${{ runner.os }}-gatsby-build-develop-${{ github.run_id }}
37+
# restore-keys: |
38+
# ${{ runner.os }}-gatsby-build-develop-
3939

4040
- name: Fix mtimes
4141
run: yarn fix-mtimes --force

‎.github/workflows/deploy-main.yml

+10-10
Original file line numberDiff line numberDiff line change
@@ -26,16 +26,16 @@ jobs:
2626
env:
2727
NODE_ENV: ${{ secrets.NODE_ENV }}
2828

29-
- name: Checking Gatsby cache
30-
id: gatsby-cache-build
31-
uses: actions/cache@v2
32-
with:
33-
path: |
34-
public
35-
.cache
36-
key: ${{ runner.os }}-gatsby-build-main-${{ github.run_id }}
37-
restore-keys: |
38-
${{ runner.os }}-gatsby-build-main-
29+
# - name: Checking Gatsby cache
30+
# id: gatsby-cache-build
31+
# uses: actions/cache@v2
32+
# with:
33+
# path: |
34+
# public
35+
# .cache
36+
# key: ${{ runner.os }}-gatsby-build-main-${{ github.run_id }}
37+
# restore-keys: |
38+
# ${{ runner.os }}-gatsby-build-main-
3939

4040
- name: Fix mtimes
4141
run: yarn fix-mtimes --force

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

+1-1
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ jobs:
3232
sudo apt-get install ./wkhtmltopdf.deb
3333
3434
- name: Build all pdfs
35-
run: npm run build-all-pdfs
35+
run: npm run build-all-pdfs-ci
3636

3737
- run: git status
3838
- run: git pull

‎README.md

+2-6
Original file line numberDiff line numberDiff line change
@@ -40,13 +40,9 @@ We recommend using MacOS to work with the EDB Docs application.
4040

4141
### Installation of PDF / Doc Conversion Tools (optional)
4242

43-
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.
43+
If you need to build PDFs locally, you'll need to install Docker via Homebrew: `brew install docker`.
4444

45-
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.
46-
47-
1. Install `pandoc`, a general purpose document conversion tool. This can also be installed with homebrew - `brew install pandoc`.
48-
49-
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.
45+
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`.
5046

5147
## Windows Installation
5248

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

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,6 @@
22
title: Barman
33
navTitle: Barman
44
description: EDB supports Barman.
5-
product: barman
65
tags:
76
- barman
87
- backup
@@ -12,6 +11,7 @@ tags:
1211
- postgresql
1312
directoryDefaults:
1413
iconName: coffee
14+
product: barman
1515
---
1616

1717
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-3
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,6 @@
22
title: "Backup and Recovery: Single-Server Streaming with Barman"
33
description: "A quick demonstration of Barman installation, configuration, and basic backup and restore operations"
44
navTitle: "Demo: Single-Server Streaming"
5-
product: barman
6-
platform: ubuntu
75
tags:
86
- ubuntu
97
- barman
@@ -12,6 +10,7 @@ tags:
1210
- live-demo
1311
iconName: coffee
1412
directoryDefaults:
13+
platform: ubuntu
1514
prevNext: true
1615
---
1716

@@ -22,4 +21,4 @@ This section demonstrates setting up a backup and recovery scenario using a Barm
2221
3. Running a full backup
2322
4. Restoring a full backup
2423

25-
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.
24+
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
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,6 @@
22
title: "Backup and Recovery: Single-Server Streaming - Installing and Configuring Barman"
33
description: "Installing Barman on an Ubuntu-based backup server, creating a configuration file and testing the connection"
44
navTitle: "Barman Installation & Configuration"
5-
product: barman
6-
platform: ubuntu
75
tags:
86
- ubuntu
97
- barman

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

-2
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,6 @@
22
title: "Backup and Recovery: Single-Server Streaming - Running a Base Backup"
33
description: "Running a full backup using Barman"
44
navTitle: "Base Backup"
5-
product: barman
6-
platform: ubuntu
75
tags:
86
- ubuntu
97
- barman

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

-2
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,6 @@
22
title: "Backup and Recovery: Single-Server Streaming - Recovery"
33
description: "Recovering from data loss by using Barman to restore a full backup remotely"
44
navTitle: "Restore"
5-
product: barman
6-
platform: ubuntu
75
tags:
86
- ubuntu
97
- barman

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

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,9 @@
22
title: pgAdmin
33
navTitle: pgAdmin
44
description: EDB supports pgAdmin.
5-
product: pgAdmin
65
directoryDefaults:
76
iconName: postgresql
7+
product: pgAdmin
88
---
99

1010
pgAdmin is an open source, multi-platform console for PostgreSQL management and administration.

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

-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
11
---
22
title: 'Installation'
33
description: 'Instructions for installing pgBackRest on supported systems, including EDB Postgres Advanced Server'
4-
product: 'pgBackRest'
54
tags:
65
- installation
76
- EPAS

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

-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
11
---
22
title: 'Quick Start'
33
description: "A walkthrough: configuring pgBackRest, then running, examining and restoring a backup of a database cluster"
4-
product: 'pgBackRest'
54
tags:
65
- configuration
76
- backup

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

-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
11
---
22
title: 'Recommended Settings'
33
description: "Recommendations & rationale for pgBackRest configuration settings"
4-
product: 'pgBackRest'
54
---
65

76
This section walks you through the recommended settings while using pgBackRest.

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

-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
11
---
22
title: 'Retention Policy'
33
description: "Configuration options and considerations for the removal of obsolete backups and WAL archives"
4-
product: 'pgBackRest'
54
---
65

76
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

-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,6 @@
22
title: 'Use Case 1: Running pgBackRest Locally on the Database Host'
33
navTitle: 'Use Case 1'
44
description: "Examines a configuration used to run pgBackRest locally, on the database host"
5-
product: 'pgBackRest'
65
tags:
76
- configuration
87
- pgBackRest

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

-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,6 @@
22
title: 'Use Case 2: Running pgBackRest from a Dedicated Repository Host'
33
navTitle: 'Use Case 2'
44
description: "Examines a configuration used to run pgBackRest from a dedicated repository host"
5-
product: 'pgBackRest'
65
tags:
76
- configuration
87
- pgBackRest

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

-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
11
---
22
title: 'Appendix'
33
description: "Definitions for terms and concepts used in this guide, along with notes on configuration terminology"
4-
product: 'pgBackRest'
54
---
65

76
### Concepts

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

-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,6 @@
22
title: 'Frequently Asked Questions'
33
navTitle: 'FAQ'
44
description: 'Answers to Frequently Asked Questions'
5-
product: 'pgBackRest'
65
---
76

87
- 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-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
11
---
22
title: 'pgBackRest'
33
description: 'Introduction to pgBackRest, a reliable PostgreSQL backup & restore tool'
4-
product: 'pgBackRest'
54
tags:
65
- backup
76
- restore
@@ -10,6 +9,7 @@ tags:
109
indexCards: simple
1110
directoryDefaults:
1211
iconName: 'postgressupport'
12+
product: 'pgBackRest'
1313
---
1414

1515
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

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,9 @@
22
title: PostgreSQL
33
navTitle: PostgreSQL
44
description: EDB supports PostgreSQL.
5-
product: PostgreSQL
65
directoryDefaults:
76
iconName: postgresql
7+
product: PostgreSQL
88
---
99

1010
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
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
11
---
22
title: "Requirements Overview"
3-
product: PostgreSQL
43
legacyRedirects:
54
- "/edb-docs/d/postgresql/installation-getting-started/installation-guide/13.0/requirements_overview.html"
65
---

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

-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
11
---
22
title: "Invoking the Graphical Installer"
3-
product: PostgreSQL
43
legacyRedirects:
54
- "/edb-docs/d/postgresql/installation-getting-started/installation-guide/13.0/invoking_the_graphical_installer.html"
65
---

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

-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
11
---
22
title: "Installing PostgreSQL with the Graphical Installation Wizard"
3-
product: PostgreSQL
43
legacyRedirects:
54
- "/edb-docs/d/postgresql/installation-getting-started/installation-guide/13.0/installing_postgresql_with_the_graphical_installation_wizard.html"
65
---

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

-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
11
---
22
title: "Using Stack Builder"
3-
product: PostgreSQL
43
legacyRedirects:
54
- "/edb-docs/d/postgresql/installation-getting-started/installation-guide/13.0/using_stackbuilder.html"
65
---

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

-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
11
---
22
title: "Installation Troubleshooting"
3-
product: PostgreSQL
43
legacyRedirects:
54
- "/edb-docs/d/postgresql/installation-getting-started/installation-guide/13.0/installation_troubleshooting.html"
65
---

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

-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
11
---
22
title: "Uninstalling PostgreSQL"
3-
product: PostgreSQL
43
legacyRedirects:
54
- "/edb-docs/d/postgresql/installation-getting-started/installation-guide/13.0/uninstalling_postgresql.html"
65
---

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

-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
11
---
22
title: "EDB Installers"
33
description: "The PostgreSQL installers created by EnterpriseDB are designed to make it quick and simple to install PostgreSQL on your computer."
4-
product: PostgreSQL
54
---
65

76
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

+13
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
version: '3.8'
2+
3+
services:
4+
pdf-builder:
5+
build:
6+
context: ../
7+
dockerfile: docker/images/Dockerfile.pdf-builder
8+
image: edb/x-docs-pdf-builder
9+
container_name: pdf-builder
10+
hostname: pdf-builder
11+
working_dir: /app
12+
volumes:
13+
- ../:/app

‎docker/images/Dockerfile.pdf-builder

+27
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
FROM ubuntu:focal
2+
3+
ARG PANDOC_VERSION=2.12
4+
ARG PANDOC_DEB=pandoc-2.12-1-amd64.deb
5+
ARG WKHTML_TO_PDF_VERSION=0.12.6-1
6+
ARG WKHTML_TO_PDF_DEB=wkhtmltox_${WKHTML_TO_PDF_VERSION}.focal_amd64.deb
7+
8+
RUN apt-get update && apt-get install --no-install-recommends -y \
9+
python3 \
10+
wget \
11+
&& apt-get clean \
12+
&& rm -rf /var/lib/apt/lists/*
13+
14+
# Install Pandoc
15+
RUN wget --no-check-certificate -P /tmp https://github.com/jgm/pandoc/releases/download/${PANDOC_VERSION}/${PANDOC_DEB} \
16+
&& apt-get install --no-install-recommends -y /tmp/${PANDOC_DEB} \
17+
&& apt-get clean \
18+
&& rm -rf /var/lib/apt/lists/* \
19+
&& rm -rf /tmp/*
20+
21+
# Install wkhtmltopdf
22+
RUN wget --no-check-certificate -P /tmp https://github.com/wkhtmltopdf/packaging/releases/download/${WKHTML_TO_PDF_VERSION}/${WKHTML_TO_PDF_DEB} \
23+
&& apt-get update \
24+
&& apt-get install --no-install-recommends -y /tmp/${WKHTML_TO_PDF_DEB} \
25+
&& apt-get clean \
26+
&& rm -rf /var/lib/apt/lists/* \
27+
&& rm -rf /tmp/*

‎gatsby-config.js

+5-1
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ const ANSI_STOP = '\033[0m';
1111

1212
const isBuild = process.env.NODE_ENV === 'production';
1313
const isProduction = process.env.APP_ENV === 'production';
14-
const algoliaIndex = process.env.ALGOLIA_INDEX_NAME || 'edb-docs-staging';
14+
const algoliaIndex = process.env.ALGOLIA_INDEX_NAME || 'edb-docs-test';
1515

1616
/******** Sourcing *********/
1717
const sourceFilename = isBuild ? 'build-sources.json' : 'dev-sources.json';
@@ -111,6 +111,10 @@ const indexQuery = `
111111
product
112112
platform
113113
tags
114+
directoryDefaults {
115+
product
116+
platform
117+
}
114118
}
115119
id
116120
fields {

‎gatsby-node.js

+2
Original file line numberDiff line numberDiff line change
@@ -104,6 +104,8 @@ exports.createPages = async ({ actions, graphql, reporter }) => {
104104
description
105105
prevNext
106106
iconName
107+
product
108+
platform
107109
}
108110
}
109111
fields {

‎package.json

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

0 commit comments

Comments
 (0)