From 4071dcfa236a09101c3cfdeb38d92854da414765 Mon Sep 17 00:00:00 2001 From: drothery-edb Date: Mon, 13 Jun 2022 16:06:27 -0400 Subject: [PATCH 01/19] Markdown guide --- docs/how-tos/markdown-tips.md | 180 ++++++++++++++++++++++++++++++++++ 1 file changed, 180 insertions(+) create mode 100644 docs/how-tos/markdown-tips.md diff --git a/docs/how-tos/markdown-tips.md b/docs/how-tos/markdown-tips.md new file mode 100644 index 00000000000..ba614bb5eff --- /dev/null +++ b/docs/how-tos/markdown-tips.md @@ -0,0 +1,180 @@ +EDB Docs + +This topic provides tips on using Markdown in the Docs 2.0 framework. We have done some tuning to turn basic Markdown into high-performance markup. + +Links: +[Markdown getting started]https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax - not everything applies +Exceptions: + +Style Guide links: +### Style Guide for EDB contributors + +See [EDB documentation style guide](https://enterprisedb.atlassian.net/wiki/spaces/DCBC/pages/2387870239/Documentation+Style+Guide). + + +## Ordering of files + +By default, the items in the left nav are sorted alphabetically by file name. This can be done with a numerical prefix. The titles of each page are used for the names in the left nav. Historically, this was the only way you could control the order of the topics in the PDFs. This is no longer required and instead you can specify the order of topics in the frontmatter of the index file using the navigation option. For example, + +``` +--- +title: "Getting started" +indexCards: simple +navigation: + - identity_provider + - preparing_cloud_account + - creating_a_cluster +--- +``` + +# MDX Format + +Documentation must be formatted as an [MDX file](https://www.gatsbyjs.com/docs/mdx/writing-pages/) with the `.mdx` extension. MDX is a superset of [Markdown](https://www.markdownguide.org/). + +## Frontmatter + +Each document requires a [YAML](https://yaml.org) frontmatter section at the top with a title: + +``` +--- +title: Title of page +--- +``` + +If the title contains [special characters](https://stackoverflow.com/questions/19109912/yaml-do-i-need-quotes-for-strings-in-yaml), it will need to be quoted. There also needs to be a space after `title:` + +In addition to `title`, frontmatter may optionally include `navTitle` and `description`: + +``` +--- +title: An exhaustive guide to all things wonderful about Postgres +navTitle: Postgres guide +description: Everything you need to know about Postgres +--- +``` + +The `navTitle` is used for the left navigation so it can take up less space. It is also used in "cards". + +The `description` is used in cards as well. + +You can also use `navigation` to specify [file ordering](#0rdering_of_files). + + +## Redirects + +The app is concerned with two different types of redirects that can be defined in frontmatter. + +### Internal Redirects (within Docs 2.0) + +_For specific examples of when to use redirects, see: [How to avoid breaking links when reorganizing, consolidating or deprecating content](docs/how-tos/avoid-breaking-links.md)._ + +#### `redirects` + +The `redirects` frontmatter is to be used for redirects internal to Docs. For example, if you had a file `great_file.mdx` with this following frontmatter... + +```yaml +redirects: + - "/old_path" + - "/another_old_path" +``` + +both `/old_path` and `/another_old_path` would redirect to `great_file.mdx`'s current path. This is perfect for setting up redirects when moving a file around within Docs. Redirects created with `redirects` are permanent (301). + +These paths can be absolute (starting with the root of the site) or relative (to the file in which they are contained). For a `/file/at/path/`, + +- Absolute: `/path/to/file/` - redirects requests for /path/to/file to /file/at/path/ +- Relative: `former_child/` - redirects requests for /file/at/path/former_child/ to /file/at/path/ +- Relative: `../sibling/` - redirects requests for /file/at/sibling/ to /file/at/path/ + +#### Netlify-specific redirects + +Netlify is the hosting service we use for Docs. Netlify-specific redirects can be found in [`/static/_redirects`](static/_redirects). These are generally used for large-scale redirects, such as when renaming or removing an entire product version. + +### Docs 1.0 to Docs 2.0 redirects + +This app builds a list of server-side redirects that reference the Docs 1.0 path (`/edb-docs/`). These redirects direct users from links to the old docs site, to the appropriate page on the new docs site. + +#### `legacyRedirectsGenerated` + +This frontmatter is an automatically generated list of redirects for Docs 1.0 to Docs 2.0 (this repo). These redirects are built by `scripts/legacy_redirects/add_legecy_redirects.py`, and **should not be manually edited**. + +#### `legacyRedirects` + +If you need to setup a redirect from Docs 1.0 to Docs 2.0 manually, this is the place to do it. If the `legacyRedirectsGenerated` frontmatter does not include the redirect you need, you should add it here. + +## Markdown styling + +All of these files use Markdown for styling. The options for what can be done can be seen [here](https://github.com/EnterpriseDB/docs/blob/master/advocacy_docs/playground/1/01_examples/index.mdx) + +## Headings +Use headings to create a hierarchy for readers to navigate to more easily find information. + +Headings are denoted by number signs (#) followed by one space. Enter a line break between a heading and its content. EDB docs use Heading 2 (##), Heading 3 (###) and Heading 4 (####). Use Heading 4 sparingly. + +Heading 1 is reserved for page titles. + +Examples: + +``` +## This is heading 2 + +### And this is heading 3 +``` +## Linking +Stuff about this in style guide +## Lists +Stuff about this in style guide +## Tables +Stuff about this in style guide +## Inline code +Stuff about this in style guide +## Code blocks +Stuff about this in style guide +Josh to link to supported languages +## Admonitions (Notes, Warnings, etc.) + +If you need to draw attention to information, consider using an admonition: + +``` +!!! Note Optional title + This is text you'd like the reader to notice. +``` + +Admonitions begin with the `!!!` signifier. Next comes a (case-insensitive) type which is one of: + +- important +- tip +- note +- caution +- warning + +There are several [aliases](https://github.com/elviswolcott/remark-admonitions#usage): + +- info => important +- success => tip +- secondary => note +- danger => warning +- seealso => note +- hint => tip + +Titles are optional. If you don't include one, the admonition will default to the type name ("Important", "Tip", etc.). + +The body of the admonition is indented 4 spaces. It should line up with the first letter of the admonition type. Alternatively, fenced admonitions that begin and end with `!!!` lines are supported: + +``` +!!! Tip +Use fenced admonitions to avoid space counting. +!!! +``` + +For examples of what you can do with admonitions, see [this demo](https://github.com/EnterpriseDB/docs/blob/main/advocacy_docs/playground/1/01_examples/admonitions.mdx). + +## Block quotes + +## Inserting images +## Using HTML +## Emphasis + Bold and italic + + + From b33e90fde9253dbfb5966ed1a86422a2391e2166 Mon Sep 17 00:00:00 2001 From: Dee Dee Rothery <83650384+drothery-edb@users.noreply.github.com> Date: Mon, 27 Jun 2022 14:36:36 -0400 Subject: [PATCH 02/19] Minor edits --- docs/how-tos/markdown-tips.md | 9 ++++++++- 1 file changed, 8 insertions(+), 1 deletion(-) diff --git a/docs/how-tos/markdown-tips.md b/docs/how-tos/markdown-tips.md index ba614bb5eff..858dec5ae88 100644 --- a/docs/how-tos/markdown-tips.md +++ b/docs/how-tos/markdown-tips.md @@ -19,7 +19,6 @@ By default, the items in the left nav are sorted alphabetically by file name. Th ``` --- title: "Getting started" -indexCards: simple navigation: - identity_provider - preparing_cloud_account @@ -124,6 +123,11 @@ Examples: Stuff about this in style guide ## Lists Stuff about this in style guide +don't use tabs +1. Text + 1. sdfsdf + + ## Tables Stuff about this in style guide ## Inline code @@ -172,7 +176,10 @@ For examples of what you can do with admonitions, see [this demo](https://github ## Block quotes ## Inserting images +Show an example of the syntax we use in docs - don't use html ## Using HTML +limited - as needed - example in the partners for the landing - it needed html to work correctly +Using breaks in tables
## Emphasis Bold and italic From bdb8b44e3d5c1905a824c77e6d3cac487d283139 Mon Sep 17 00:00:00 2001 From: Chris Estes <106166814+ccestes@users.noreply.github.com> Date: Mon, 27 Jun 2022 16:54:56 -0400 Subject: [PATCH 03/19] Inserting Images --- docs/how-tos/markdown-tips.md | 11 ++++++++++- 1 file changed, 10 insertions(+), 1 deletion(-) diff --git a/docs/how-tos/markdown-tips.md b/docs/how-tos/markdown-tips.md index 858dec5ae88..ce65b797ec7 100644 --- a/docs/how-tos/markdown-tips.md +++ b/docs/how-tos/markdown-tips.md @@ -176,7 +176,16 @@ For examples of what you can do with admonitions, see [this demo](https://github ## Block quotes ## Inserting images -Show an example of the syntax we use in docs - don't use html + +Don't use HTML to insert images in your content. Instead, use Markdown syntax that begins with an exclamation mark, followed by a title in brackets, and the image's file path in parentheses. For example: + +``` +![Comparison with Oracle Call Interface](../images/oracle_call_interface.png) +``` +The image's title, Comparison with Oracle Call Interface, appears when hovering over the image. The title should be descriptive and concise for accessibility purposes. + +The image's file path depends on the location of your Markdown content. In the example, the image's file path, ../images/oracle_call_interface.png, leads out of its folder and into the images folder, where oracle_call_interface.png is located. Your path should also lead to the corresponding images folder, where your image is located. + ## Using HTML limited - as needed - example in the partners for the landing - it needed html to work correctly Using breaks in tables
From 261df9bfc5a17e37a24b5946c9e85d57dde9c9a1 Mon Sep 17 00:00:00 2001 From: Chris Estes <106166814+ccestes@users.noreply.github.com> Date: Wed, 29 Jun 2022 14:05:29 -0400 Subject: [PATCH 04/19] Lists Added some procedural information about lists not covered in the style guide --- docs/how-tos/markdown-tips.md | 17 +++++++++++------ 1 file changed, 11 insertions(+), 6 deletions(-) diff --git a/docs/how-tos/markdown-tips.md b/docs/how-tos/markdown-tips.md index ce65b797ec7..2b55437579e 100644 --- a/docs/how-tos/markdown-tips.md +++ b/docs/how-tos/markdown-tips.md @@ -123,10 +123,15 @@ Examples: Stuff about this in style guide ## Lists Stuff about this in style guide -don't use tabs -1. Text - 1. sdfsdf +Lists appear with an indent by default. If you format a list with no indent, Markdown formats the list with an indent on the page. For example, the first list item in the example below appears with an indent on the page. + +If you want to make a nested list, don't use tab to indent. Press space three times to make an indent. For example: + +```text +- A list item. + - Instead of tab, I pressed space three times to indent this nested list item. +``` ## Tables Stuff about this in style guide @@ -179,12 +184,12 @@ For examples of what you can do with admonitions, see [this demo](https://github Don't use HTML to insert images in your content. Instead, use Markdown syntax that begins with an exclamation mark, followed by a title in brackets, and the image's file path in parentheses. For example: -``` +```text ![Comparison with Oracle Call Interface](../images/oracle_call_interface.png) ``` -The image's title, Comparison with Oracle Call Interface, appears when hovering over the image. The title should be descriptive and concise for accessibility purposes. +The image's title, Comparison with Oracle Call Interface, appears when hovering over the image. Use a descriptive and concise title for accessibility purposes. -The image's file path depends on the location of your Markdown content. In the example, the image's file path, ../images/oracle_call_interface.png, leads out of its folder and into the images folder, where oracle_call_interface.png is located. Your path should also lead to the corresponding images folder, where your image is located. +The image's file path depends on the location of your Markdown content. In the example, the image's file path, ../images/oracle_call_interface.png, leads out of its folder (../) and into the images folder (images/), where oracle_call_interface.png is located. Your path must lead to the corresponding images folder where your image is located. ## Using HTML limited - as needed - example in the partners for the landing - it needed html to work correctly From fd3ce7dee7a0090ad353b76f5543deaaeaacb0fb Mon Sep 17 00:00:00 2001 From: Josh Heyer Date: Wed, 17 Aug 2022 03:59:33 +0000 Subject: [PATCH 05/19] Add some notes on code blocks, misc --- docs/how-tos/markdown-tips.md | 76 ++++++++++++++++++++++++++++++----- 1 file changed, 65 insertions(+), 11 deletions(-) diff --git a/docs/how-tos/markdown-tips.md b/docs/how-tos/markdown-tips.md index 2b55437579e..567923b1d0b 100644 --- a/docs/how-tos/markdown-tips.md +++ b/docs/how-tos/markdown-tips.md @@ -3,7 +3,9 @@ This topic provides tips on using Markdown in the Docs 2.0 framework. We have done some tuning to turn basic Markdown into high-performance markup. Links: -[Markdown getting started]https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax - not everything applies + +[Markdown getting started](https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax) - not everything applies + Exceptions: Style Guide links: @@ -110,17 +112,41 @@ Use headings to create a hierarchy for readers to navigate to more easily find i Headings are denoted by number signs (#) followed by one space. Enter a line break between a heading and its content. EDB docs use Heading 2 (##), Heading 3 (###) and Heading 4 (####). Use Heading 4 sparingly. -Heading 1 is reserved for page titles. +## Headers: -Examples: +Specify a header by puttihng one or more hashes (`#`) at the start of a line. Headers should be a single line, separated by blank lines from the rest of the document, and cannot contain HTML. -``` -## This is heading 2 +All headers in Docs result in "anchors", IDs that can be linked to directly based on the text of the header. This is handy for providing quick access to definitions and allowing search results to link directly to the relevant section of a page. + +### `# H1` + +This is the page title, and there should be only one. + +**Never use this in Docs** - set the title using `title:` in the [frontmatter](#frontmatter). + +### `## H2` + +Sections - use this for indicating sub-topics within the page's overall topic. + +In Docs, H2 headers generate an entry in the right-hand "table of contents", allowing the reader to quickly scan the outline of the page and jump to a relevant section. + +### `### H3` + +Subsections - use this for breaking up longer sections into logically-distinct thoughts or concepts. Also useful for definition lists (e.g. a glossary). + +### `#### H4` + +If you find yourself needing to use this, you might want to consider breaking up the topic into multiple pages... -### And this is heading 3 -``` ## Linking -Stuff about this in style guide + +Markdown supports two different syntaxes for links. In Docs, we use inline links exclusively. The syntax is: + +`[text](URL "title text")`, where "title text" is optional (it can be used to add a more detailed description of a link, such as the full title of the page it links to). + +URL can be absolute (`https://example.com/path/to/page`) or relative (`/epas/latest/page`, `../sibling`) - for links *within* docs, use relative links (but avoid complicated path-walking if possible, e.g. use `/pem/latest/page` instead of `../../..page`). + +More stuff about this in style guide ## Lists Stuff about this in style guide @@ -136,10 +162,38 @@ If you want to make a nested list, don't use tab to indent. Press space three ti ## Tables Stuff about this in style guide ## Inline code -Stuff about this in style guide +Use inline code `code` for keywords, verbatim expressions, etc. Markdown between the backtics won't be rendered, so there's no need to escape special characters. To inclue a backtick within inline code, use more than one backtic to enclode it: ``code `code` code``. + +More stuff about this in style guide ## Code blocks -Stuff about this in style guide -Josh to link to supported languages + +````markdown + +```sql +select 'a block of code' as result; +``` +```` + +Use blocks of code for complete commands (even if only a single line), and all multi-line code or command listings. Specify a language tag (e.g. `sql`) at the opening "fence" (```` ``` ````) to indicate the type of code being listed (and enable syntax highlighting for that block). Supported languages: https://prismjs.com/#supported-languages + +Some code blocks consist of code or commands followed by program output: use the special sequence `__OUTPUT__` (on a line by itself) to visually separate the output and prevent it from being syntax-highlighted. + +More stuff about this in style guide + +### Code block style guidelines + +Readability is king - it may be code, but its target is a human reader, not a machine! To that end, pay attention to how code appears and take time to reformat or reorganize it when its meaning becomes difficult to grasp. + +Try to avoid mixing `__OUTPUT__` and multiple, consecutive code blocks. When possible, divide a sequence of commands into discrete steps - the output of each can then be shown. When multiple commands are effectively "atomic" (e.g., two steps always performed together, the output of one command fed directly into the next, etc.) then describe their purpose before showing them together - as they would be typed / entered - and list the output of both together. + +Three conventions should be used in these docs for shell code blocks: + +1. Do not lead with a "prompt" (such as `$` or `#`) - if copy-pasted, these will lead to either "command not found" or a no-op, both which are confusing. + +2. Separate command output from the command(s) themselves by using `__OUTPUT__` (described above). + +3. Break long lines in a consistent and visually-appealing fashion to aid in reading long commands. 70 characters give or take is a good rule of thumb - if more than two lines, might as well go with one parameter per line. Use line continuation characters to accomplish this (e.g. [windows](https://superuser.com/questions/150116/how-can-i-insert-a-new-line-in-a-cmd-exe-command), [linux](https://unix.stackexchange.com/questions/571301/when-to-use-line-continuation-character-and-when-not/571313#571313)). + ## Admonitions (Notes, Warnings, etc.) If you need to draw attention to information, consider using an admonition: From 7ba3c666e7b8c4d019204e80ebdd25e78f0a8354 Mon Sep 17 00:00:00 2001 From: Betsy Gitelman <93718720+ebgitelman@users.noreply.github.com> Date: Tue, 2 May 2023 16:43:55 -0400 Subject: [PATCH 06/19] Preliminary edits to this content --- docs/how-tos/markdown-tips.md | 129 ++++++++++++++++++---------------- 1 file changed, 68 insertions(+), 61 deletions(-) diff --git a/docs/how-tos/markdown-tips.md b/docs/how-tos/markdown-tips.md index 567923b1d0b..7899f27376f 100644 --- a/docs/how-tos/markdown-tips.md +++ b/docs/how-tos/markdown-tips.md @@ -1,6 +1,6 @@ EDB Docs -This topic provides tips on using Markdown in the Docs 2.0 framework. We have done some tuning to turn basic Markdown into high-performance markup. +These tips help with using Markdown in the Docs 2.0 framework. We've done some tuning to turn basic Markdown into high-performance markup. Links: @@ -8,15 +8,20 @@ Links: Exceptions: -Style Guide links: -### Style Guide for EDB contributors +Style guide links: +### Style guide for EDB contributors -See [EDB documentation style guide](https://enterprisedb.atlassian.net/wiki/spaces/DCBC/pages/2387870239/Documentation+Style+Guide). +Our style guide provides comprehensive information about our technical writing standards. See [EDB documentation style guide](https://enterprisedb.atlassian.net/wiki/spaces/DCBC/pages/2387870239/Documentation+Style+Guide). However, for developers, this list of rules summarizes most of what you need to know. Your text will be edited by a technical editor, but following these rules reduces the amount of time the editor needs to spend on unnecessary issues. + +| Topic | Guideline | Notes +|--------------|-------------------|-----------------------------------| +| Contractions | Use contractions. | +| Future tense | Don't use except when referring to a future release, for example, "This feature will be deprecated in a future release. | Search your file for the word "will" and revise to a simple form of present tense. | ## Ordering of files -By default, the items in the left nav are sorted alphabetically by file name. This can be done with a numerical prefix. The titles of each page are used for the names in the left nav. Historically, this was the only way you could control the order of the topics in the PDFs. This is no longer required and instead you can specify the order of topics in the frontmatter of the index file using the navigation option. For example, +By default, the items in the left nav are sorted alphabetically by file name. This can be done with a numerical prefix. The titles of each page are used for the names in the left nav. Historically, this was the only way to control the order of the topics in the PDFs. This is no longer required and instead you can specify the order of topics in the frontmatter of the index file using the navigation option. For example: ``` --- @@ -28,13 +33,13 @@ navigation: --- ``` -# MDX Format +# MDX format Documentation must be formatted as an [MDX file](https://www.gatsbyjs.com/docs/mdx/writing-pages/) with the `.mdx` extension. MDX is a superset of [Markdown](https://www.markdownguide.org/). -## Frontmatter +## Front matter -Each document requires a [YAML](https://yaml.org) frontmatter section at the top with a title: +Each document requires a [YAML](https://yaml.org) front matter section at the top with a title: ``` --- @@ -42,9 +47,9 @@ title: Title of page --- ``` -If the title contains [special characters](https://stackoverflow.com/questions/19109912/yaml-do-i-need-quotes-for-strings-in-yaml), it will need to be quoted. There also needs to be a space after `title:` +If the title contains [special characters](https://stackoverflow.com/questions/19109912/yaml-do-i-need-quotes-for-strings-in-yaml), you need to use quotes around it. Also include a space after `title:` -In addition to `title`, frontmatter may optionally include `navTitle` and `description`: +In addition to `title`, front matter can optionally include `navTitle` and `description`: ``` --- @@ -54,24 +59,24 @@ description: Everything you need to know about Postgres --- ``` -The `navTitle` is used for the left navigation so it can take up less space. It is also used in "cards". +The `navTitle` is used for the left navigation so it can take up less space. It's also used in cards. The `description` is used in cards as well. -You can also use `navigation` to specify [file ordering](#0rdering_of_files). +You can also use `navigation` to specify [file ordering](#ordering_of_files). ## Redirects -The app is concerned with two different types of redirects that can be defined in frontmatter. +The app is concerned with two different types of redirects that you can define in frontmatter. -### Internal Redirects (within Docs 2.0) +### Internal redirects (in Docs 2.0) -_For specific examples of when to use redirects, see: [How to avoid breaking links when reorganizing, consolidating or deprecating content](docs/how-tos/avoid-breaking-links.md)._ +For specific examples of when to use redirects, see: [How to avoid breaking links when reorganizing, consolidating, or deprecating content](docs/how-tos/avoid-breaking-links.md). #### `redirects` -The `redirects` frontmatter is to be used for redirects internal to Docs. For example, if you had a file `great_file.mdx` with this following frontmatter... +Use `redirects` in front matter for redirects internal to Docs. For example, suppose you had a file `great_file.mdx` with this front matter: ```yaml redirects: @@ -79,75 +84,73 @@ redirects: - "/another_old_path" ``` -both `/old_path` and `/another_old_path` would redirect to `great_file.mdx`'s current path. This is perfect for setting up redirects when moving a file around within Docs. Redirects created with `redirects` are permanent (301). +In this case, both `/old_path` and `/another_old_path` redirect to the current path of `great_file.mdx`. This encoding is useful for setting up redirects when moving a file around within Docs. Redirects created with `redirects` are permanent (301). -These paths can be absolute (starting with the root of the site) or relative (to the file in which they are contained). For a `/file/at/path/`, +These paths can be absolute, starting with the root of the site. Or they can relative to the file that contains them. For example, for `/file/at/path/`: -- Absolute: `/path/to/file/` - redirects requests for /path/to/file to /file/at/path/ -- Relative: `former_child/` - redirects requests for /file/at/path/former_child/ to /file/at/path/ -- Relative: `../sibling/` - redirects requests for /file/at/sibling/ to /file/at/path/ +- Absolute: `/path/to/file/` — Redirects requests for `/path/to/file` to `/file/at/path/`. +- Relative: `former_child/` — Redirects requests for `/file/at/path/former_child/` to `/file/at/path/`. +- Relative: `../sibling/` — Redirects requests for `/file/at/sibling/` to `/file/at/path/`. #### Netlify-specific redirects -Netlify is the hosting service we use for Docs. Netlify-specific redirects can be found in [`/static/_redirects`](static/_redirects). These are generally used for large-scale redirects, such as when renaming or removing an entire product version. +Netlify is the hosting service we use for Docs. You can find Netlify-specific redirects in [`/static/_redirects`](static/_redirects). These are generally used for large-scale redirects, such as when renaming or removing an entire product version. ### Docs 1.0 to Docs 2.0 redirects -This app builds a list of server-side redirects that reference the Docs 1.0 path (`/edb-docs/`). These redirects direct users from links to the old docs site, to the appropriate page on the new docs site. +This app builds a list of server-side redirects that reference the Docs 1.0 path (`/edb-docs/`). These redirects direct users from links to the old docs site to the appropriate page on the new docs site. #### `legacyRedirectsGenerated` -This frontmatter is an automatically generated list of redirects for Docs 1.0 to Docs 2.0 (this repo). These redirects are built by `scripts/legacy_redirects/add_legecy_redirects.py`, and **should not be manually edited**. +This front matter is a generated list of redirects for Docs 1.0 to Docs 2.0 (this repo). These redirects are built by `scripts/legacy_redirects/add_legecy_redirects.py`. + +!!! Warning + Don't manually edit these redirects. #### `legacyRedirects` -If you need to setup a redirect from Docs 1.0 to Docs 2.0 manually, this is the place to do it. If the `legacyRedirectsGenerated` frontmatter does not include the redirect you need, you should add it here. +If you need to set up a redirect from Docs 1.0 to Docs 2.0 manually, this is the place to do it. If the `legacyRedirectsGenerated` front matter doesn't include the redirect you need, add it here. ## Markdown styling -All of these files use Markdown for styling. The options for what can be done can be seen [here](https://github.com/EnterpriseDB/docs/blob/master/advocacy_docs/playground/1/01_examples/index.mdx) +All of these files use Markdown for styling. The options for what you can do are [here](https://github.com/EnterpriseDB/docs/blob/master/advocacy_docs/playground/1/01_examples/index.mdx) ## Headings -Use headings to create a hierarchy for readers to navigate to more easily find information. - -Headings are denoted by number signs (#) followed by one space. Enter a line break between a heading and its content. EDB docs use Heading 2 (##), Heading 3 (###) and Heading 4 (####). Use Heading 4 sparingly. - -## Headers: -Specify a header by puttihng one or more hashes (`#`) at the start of a line. Headers should be a single line, separated by blank lines from the rest of the document, and cannot contain HTML. +Use headings to create a hierarchy for readers to navigate to more easily find information. -All headers in Docs result in "anchors", IDs that can be linked to directly based on the text of the header. This is handy for providing quick access to definitions and allowing search results to link directly to the relevant section of a page. +Headings are denoted by two to four number signs (#) followed by one space. Enter an extra line break between the heading and the text content. EDB docs use Heading 2 (##), Heading 3 (###) and Heading 4 (####). Use Heading 4 sparingly. -### `# H1` +All headers in Docs result in anchors, which are IDs that you can link to directly. They are formed by using the header text, using hyphens in place of spaces. This mechanism is handy for providing quick access to definitions and allowing search results to link directly to the relevant section of a page. -This is the page title, and there should be only one. +### `# H1` - Not used in Docs -**Never use this in Docs** - set the title using `title:` in the [frontmatter](#frontmatter). +In Markdown, a single number sign signifies the page title (one per file). However, in Docs, we instead set the page title using `title:` in the [front matter](#front-matter). ### `## H2` -Sections - use this for indicating sub-topics within the page's overall topic. +Use an H2 section head to indicate a sub-topic in the page's overall topic. -In Docs, H2 headers generate an entry in the right-hand "table of contents", allowing the reader to quickly scan the outline of the page and jump to a relevant section. +In Docs, H2 headers generate an entry in the right-hand table of contents, allowing the reader to quickly scan the outline of the page and jump to a relevant section. ### `### H3` -Subsections - use this for breaking up longer sections into logically-distinct thoughts or concepts. Also useful for definition lists (e.g. a glossary). +Use an H3 subsection head to break up sections into logically distinct thoughts or concepts. Also useful for definition lists (e.g., a glossary). ### `#### H4` -If you find yourself needing to use this, you might want to consider breaking up the topic into multiple pages... - +If you find yourself needing to use this level heading, consider breaking the topic into multiple pages or otherwise reorganizing your information. ## Linking Markdown supports two different syntaxes for links. In Docs, we use inline links exclusively. The syntax is: -`[text](URL "title text")`, where "title text" is optional (it can be used to add a more detailed description of a link, such as the full title of the page it links to). +`[text](URL "title text")`, where "title text" is optional. You can use it to add a more detailed description of a link, such as the full title of the page it links to. -URL can be absolute (`https://example.com/path/to/page`) or relative (`/epas/latest/page`, `../sibling`) - for links *within* docs, use relative links (but avoid complicated path-walking if possible, e.g. use `/pem/latest/page` instead of `../../..page`). +The URL can be absolute (`https://example.com/path/to/page`) or relative (`/epas/latest/page`, `../sibling`). For links within docs, use relative links. However, avoid complicated path walking if possible. For example, use `/pem/latest/page` instead of `../../..page`). More stuff about this in style guide ## Lists + Stuff about this in style guide Lists appear with an indent by default. If you format a list with no indent, Markdown formats the list with an indent on the page. For example, the first list item in the example below appears with an indent on the page. @@ -174,33 +177,33 @@ select 'a block of code' as result; ``` ```` -Use blocks of code for complete commands (even if only a single line), and all multi-line code or command listings. Specify a language tag (e.g. `sql`) at the opening "fence" (```` ``` ````) to indicate the type of code being listed (and enable syntax highlighting for that block). Supported languages: https://prismjs.com/#supported-languages +Use blocks of code for complete commands (even if only a single line), and all multi-line code or command listings. Specify a language tag (such as `sql`) at the opening "fence" (```` ``` ````) to indicate the type of code being listed and enable syntax highlighting for that block. Supported languages: https://prismjs.com/#supported-languages -Some code blocks consist of code or commands followed by program output: use the special sequence `__OUTPUT__` (on a line by itself) to visually separate the output and prevent it from being syntax-highlighted. +Some code blocks consist of code or commands followed by program output. Use the special sequence `__OUTPUT__` (on a line by itself) to visually separate the output and prevent it from being syntax-highlighted. More stuff about this in style guide ### Code block style guidelines -Readability is king - it may be code, but its target is a human reader, not a machine! To that end, pay attention to how code appears and take time to reformat or reorganize it when its meaning becomes difficult to grasp. +Readability is king. It might be code, but its target is a human reader, not a machine. To that end, pay attention to how code appears, and take time to reformat or reorganize it when its meaning becomes difficult to grasp. -Try to avoid mixing `__OUTPUT__` and multiple, consecutive code blocks. When possible, divide a sequence of commands into discrete steps - the output of each can then be shown. When multiple commands are effectively "atomic" (e.g., two steps always performed together, the output of one command fed directly into the next, etc.) then describe their purpose before showing them together - as they would be typed / entered - and list the output of both together. +Try to avoid mixing `__OUTPUT__` and multiple, consecutive code blocks. When possible, divide a sequence of commands into discrete steps. You can then show the output of each. When multiple commands are effectively "atomic" (e.g., two steps always performed together, the output of one command fed directly into the next, etc.), then describe their purpose before showing them together - as they would be typed / entered - and list the output of both together. -Three conventions should be used in these docs for shell code blocks: +Use these three conventions in these docs for shell code blocks: -1. Do not lead with a "prompt" (such as `$` or `#`) - if copy-pasted, these will lead to either "command not found" or a no-op, both which are confusing. +1. Don't lead with a prompt, such as `$` or `#`. If the user copies and pastes a code example that includes a prompt, a "command not found" or no-op occurs, both which are confusing. -2. Separate command output from the command(s) themselves by using `__OUTPUT__` (described above). +2. Separate command output from the commands by using `__OUTPUT__` (described above). -3. Break long lines in a consistent and visually-appealing fashion to aid in reading long commands. 70 characters give or take is a good rule of thumb - if more than two lines, might as well go with one parameter per line. Use line continuation characters to accomplish this (e.g. [windows](https://superuser.com/questions/150116/how-can-i-insert-a-new-line-in-a-cmd-exe-command), [linux](https://unix.stackexchange.com/questions/571301/when-to-use-line-continuation-character-and-when-not/571313#571313)). +3. Break long lines in a consistent and visually appealing fashion to aid in reading long commands. About 70 characters is a good rule of thumb. With more than two lines, you might as well go with one parameter per line. Use line continuation characters to accomplish this (for example, [windows](https://superuser.com/questions/150116/how-can-i-insert-a-new-line-in-a-cmd-exe-command), [linux](https://unix.stackexchange.com/questions/571301/when-to-use-line-continuation-character-and-when-not/571313#571313)). -## Admonitions (Notes, Warnings, etc.) +## Admonitions (notes, warnings, etc.) If you need to draw attention to information, consider using an admonition: ``` !!! Note Optional title - This is text you'd like the reader to notice. + This is text you want the reader to notice. ``` Admonitions begin with the `!!!` signifier. Next comes a (case-insensitive) type which is one of: @@ -222,7 +225,9 @@ There are several [aliases](https://github.com/elviswolcott/remark-admonitions#u Titles are optional. If you don't include one, the admonition will default to the type name ("Important", "Tip", etc.). -The body of the admonition is indented 4 spaces. It should line up with the first letter of the admonition type. Alternatively, fenced admonitions that begin and end with `!!!` lines are supported: +Indent the body of the admonition four spaces. The body lines up with the first letter of the admonition type. + +Alternatively, fenced admonitions that begin and end with `!!!` lines are supported: ``` !!! Tip @@ -236,20 +241,22 @@ For examples of what you can do with admonitions, see [this demo](https://github ## Inserting images -Don't use HTML to insert images in your content. Instead, use Markdown syntax that begins with an exclamation mark, followed by a title in brackets, and the image's file path in parentheses. For example: +Don't use HTML to insert images in your content. Instead, use Markdown syntax that begins with an exclamation mark, followed by a title in brackets, and the image file path in parentheses. For example: ```text ![Comparison with Oracle Call Interface](../images/oracle_call_interface.png) ``` -The image's title, Comparison with Oracle Call Interface, appears when hovering over the image. Use a descriptive and concise title for accessibility purposes. +The image title, Comparison with Oracle Call Interface, appears when hovering over the image. Use a descriptive and concise title for accessibility purposes. -The image's file path depends on the location of your Markdown content. In the example, the image's file path, ../images/oracle_call_interface.png, leads out of its folder (../) and into the images folder (images/), where oracle_call_interface.png is located. Your path must lead to the corresponding images folder where your image is located. +The image file path depends on the location of your Markdown content. In the example, the image's file path, `../images/oracle_call_interface.png`, leads out of its folder (../) and into the images folder (images/), where `oracle_call_interface.png` is located. Your path must lead to the `images` folder where your image is located. ## Using HTML -limited - as needed - example in the partners for the landing - it needed html to work correctly -Using breaks in tables
-## Emphasis - Bold and italic +HTML use in Markdown documents is limited. An example is in the partners for the landing; it needed HTML to work correctly. + +You can use HTML to create line breaks in tables.: `
` +We also use character references where needed, such as `—` (em-dash), `–` (en-dash), and `<` (less-than sign, used to correspond with a > closing bracket). +## Font treatments +Bold and italic From 182dc495dfff395d45474dbee6eedb62540e1442 Mon Sep 17 00:00:00 2001 From: Betsy Gitelman <93718720+ebgitelman@users.noreply.github.com> Date: Thu, 4 May 2023 10:26:23 -0400 Subject: [PATCH 07/19] Additions to style guide section --- docs/how-tos/markdown-tips.md | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/docs/how-tos/markdown-tips.md b/docs/how-tos/markdown-tips.md index 7899f27376f..9fee16ebfc7 100644 --- a/docs/how-tos/markdown-tips.md +++ b/docs/how-tos/markdown-tips.md @@ -8,15 +8,16 @@ Links: Exceptions: -Style guide links: ### Style guide for EDB contributors -Our style guide provides comprehensive information about our technical writing standards. See [EDB documentation style guide](https://enterprisedb.atlassian.net/wiki/spaces/DCBC/pages/2387870239/Documentation+Style+Guide). However, for developers, this list of rules summarizes most of what you need to know. Your text will be edited by a technical editor, but following these rules reduces the amount of time the editor needs to spend on unnecessary issues. +Our style guide provides comprehensive information about our technical writing standards. See the [EDB documentation style guide](https://enterprisedb.atlassian.net/wiki/spaces/DCBC/pages/2387870239/Documentation+Style+Guide). However, for developers, this list of rules summarizes most of what you need to know. Your text will be edited by a technical editor, but following these rules reduces the amount of time the editor needs to spend on unnecessary issues. | Topic | Guideline | Notes |--------------|-------------------|-----------------------------------| -| Contractions | Use contractions. | -| Future tense | Don't use except when referring to a future release, for example, "This feature will be deprecated in a future release. | Search your file for the word "will" and revise to a simple form of present tense. | +| Contractions | Use contractions. | | +| Future tense | Don't use except when referring to a future release, for example, "This feature will be deprecated in a future release. | Search your file for the word "will" and revise to a simple form of present tense. | +| Modal verbs | Don't use (or use rarely). Modal verbs introduce uncertainty. | Search your file for "should," "could," or "would." Revise to eliminate these words: could -> can or might; should/would -> delete and change verb form. | + ## Ordering of files From 6b244877a095ece5d5261d0146b88410d16bed0d Mon Sep 17 00:00:00 2001 From: Betsy Gitelman <93718720+ebgitelman@users.noreply.github.com> Date: Thu, 11 May 2023 14:54:15 -0400 Subject: [PATCH 08/19] Added tips, edited --- docs/how-tos/markdown-tips.md | 92 ++++++++++++++++++++++------------- 1 file changed, 59 insertions(+), 33 deletions(-) diff --git a/docs/how-tos/markdown-tips.md b/docs/how-tos/markdown-tips.md index 9fee16ebfc7..5324d71eb4b 100644 --- a/docs/how-tos/markdown-tips.md +++ b/docs/how-tos/markdown-tips.md @@ -16,13 +16,22 @@ Our style guide provides comprehensive information about our technical writing s |--------------|-------------------|-----------------------------------| | Contractions | Use contractions. | | | Future tense | Don't use except when referring to a future release, for example, "This feature will be deprecated in a future release. | Search your file for the word "will" and revise to a simple form of present tense. | -| Modal verbs | Don't use (or use rarely). Modal verbs introduce uncertainty. | Search your file for "should," "could," or "would." Revise to eliminate these words: could -> can or might; should/would -> delete and change verb form. | +| Modal verbs | Don't use (or use rarely). Modal verbs introduce uncertainty. | Search your file for "should," "could," and "would." Revise to eliminate these words: could -> can or might; should/would -> delete and change verb form. | +| "May" | Replace with "can" or "might." | | +| Serial (Oxford) comma | Use the serial comma (for example: this, that, and the other) | | +| Semi-colons | Don't use semi-colons. Use two sentences instead. | | +| Latin expressions | Don't use. | Search for etc, i.e., e.g. and spell out or revise to eliminate | +We also don't refer to the documentation in terms of its structure, which we call "documenting the documentation." Don't use words like chapter, topic, or section. For example: +- This topic is about... + Instead, start talking about the feature or functionality. +- See the xyz section... + Instead, write, "See \[section name\]. ## Ordering of files -By default, the items in the left nav are sorted alphabetically by file name. This can be done with a numerical prefix. The titles of each page are used for the names in the left nav. Historically, this was the only way to control the order of the topics in the PDFs. This is no longer required and instead you can specify the order of topics in the frontmatter of the index file using the navigation option. For example: +By default, the items in the left nav are sorted alphabetically by file name. You can accomplish this with a numerical prefix. The titles of each page are used for the names in the left nav. Historically, this was the only way to control the order of the topics in the PDFs. This is no longer required. Instead, you can specify the order of topics in the front matter of the index file using the navigation option. For example: ``` --- @@ -36,7 +45,7 @@ navigation: # MDX format -Documentation must be formatted as an [MDX file](https://www.gatsbyjs.com/docs/mdx/writing-pages/) with the `.mdx` extension. MDX is a superset of [Markdown](https://www.markdownguide.org/). +Format documentation as an [MDX file](https://www.gatsbyjs.com/docs/mdx/writing-pages/) with the `.mdx` extension. MDX is a superset of [Markdown](https://www.markdownguide.org/). ## Front matter @@ -60,7 +69,7 @@ description: Everything you need to know about Postgres --- ``` -The `navTitle` is used for the left navigation so it can take up less space. It's also used in cards. +The `navTitle` is used for the left navigation so the text can take up less space. It's also used in cards. The `description` is used in cards as well. @@ -69,7 +78,7 @@ You can also use `navigation` to specify [file ordering](#ordering_of_files). ## Redirects -The app is concerned with two different types of redirects that you can define in frontmatter. +The app is concerned with two different types of redirects that you can define in front matter. ### Internal redirects (in Docs 2.0) @@ -87,7 +96,7 @@ redirects: In this case, both `/old_path` and `/another_old_path` redirect to the current path of `great_file.mdx`. This encoding is useful for setting up redirects when moving a file around within Docs. Redirects created with `redirects` are permanent (301). -These paths can be absolute, starting with the root of the site. Or they can relative to the file that contains them. For example, for `/file/at/path/`: +These paths can be absolute, starting with the root of the site. Or, they can be relative to the file that contains them. For example, for `/file/at/path/`: - Absolute: `/path/to/file/` — Redirects requests for `/path/to/file` to `/file/at/path/`. - Relative: `former_child/` — Redirects requests for `/file/at/path/former_child/` to `/file/at/path/`. @@ -110,19 +119,21 @@ This front matter is a generated list of redirects for Docs 1.0 to Docs 2.0 (thi #### `legacyRedirects` -If you need to set up a redirect from Docs 1.0 to Docs 2.0 manually, this is the place to do it. If the `legacyRedirectsGenerated` front matter doesn't include the redirect you need, add it here. +If you need to manually set up a redirect from Docs 1.0 to Docs 2.0, this is the place to do it. If the `legacyRedirectsGenerated` front matter doesn't include the redirect you need, add it here. ## Markdown styling -All of these files use Markdown for styling. The options for what you can do are [here](https://github.com/EnterpriseDB/docs/blob/master/advocacy_docs/playground/1/01_examples/index.mdx) +All of these files use Markdown for styling. The options for what you can do are [here](https://github.com/EnterpriseDB/docs/blob/master/advocacy_docs/playground/1/01_examples/index.mdx). + +For more details on most of these topics, see the [EDB documentation style guide](https://enterprisedb.atlassian.net/wiki/spaces/DCBC/pages/2387870239/Documentation+Style+Guide). ## Headings Use headings to create a hierarchy for readers to navigate to more easily find information. -Headings are denoted by two to four number signs (#) followed by one space. Enter an extra line break between the heading and the text content. EDB docs use Heading 2 (##), Heading 3 (###) and Heading 4 (####). Use Heading 4 sparingly. +Headings are denoted by two to four number signs (#) followed by one space. Enter an extra line break between the heading and the text content. EDB docs use Heading 2 (##), Heading 3 (###) and Heading 4 (####). Use Heading 4 sparingly. -All headers in Docs result in anchors, which are IDs that you can link to directly. They are formed by using the header text, using hyphens in place of spaces. This mechanism is handy for providing quick access to definitions and allowing search results to link directly to the relevant section of a page. +All headers in Docs result in anchors, which are IDs that you can link to directly. You form them by using a number sign followed by the header text and hyphens in place of spaces. This mechanism is handy for providing quick access to definitions and allowing search results to link directly to the relevant section of a page. ### `# H1` - Not used in Docs @@ -130,17 +141,18 @@ In Markdown, a single number sign signifies the page title (one per file). Howev ### `## H2` -Use an H2 section head to indicate a sub-topic in the page's overall topic. +Use an H2 section head to indicate a subtopic in the page's overall topic. In Docs, H2 headers generate an entry in the right-hand table of contents, allowing the reader to quickly scan the outline of the page and jump to a relevant section. ### `### H3` -Use an H3 subsection head to break up sections into logically distinct thoughts or concepts. Also useful for definition lists (e.g., a glossary). +Use an H3 section head to break up sections into logically distinct thoughts or concepts. Also useful for definition lists (e.g., a glossary). ### `#### H4` If you find yourself needing to use this level heading, consider breaking the topic into multiple pages or otherwise reorganizing your information. + ## Linking Markdown supports two different syntaxes for links. In Docs, we use inline links exclusively. The syntax is: @@ -149,11 +161,8 @@ Markdown supports two different syntaxes for links. In Docs, we use inline links The URL can be absolute (`https://example.com/path/to/page`) or relative (`/epas/latest/page`, `../sibling`). For links within docs, use relative links. However, avoid complicated path walking if possible. For example, use `/pem/latest/page` instead of `../../..page`). -More stuff about this in style guide ## Lists -Stuff about this in style guide - Lists appear with an indent by default. If you format a list with no indent, Markdown formats the list with an indent on the page. For example, the first list item in the example below appears with an indent on the page. If you want to make a nested list, don't use tab to indent. Press space three times to make an indent. For example: @@ -164,11 +173,13 @@ If you want to make a nested list, don't use tab to indent. Press space three ti ``` ## Tables -Stuff about this in style guide + +See the [EdB documentation style guide](https://enterprisedb.atlassian.net/wiki/spaces/DCBC/pages/2387870239/Documentation+Style+Guide). + ## Inline code -Use inline code `code` for keywords, verbatim expressions, etc. Markdown between the backtics won't be rendered, so there's no need to escape special characters. To inclue a backtick within inline code, use more than one backtic to enclode it: ``code `code` code``. -More stuff about this in style guide +Use inline code `code` for keywords, verbatim expressions, and so on. Markdown between the backtics won't be rendered, so there's no need to escape special characters. To include a backtick within inline code, use more than one backtic to enclode it: ``code `code` code``. + ## Code blocks ````markdown @@ -178,25 +189,23 @@ select 'a block of code' as result; ``` ```` -Use blocks of code for complete commands (even if only a single line), and all multi-line code or command listings. Specify a language tag (such as `sql`) at the opening "fence" (```` ``` ````) to indicate the type of code being listed and enable syntax highlighting for that block. Supported languages: https://prismjs.com/#supported-languages +Use blocks of code for complete commands (even if only a single line) and all multi-line code or command listings. Specify a language tag (such as `sql`) at the opening "fence" (```` ``` ````) to indicate the type of code being listed and enable syntax highlighting for that block. Supported languages: https://prismjs.com/#supported-languages Some code blocks consist of code or commands followed by program output. Use the special sequence `__OUTPUT__` (on a line by itself) to visually separate the output and prevent it from being syntax-highlighted. -More stuff about this in style guide - ### Code block style guidelines Readability is king. It might be code, but its target is a human reader, not a machine. To that end, pay attention to how code appears, and take time to reformat or reorganize it when its meaning becomes difficult to grasp. -Try to avoid mixing `__OUTPUT__` and multiple, consecutive code blocks. When possible, divide a sequence of commands into discrete steps. You can then show the output of each. When multiple commands are effectively "atomic" (e.g., two steps always performed together, the output of one command fed directly into the next, etc.), then describe their purpose before showing them together - as they would be typed / entered - and list the output of both together. +Try to avoid mixing `__OUTPUT__` and multiple, consecutive code blocks. When possible, divide a sequence of commands into discrete steps. You can then show the output of each. When multiple commands are effectively "atomic" (for example, two steps always performed together or the output of one command fed directly into the next), then describe their purpose before showing them together in the code block, and list the output of both together. -Use these three conventions in these docs for shell code blocks: +Use these conventions in these docs for shell code blocks: -1. Don't lead with a prompt, such as `$` or `#`. If the user copies and pastes a code example that includes a prompt, a "command not found" or no-op occurs, both which are confusing. +- Don't lead with a prompt, such as `$` or `#`. If the user copies and pastes a code example that includes a prompt, a "command not found" or no-op occurs, both of which are confusing. -2. Separate command output from the commands by using `__OUTPUT__` (described above). +- Separate command output from the commands by using `__OUTPUT__` (see [Code blocks](#code-blocks)). -3. Break long lines in a consistent and visually appealing fashion to aid in reading long commands. About 70 characters is a good rule of thumb. With more than two lines, you might as well go with one parameter per line. Use line continuation characters to accomplish this (for example, [windows](https://superuser.com/questions/150116/how-can-i-insert-a-new-line-in-a-cmd-exe-command), [linux](https://unix.stackexchange.com/questions/571301/when-to-use-line-continuation-character-and-when-not/571313#571313)). +- Break long lines in a consistent and visually appealing fashion to aid in reading long commands. About 70 characters is a good rule of thumb. With more than two lines, you might as well go with one parameter per line. Use line continuation characters to accomplish this (for example, [windows](https://superuser.com/questions/150116/how-can-i-insert-a-new-line-in-a-cmd-exe-command), [linux](https://unix.stackexchange.com/questions/571301/when-to-use-line-continuation-character-and-when-not/571313#571313)). ## Admonitions (notes, warnings, etc.) @@ -207,7 +216,7 @@ If you need to draw attention to information, consider using an admonition: This is text you want the reader to notice. ``` -Admonitions begin with the `!!!` signifier. Next comes a (case-insensitive) type which is one of: +Admonitions begin with the `!!!` signifier. Next comes a case-insensitive type, which is one of: - important - tip @@ -224,7 +233,7 @@ There are several [aliases](https://github.com/elviswolcott/remark-admonitions#u - seealso => note - hint => tip -Titles are optional. If you don't include one, the admonition will default to the type name ("Important", "Tip", etc.). +Titles are optional. If you don't include one, the admonition will default to the type name ("Important", "Tip", and so on). Indent the body of the admonition four spaces. The body lines up with the first letter of the admonition type. @@ -242,22 +251,39 @@ For examples of what you can do with admonitions, see [this demo](https://github ## Inserting images -Don't use HTML to insert images in your content. Instead, use Markdown syntax that begins with an exclamation mark, followed by a title in brackets, and the image file path in parentheses. For example: +Don't use HTML to insert images in your content. Instead, use Markdown syntax that begins with an exclamation mark, followed by a title in brackets and the image file path in parentheses. For example: ```text ![Comparison with Oracle Call Interface](../images/oracle_call_interface.png) ``` -The image title, Comparison with Oracle Call Interface, appears when hovering over the image. Use a descriptive and concise title for accessibility purposes. +The image title, Comparison with Oracle Call Interface, appears online when you hover over the image. Use a descriptive and concise title for accessibility purposes. The image file path depends on the location of your Markdown content. In the example, the image's file path, `../images/oracle_call_interface.png`, leads out of its folder (../) and into the images folder (images/), where `oracle_call_interface.png` is located. Your path must lead to the `images` folder where your image is located. ## Using HTML -HTML use in Markdown documents is limited. An example is in the partners for the landing; it needed HTML to work correctly. +HTML use in Markdown documents is limited. An example is in the partners for the landing. It needed HTML to work correctly. + + +You can use HTML to create line breaks in tables: `
` -You can use HTML to create line breaks in tables.: `
` We also use character references where needed, such as `—` (em-dash), `–` (en-dash), and `<` (less-than sign, used to correspond with a > closing bracket). + ## Font treatments -Bold and italic +Don't use a font treatement to emphasize a point in the text. If text needs extra attention, put it in an admonition. Using italic or bold to emphasize a word or phrase isn't appropriate in technical documentation. + +| Element | Font treatment | +|--------------------------------|-------------------| +| User input in code (variables) | Angle brackets | +| User names | No font treatment | +| Command names, utility names, file names, path names | Courier (backticks) | + +| Interface elements such as controls, options, and tabs | Bold | +| Page, window, or screen names | No font treatment | +| Menus and menu items | Bold. Use > to denote menu hierarchy: **File > Save**. Don't include ellipses if present in menu item name. | +| Roles | No font treatment | +| Permissions | No font treatment | +| Keys (such as Press **Enter**) | Bold | +| First use of new term | Italic, then define | From 070c8cc8f616229420093352702c6f0beff9eb1b Mon Sep 17 00:00:00 2001 From: Betsy Gitelman <93718720+ebgitelman@users.noreply.github.com> Date: Thu, 11 May 2023 15:00:17 -0400 Subject: [PATCH 09/19] more changes --- docs/how-tos/markdown-tips.md | 6 ++---- 1 file changed, 2 insertions(+), 4 deletions(-) diff --git a/docs/how-tos/markdown-tips.md b/docs/how-tos/markdown-tips.md index 5324d71eb4b..cc75f71da2e 100644 --- a/docs/how-tos/markdown-tips.md +++ b/docs/how-tos/markdown-tips.md @@ -276,14 +276,12 @@ Don't use a font treatement to emphasize a point in the text. If text needs extr | Element | Font treatment | |--------------------------------|-------------------| | User input in code (variables) | Angle brackets | -| User names | No font treatment | -| Command names, utility names, file names, path names | Courier (backticks) | +| Command names, parameters, functions, utility names, file names, path names | Courier (backticks) | | Interface elements such as controls, options, and tabs | Bold | | Page, window, or screen names | No font treatment | | Menus and menu items | Bold. Use > to denote menu hierarchy: **File > Save**. Don't include ellipses if present in menu item name. | -| Roles | No font treatment | -| Permissions | No font treatment | +| Roles, user names, permissions | No font treatment | | Keys (such as Press **Enter**) | Bold | | First use of new term | Italic, then define | From 4eee2a0018cb7a55086b6c9e1c7addb47455d64e Mon Sep 17 00:00:00 2001 From: Betsy Gitelman <93718720+ebgitelman@users.noreply.github.com> Date: Thu, 10 Aug 2023 10:15:38 -0400 Subject: [PATCH 10/19] Edit to pr4563 Flipped sentence to make it consistent with the rest of the list and to conform to "goal before action" principle. --- .../05_edb_audit_logging/03_enabling_audit_logging.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/product_docs/docs/epas/15/epas_security_guide/05_edb_audit_logging/03_enabling_audit_logging.mdx b/product_docs/docs/epas/15/epas_security_guide/05_edb_audit_logging/03_enabling_audit_logging.mdx index 839b4ee046e..242b52768b5 100644 --- a/product_docs/docs/epas/15/epas_security_guide/05_edb_audit_logging/03_enabling_audit_logging.mdx +++ b/product_docs/docs/epas/15/epas_security_guide/05_edb_audit_logging/03_enabling_audit_logging.mdx @@ -14,7 +14,7 @@ You can configure EDB Postgres Advanced Server to log all connections, disconnec - To audit all connections, set the parameter `edb_audit_connect` to `all`. - To audit all disconnections, set the parameter `edb_audit_disconnect` to `all`. - To audit DDL, DCL, DML and other statements, set the parameter `edb_audit_statement` according to the instructions in [Selecting SQL statements to audit](02_selecting_sql_statements_to_audit/#selecting_sql_statements_to_audit). -- Set the `edb_audit_directory` parameter to specify the desired location of audit files. +- To specify the desired location of audit files, set the `edb_audit_directory` parameter. Setting the `edb_audit_statement` parameter in the configuration file affects the entire database cluster. From 5038c8c6f0128fc8b831cb5e3d91fd3a90e0d68b Mon Sep 17 00:00:00 2001 From: Betsy Gitelman <93718720+ebgitelman@users.noreply.github.com> Date: Tue, 8 Aug 2023 16:55:58 -0400 Subject: [PATCH 11/19] edits to PR4511 --- .../biganimal/release/overview/02_high_availability.mdx | 8 ++++++-- .../biganimal/release/reference/cli/managing_clusters.mdx | 6 +++--- 2 files changed, 9 insertions(+), 5 deletions(-) diff --git a/product_docs/docs/biganimal/release/overview/02_high_availability.mdx b/product_docs/docs/biganimal/release/overview/02_high_availability.mdx index 3dbd3748c80..5d5133c0c74 100644 --- a/product_docs/docs/biganimal/release/overview/02_high_availability.mdx +++ b/product_docs/docs/biganimal/release/overview/02_high_availability.mdx @@ -42,7 +42,7 @@ In case of temporary or permanent unavailability of the primary, a standby repli ![BigAnimal Cluster4](images/high-availability.png) -Incoming client connections are always routed to the current primary. In case of failure of the primary, a standby replica is automatically promoted to primary, and new connections are routed to the new primary. When the old primary recovers, it rejoins the cluster as a standby replica. +Incoming client connections are always routed to the current primary. In case of failure of the primary, a standby replica is promoted to primary, and new connections are routed to the new primary. When the old primary recovers, it rejoins the cluster as a standby replica. ### Standby replicas @@ -68,7 +68,11 @@ Distributed high-availability clusters contain one or two data groups. Your data The witness node/witness group doesn't host data but exists for management purposes, supporting operations that require a consensus, for example, in case of an availability zone failure. -While a single-region configuration with three data nodes (one lead and two shadow nodes each in separate availability zones) is available, if you're looking for a true active-active solution that protects against regional failures, select a three-region configuration with a data node, shadow node, and a witness node in one region, the same configuration in another region, and a witness node in a third region. +A single-region configuration with three data nodes (one lead and two shadow nodes each in separate availability zones) is available. However, if you're looking for a true active-active solution that protects against regional failures, select a three-region configuration with: + +- A data node, shadow node, and a witness node in one region +- The same configuration in another region +- A witness node in a third region ![region(2 data + 1 shadow) + region(2 data + 1 shadow) + region(1 witness)](images/Multi-Region-3Nodes.png) diff --git a/product_docs/docs/biganimal/release/reference/cli/managing_clusters.mdx b/product_docs/docs/biganimal/release/reference/cli/managing_clusters.mdx index 6183141e859..889ad75812f 100644 --- a/product_docs/docs/biganimal/release/reference/cli/managing_clusters.mdx +++ b/product_docs/docs/biganimal/release/reference/cli/managing_clusters.mdx @@ -332,7 +332,7 @@ witnessGroups: ### `pgd add-group` -Add a data group using a YAML configuration file. For example, +Add a data group using a YAML configuration file. For example: ``` clusterId: clusterID @@ -370,7 +370,7 @@ Show active or deleted extreme-high-availability clusters. ### `pgd restore` -Restore an extreme-high-availability cluster or a deleted extreme-high-availability cluster to a new cluster on same cloud provider. You can restore an active cluster or a deleted cluster within its retention period You can only restore one data group. By default the new cluster inherits all settings of the source cluster. You can change the cluster setting and database configurations by specifying new values in the restore command. +Restore an extreme-high-availability cluster or a deleted extreme-high-availability cluster to a new cluster on same cloud provider. You can restore an active cluster or a deleted cluster within its retention period You can restore only one data group. By default, the new cluster inherits all settings of the source cluster. You can change the cluster setting and database configurations by specifying new values in the restore command. ### `pgd show-group-connection` @@ -378,4 +378,4 @@ Get the connection string of the desired Postgres cluster. ### `pgd show-group-monitoring-urls` -Show extreme-high-availability group monitoring urls. \ No newline at end of file +Show extreme-high-availability group monitoring URLs. \ No newline at end of file From 0c867c61c74cba99be2bc29a18c15f7621ec27ee Mon Sep 17 00:00:00 2001 From: Josh Heyer <63653723+josh-heyer@users.noreply.github.com> Date: Thu, 10 Aug 2023 09:21:43 -0700 Subject: [PATCH 12/19] Fix link to plugin page --- .../docs/postgres_for_kubernetes/1/interactive_demo.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/product_docs/docs/postgres_for_kubernetes/1/interactive_demo.mdx b/product_docs/docs/postgres_for_kubernetes/1/interactive_demo.mdx index 2f826edd838..31ebaa7366d 100644 --- a/product_docs/docs/postgres_for_kubernetes/1/interactive_demo.mdx +++ b/product_docs/docs/postgres_for_kubernetes/1/interactive_demo.mdx @@ -425,7 +425,7 @@ cluster-example-3 29 MB 0/6054B60 Standby (async) OK BestEff ``` !!! Note "There's more" - See [the Cloud Native PostgreSQL Plugin page](cnp-plugin/) for more commands and options. + See [the Cloud Native PostgreSQL Plugin page](kubectl-plugin/) for more commands and options. ## Testing failover From 81eecf39e3e2e4e988417293485b958005f5ce3a Mon Sep 17 00:00:00 2001 From: Dj Walker-Morgan Date: Fri, 4 Aug 2023 11:28:56 +0100 Subject: [PATCH 13/19] Fixed "n/a" issue, fixed spaces in name issue Signed-off-by: Dj Walker-Morgan --- .../pg_extensions/extensionrefs.json | 27 +++++----- advocacy_docs/pg_extensions/index.mdx | 50 ++++++++++--------- tools/user/import/extensions/exsp.js | 8 +-- 3 files changed, 46 insertions(+), 39 deletions(-) diff --git a/advocacy_docs/pg_extensions/extensionrefs.json b/advocacy_docs/pg_extensions/extensionrefs.json index d4824abe25e..b4b5776e1fc 100644 --- a/advocacy_docs/pg_extensions/extensionrefs.json +++ b/advocacy_docs/pg_extensions/extensionrefs.json @@ -16,7 +16,7 @@ "fuzzystrmatch": "https://www.postgresql.org/docs/current/fuzzystrmatch.html", "hstore": "https://www.postgresql.org/docs/current/hstore.html", "hstore.hstore_plperl": "https://www.postgresql.org/docs/current/hstore.html#id-1.11.7.27.11", - "hstore.hstore_plperlu_": "https://www.postgresql.org/docs/current/hstore.html#id-1.11.7.27.11", + "hstore.hstore_plperlu": "https://www.postgresql.org/docs/current/hstore.html#id-1.11.7.27.11", "intagg": "https://www.postgresql.org/docs/current/intagg.html", "intarray": "https://www.postgresql.org/docs/current/intarray.html", "isn": "https://www.postgresql.org/docs/current/isn.html", @@ -63,14 +63,14 @@ "pglogical_2.x": "https://www.enterprisedb.com/docs/supported-open-source/pglogical2/", "pgrouting": "https://pgrouting.org/", "pgsnmpd_(11-13 )": "undefined", - "pgvector": "undefined:", + "pgvector": "undefined", "pljava_(11)": "https://tada.github.io/pljava/", "plperl": "https://www.postgresql.org/docs/current/plperl.html", "plperl.plperlu": "https://www.postgresql.org/docs/current/plperl-trusted.html", "plperl.bool_plperl": "https://www.postgresql.org/docs/current/plperl-funcs.html", "plperl.bool_plperlu": "https://www.postgresql.org/docs/current/plperl-funcs.html", "plpythonu_ (default by version)": "https://www.postgresql.org/docs/current/plpython.html", - "plpythonu_ (default by version).hstore_plpythonu": "undefined:", + "plpythonu_ (default by version).hstore_plpythonu": "undefined", "plpythonu_ (default by version).jsonb_plpythonu": "undefined", "plpythonu_ (default by version).ltree_plpythonu": "undefined", "plpython2u_(default 11-14 )": "https://www.postgresql.org/docs/11/plpython-python23.html", @@ -91,9 +91,9 @@ "bdr_4.x": "https://www.enterprisedb.com/docs/pgd/4/bdr/", "dbms_job": "https://www.enterprisedb.com/docs/epas/latest/epas_compat_bip_guide/03_built-in_packages/05_dbms_job/", "dbms_scheduler": "https://www.enterprisedb.com/docs/epas/latest/epas_compat_bip_guide/03_built-in_packages/15_dbms_scheduler/", - "edb_cloneschema_": "https://www.enterprisedb.com/docs/epas/latest/epas_guide/14_edb_clone_schema/", - "edb_dblink_libpq": "undefined:", - "edb_dblink_oci": "undefined:", + "edb_cloneschema": "https://www.enterprisedb.com/docs/epas/latest/epas_guide/14_edb_clone_schema/", + "edb_dblink_libpq": "undefined", + "edb_dblink_oci": "undefined", "edb_dbo": "https://www.enterprisedb.com/docs/epas/11/epas_guide/16_enhanced_sql_and_other_misc_features/#sql-server-dbo-schema", "edb_pg_tuner": "https://www.enterprisedb.com/docs/pg_extensions/pg_tuner/", "edb_query_advisor": "https://www.enterprisedb.com/docs/pg_extensions/query_advisor/", @@ -109,12 +109,13 @@ "postgis_topology": "undefined", "address_standardizer": "https://postgis.net/docs/manual-2.5/Address_Standardizer.html", "address_standardizer_data_us": "https://postgis.net/docs/manual-2.5/Address_Standardizer.html", - "_pgpool_adm": "https://www.pgpool.net/docs/latest/en/html/pgpool-adm.html", - "_pgpool_recovery": "https://www.pgpool.net/docs/42/en/html/install-pgpool-recovery.html", - "_pldbgapi": "https://github.com/EnterpriseDB/pldebugger", - "_hdfs_fdw": "https://github.com/EnterpriseDB/hdfs_fdw", - "_mongo_fdw": "https://github.com/Percona-Lab/mongodb_fdw", - "_mysql_fdw": "https://github.com/EnterpriseDB/mysql_fdw", + "pgpool_adm": "https://www.pgpool.net/docs/latest/en/html/pgpool-adm.html", + "pgpool_recovery": "https://www.pgpool.net/docs/42/en/html/install-pgpool-recovery.html", + "pldbgapi": "https://github.com/EnterpriseDB/pldebugger", + "hdfs_fdw": "https://github.com/EnterpriseDB/hdfs_fdw", + "mongo_fdw": "https://github.com/Percona-Lab/mongodb_fdw", + "mysql_fdw": "https://github.com/EnterpriseDB/mysql_fdw", "bdr_5.x":"https://www.enterprisedb.com/docs/pgd/5/", - "pg_cron":"https://github.com/citusdata/pg_cron" + "pg_cron":"https://github.com/citusdata/pg_cron", + "sql_profiler":"undefined" } \ No newline at end of file diff --git a/advocacy_docs/pg_extensions/index.mdx b/advocacy_docs/pg_extensions/index.mdx index 2b0baf2f1a4..e1c0fc1c0c8 100644 --- a/advocacy_docs/pg_extensions/index.mdx +++ b/advocacy_docs/pg_extensions/index.mdx @@ -43,7 +43,7 @@ Categories of extensions: fuzzystrmatch✓✓✓✓✓✓✓✓ hstore✓✓✓✓✓✓✓✓     hstore_plperlYes✓✓✓––✓✓✓ -    hstore_plperlu Yes✓✓✓––✓✓✓ +     hstore_plperluYes✓✓✓––✓✓✓ intaggYes✓✓✓✓✓✓✓✓ intarray✓✓✓✓✓✓✓✓ isn✓✓✓✓✓✓✓✓ @@ -85,20 +85,20 @@ Categories of extensions: PostgreSQL Non-Contrib Extensions/Modules ip4r✓––––––– pg_cron✓✓✓––Q3 2023Q3 2023Q3 2023 -pg_failover_slots✓✓✓––✓✓✓ +pg_failover_slots✓✓✓✓✓✓✓✓ pg_permissions✓––––––– pg_store_plans✓––––––– -pgauditYes✓✓–✓–✓–– -pglogical 2.x✓✓–––––– -pgsnmpd (11-13 )✓–✓––––– -pgvector✓––––––– -pljava (11)✓–✓––––– +pgauditYes✓✓n/a✓n/a✓–n/a +pglogical 2.x✓✓–n/an/an/an/an/a +pgsnmpd (11-13 )✓n/a✓n/an/an/an/an/a +pgvector✓––––––– +pljava (11)✓–✓n/an/an/an/an/a plperl✓✓✓––✓✓✓     plperluYes✓✓✓––✓✓✓     bool_plperl✓✓✓––✓✓✓     bool_plperluYes✓✓✓––✓✓✓ plpythonu (default by version)Yes✓✓✓––––– -    hstore_plpythonuYes✓✓✓––––– +    hstore_plpythonuYes✓✓✓–––––     jsonb_plpythonuYes✓✓✓–––––     ltree_plpythonuYes✓✓✓––––– plpython2u (default 11-14 )✓✓✓––✓✓✓ @@ -121,23 +121,27 @@ Categories of extensions: - - - - + + + + + + + + - - - + + + - - - - - + + + + +
Virtual Machines/Physical ServersKubernetesBigAnimal
Extension nameRequires
superuser
access		PostgreSQLEDB
Postgres
Extended
Server		EDB
Postgres
Advanced
Server		PostgreSQLEDB
Postgres
Advanced
Server		PostgreSQLEDB
Postgres
Extended
Server		EDB
Postgres
Advanced
Server
autocluster✓✓✓–––✓✓
bdr 3.x✓✓✓–––––
bdr 4.x✓✓✓–––––
bdr 5.x✓✓✓PreviewPreview–PreviewPreview
Extension nameRequires
superuser
access		PostgreSQLEDB
Postgres
Extended
Server		EDB
Postgres
Advanced
Server		PostgreSQLEDB
Postgres
Advanced
Server		PostgreSQLEDB
Postgres
Extended
Server		EDB
Postgres
Advanced
Server
edb_pg_tuner✓✓✓✓✓–✓✓
edb_query_advisor✓✓✓––✓✓✓
edb_wait_states✓✓✓––✓✓✓
sql_profiler✓✓✓––✓✓✓
EDB Storage Pack
autocluster✓✓✓–––✓✓
refdata✓✓✓–––✓✓
EDB Postgres Advanced Server extensions
dbms_job––✓–––––
dbms_scheduler––✓–––––
edb_cloneschema ––✓–––––
edb_dblink_libpq––✓–✓––✓
edb_dblink_ociYes––✓–✓––✓
 edb_cloneschema––✓–––––
edb_dblink_libpq––✓–✓––✓
edb_dblink_ociYes––✓–✓––✓
edb_dboYes––✓–✓––✓
edb_pg_tuner✓✓✓✓✓–✓✓
edb_query_advisor✓✓✓––✓✓✓
edb_wait_states✓✓✓––✓✓✓
edbsplYes––✓–✓––✓
parallel_clone––✓–––––
pglogical 3.xYes✓✓✓–––––
refdata✓✓✓–––✓✓
EDB Postgres Distributed extensions
bdr 3.x✓✓✓n/an/an/an/an/a
 bdr 4.x✓✓✓n/an/an/an/an/a
bdr 5.x✓✓✓PreviewPreview–PreviewPreview
pglogical 3.xYes✓✓✓n/an/an/an/an/a
@@ -146,7 +150,7 @@ Categories of extensions: - + @@ -155,8 +159,8 @@ Categories of extensions: - - + + diff --git a/tools/user/import/extensions/exsp.js b/tools/user/import/extensions/exsp.js index a7535944dff..f4c8a3add8f 100644 --- a/tools/user/import/extensions/exsp.js +++ b/tools/user/import/extensions/exsp.js @@ -138,9 +138,9 @@ function composeRow(row, lastRow, currentState) { let output = [] output.push("") let fullName = row[0]; - let trimmedName = fullName.trimStart() + let trimmedName = fullName.trim(); let spaceDiff = fullName.length - trimmedName.length - let lookupName=fullName.replace(" ","_") + let lookupName=fullName.trim().replace(" ","_") if(spaceDiff<=1) { // Root element, update state currentState.lastRoot=lookupName; } else { @@ -169,7 +169,9 @@ function composeRow(row, lastRow, currentState) { output.push(composeCell(i == 6 || i == 9 || i == 11, i == 13, true, true, `Preview`, lastRow, true)); } else if(row[i].match(/Q[1-4] 20[0-9][0-9]/gm)) { output.push(composeCell(i == 6 || i == 9 || i == 11, i == 13, true, true, row[i], lastRow, true)); - } else { + } else if(row[i]=="n/a") { + output.push(composeCell(i == 6 || i == 9 || i == 11, i == 13, true, true, row[i], lastRow, true)); + }else { console.log(`Unhandled value ${row[i]}`) } } From f229746eded38004af454287071b0a385fce3bad Mon Sep 17 00:00:00 2001 From: Dj Walker-Morgan Date: Tue, 8 Aug 2023 09:22:31 +0100 Subject: [PATCH 14/19] Made n/a render as - as agreed Signed-off-by: Dj Walker-Morgan --- advocacy_docs/pg_extensions/index.mdx | 18 +++++++++--------- tools/user/import/extensions/exsp.js | 4 ++-- 2 files changed, 11 insertions(+), 11 deletions(-) diff --git a/advocacy_docs/pg_extensions/index.mdx b/advocacy_docs/pg_extensions/index.mdx index e1c0fc1c0c8..84842b03d68 100644 --- a/advocacy_docs/pg_extensions/index.mdx +++ b/advocacy_docs/pg_extensions/index.mdx @@ -88,11 +88,11 @@ Categories of extensions: - - - + + + - + @@ -138,10 +138,10 @@ Categories of extensions: - - + + - +
Virtual Machines/Physical ServersKubernetesBigAnimal
Extension nameRequires
superuser
access		PostgreSQLEDB
Postgres
Extended
Server		EDB
Postgres
Advanced
Server		PostgreSQLEDB
Postgres
Advanced
Server		PostgreSQLEDB
Postgres
Extended
Server		EDB
Postgres
Advanced
Server
Postgres Geospatial
pgrouting✓✓✓––Q4 2023Q4 2023Q4 2023
pgrouting✓✓✓✓✓Q4 2023Q4 2023Q4 2023
postgis✓✓✓✓✓Q4 2023Q4 2023Q4 2023
postgis_raster✓✓✓✓✓Q4 2023Q4 2023Q4 2023
postgis_sfcgal✓✓✓✓✓Q4 2023Q4 2023Q4 2023
address_standardizer✓✓✓✓✓Q4 2023Q4 2023Q4 2023
address_standardizer_data_us✓✓✓✓✓Q4 2023Q4 2023Q4 2023
Pgpool
 pgpool_adm✓–✓–––––
 pgpool_recovery✓–✓–––––
 pgpool_adm✓–✓n/an/an/an/an/a
 pgpool_recovery✓–✓n/an/an/an/an/a
PLdebugger
 pldbgapi✓–✓–––––
Foreign Data Wrappers
pg_failover_slots✓✓✓✓✓✓✓✓
pg_permissions✓–––––––
pg_store_plans✓–––––––
pgauditYes✓✓n/a✓n/a✓–n/a
pglogical 2.x✓✓–n/an/an/an/an/a
pgsnmpd (11-13 )✓n/a✓n/an/an/an/an/a
pgauditYes✓✓–✓–✓––
pglogical 2.x✓✓––––––
pgsnmpd (11-13 )✓–✓–––––
pgvector✓–––––––
pljava (11)✓–✓n/an/an/an/an/a
pljava (11)✓–✓–––––
plperl✓✓✓––✓✓✓
    plperluYes✓✓✓––✓✓✓
    bool_plperl✓✓✓––✓✓✓
edbsplYes––✓–✓––✓
parallel_clone––✓–––––
EDB Postgres Distributed extensions
bdr 3.x✓✓✓n/an/an/an/an/a
 bdr 4.x✓✓✓n/an/an/an/an/a
bdr 3.x✓✓✓–––––
 bdr 4.x✓✓✓–––––
bdr 5.x✓✓✓PreviewPreview–PreviewPreview
pglogical 3.xYes✓✓✓n/an/an/an/an/a
pglogical 3.xYes✓✓✓–––––
@@ -159,8 +159,8 @@ Categories of extensions: address_standardizer✓✓✓✓✓Q4 2023Q4 2023Q4 2023 address_standardizer_data_us✓✓✓✓✓Q4 2023Q4 2023Q4 2023 Pgpool - pgpool_adm✓–✓n/an/an/an/an/a - pgpool_recovery✓–✓n/an/an/an/an/a + pgpool_adm✓–✓––––– + pgpool_recovery✓–✓––––– PLdebugger  pldbgapi✓–✓––––– Foreign Data Wrappers diff --git a/tools/user/import/extensions/exsp.js b/tools/user/import/extensions/exsp.js index f4c8a3add8f..3140626ac9e 100644 --- a/tools/user/import/extensions/exsp.js +++ b/tools/user/import/extensions/exsp.js @@ -169,8 +169,8 @@ function composeRow(row, lastRow, currentState) { output.push(composeCell(i == 6 || i == 9 || i == 11, i == 13, true, true, `Preview`, lastRow, true)); } else if(row[i].match(/Q[1-4] 20[0-9][0-9]/gm)) { output.push(composeCell(i == 6 || i == 9 || i == 11, i == 13, true, true, row[i], lastRow, true)); - } else if(row[i]=="n/a") { - output.push(composeCell(i == 6 || i == 9 || i == 11, i == 13, true, true, row[i], lastRow, true)); + } else if(row[i]=="n/a") { /* Hide n/a from spreadsheet as - (n/a is internal status only) */ + output.push(composeCell(i == 6 || i == 9 || i == 11, i == 13, true, true, `–`, lastRow, true)); }else { console.log(`Unhandled value ${row[i]}`) } From a1f8ee86b226c2e90b4df25257ad91497d110485 Mon Sep 17 00:00:00 2001 From: Dj Walker-Morgan Date: Tue, 8 Aug 2023 12:47:03 +0100 Subject: [PATCH 15/19] Removed bold off in table text entries Signed-off-by: Dj Walker-Morgan --- advocacy_docs/pg_extensions/index.mdx | 20 ++++++++++---------- tools/user/import/extensions/exsp.js | 4 ++-- 2 files changed, 12 insertions(+), 12 deletions(-) diff --git a/advocacy_docs/pg_extensions/index.mdx b/advocacy_docs/pg_extensions/index.mdx index 84842b03d68..9a0b9110175 100644 --- a/advocacy_docs/pg_extensions/index.mdx +++ b/advocacy_docs/pg_extensions/index.mdx @@ -84,7 +84,7 @@ Categories of extensions: xml2Yes✓✓✓✓✓✓✓✓ PostgreSQL Non-Contrib Extensions/Modules ip4r✓––––––– -pg_cron✓✓✓––Q3 2023Q3 2023Q3 2023 +pg_cron✓✓✓––Q3 2023Q3 2023Q3 2023 pg_failover_slots✓✓✓✓✓✓✓✓ pg_permissions✓––––––– pg_store_plans✓––––––– @@ -140,7 +140,7 @@ Categories of extensions: EDB Postgres Distributed extensions bdr 3.x✓✓✓–––––  bdr 4.x✓✓✓––––– -bdr 5.x✓✓✓PreviewPreview–PreviewPreview +bdr 5.x✓✓✓PreviewPreview–PreviewPreview pglogical 3.xYes✓✓✓––––– @@ -150,14 +150,14 @@ Categories of extensions: - - - - - - - - + + + + + + + + diff --git a/tools/user/import/extensions/exsp.js b/tools/user/import/extensions/exsp.js index 3140626ac9e..67eae28fc93 100644 --- a/tools/user/import/extensions/exsp.js +++ b/tools/user/import/extensions/exsp.js @@ -166,9 +166,9 @@ function composeRow(row, lastRow, currentState) { } else if(row[i] == "FALSE") { output.push(composeCell(i == 6 || i == 9 || i == 11, i == 13, true, true, `–`, lastRow, true)); } else if(row[i] == "PREVIEW") { - output.push(composeCell(i == 6 || i == 9 || i == 11, i == 13, true, true, `Preview`, lastRow, true)); + output.push(composeCell(i == 6 || i == 9 || i == 11, i == 13, false, true, `Preview`, lastRow, true)); } else if(row[i].match(/Q[1-4] 20[0-9][0-9]/gm)) { - output.push(composeCell(i == 6 || i == 9 || i == 11, i == 13, true, true, row[i], lastRow, true)); + output.push(composeCell(i == 6 || i == 9 || i == 11, i == 13, false, true, row[i], lastRow, true)); } else if(row[i]=="n/a") { /* Hide n/a from spreadsheet as - (n/a is internal status only) */ output.push(composeCell(i == 6 || i == 9 || i == 11, i == 13, true, true, `–`, lastRow, true)); }else { From cf363513997e579cfc644a24cf69e08f97ad6e12 Mon Sep 17 00:00:00 2001 From: drothery-edb Date: Tue, 8 Aug 2023 10:30:44 -0400 Subject: [PATCH 16/19] added link for SQL Profiler --- advocacy_docs/pg_extensions/extensionrefs.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/advocacy_docs/pg_extensions/extensionrefs.json b/advocacy_docs/pg_extensions/extensionrefs.json index b4b5776e1fc..920e1fd747f 100644 --- a/advocacy_docs/pg_extensions/extensionrefs.json +++ b/advocacy_docs/pg_extensions/extensionrefs.json @@ -117,5 +117,5 @@ "mysql_fdw": "https://github.com/EnterpriseDB/mysql_fdw", "bdr_5.x":"https://www.enterprisedb.com/docs/pgd/5/", "pg_cron":"https://github.com/citusdata/pg_cron", - "sql_profiler":"undefined" + "sql_profiler":"https://www.enterprisedb.com/docs/pem/latest/profiling_workloads/using_sql_profiler/" } \ No newline at end of file From e0bedf02919df0572c01294e7d467328be9c4143 Mon Sep 17 00:00:00 2001 From: Dj Walker-Morgan Date: Tue, 8 Aug 2023 19:09:34 +0100 Subject: [PATCH 17/19] Updated to be more resiliant to spaces Signed-off-by: Dj Walker-Morgan --- .../pg_extensions/extensionrefs.json | 28 +++++++++---------- advocacy_docs/pg_extensions/index.mdx | 28 +++++++++---------- tools/user/import/extensions/exsp.js | 14 ++++++++-- 3 files changed, 39 insertions(+), 31 deletions(-) diff --git a/advocacy_docs/pg_extensions/extensionrefs.json b/advocacy_docs/pg_extensions/extensionrefs.json index 920e1fd747f..990a6cedd81 100644 --- a/advocacy_docs/pg_extensions/extensionrefs.json +++ b/advocacy_docs/pg_extensions/extensionrefs.json @@ -62,25 +62,25 @@ "pgaudit": "https://www.pgaudit.org/", "pglogical_2.x": "https://www.enterprisedb.com/docs/supported-open-source/pglogical2/", "pgrouting": "https://pgrouting.org/", - "pgsnmpd_(11-13 )": "undefined", + "pgsnmpd_(11-13_)": "undefined", "pgvector": "undefined", "pljava_(11)": "https://tada.github.io/pljava/", "plperl": "https://www.postgresql.org/docs/current/plperl.html", "plperl.plperlu": "https://www.postgresql.org/docs/current/plperl-trusted.html", "plperl.bool_plperl": "https://www.postgresql.org/docs/current/plperl-funcs.html", "plperl.bool_plperlu": "https://www.postgresql.org/docs/current/plperl-funcs.html", - "plpythonu_ (default by version)": "https://www.postgresql.org/docs/current/plpython.html", - "plpythonu_ (default by version).hstore_plpythonu": "undefined", - "plpythonu_ (default by version).jsonb_plpythonu": "undefined", - "plpythonu_ (default by version).ltree_plpythonu": "undefined", - "plpython2u_(default 11-14 )": "https://www.postgresql.org/docs/11/plpython-python23.html", - "plpython2u_(default 11-14 ).hstore_plpython2u": "https://www.postgresql.org/docs/11/hstore.html#id-1.11.7.25.10", - "plpython2u_(default 11-14 ).jsonb_plpython2u": "https://www.postgresql.org/docs/11/datatype-json.html#id-1.5.7.22.18", - "plpython2u_(default 11-14 ).ltree_plpython2u": "https://www.postgresql.org/docs/11/ltree.html#id-1.11.7.30.8", - "plpython3u_(default 15)": "https://www.postgresql.org/docs/current/plpython.html", - "plpython3u_(default 15).hstore_plpython3u": "https://www.postgresql.org/docs/current/hstore.html#id-1.11.7.27.11", - "plpython3u_(default 15).jsonb_plpython3u": "https://www.postgresql.org/docs/current/datatype-json.html#id-1.5.7.22.20", - "plpython3u_(default 15).ltree_plpython3u": "https://www.postgresql.org/docs/current/ltree.html#id-1.11.7.32.9", + "plpythonu": "https://www.postgresql.org/docs/current/plpython.html", + "plpythonu.hstore_plpythonu": "undefined", + "plpythonu.jsonb_plpythonu": "undefined", + "plpythonu.ltree_plpythonu": "undefined", + "plpython2u_(11-14_)": "https://www.postgresql.org/docs/11/plpython-python23.html", + "plpython2u_(11-14_).hstore_plpython2u": "https://www.postgresql.org/docs/11/hstore.html#id-1.11.7.25.10", + "plpython2u_(11-14_).jsonb_plpython2u": "https://www.postgresql.org/docs/11/datatype-json.html#id-1.5.7.22.18", + "plpython2u_(11-14_).ltree_plpython2u": "https://www.postgresql.org/docs/11/ltree.html#id-1.11.7.30.8", + "plpython3u_(15+)": "https://www.postgresql.org/docs/current/plpython.html", + "plpython3u_(15+).hstore_plpython3u": "https://www.postgresql.org/docs/current/hstore.html#id-1.11.7.27.11", + "plpython3u_(15+).jsonb_plpython3u": "https://www.postgresql.org/docs/current/datatype-json.html#id-1.5.7.22.20", + "plpython3u_(15+).ltree_plpython3u": "https://www.postgresql.org/docs/current/ltree.html#id-1.11.7.32.9", "pltcl": "https://www.postgresql.org/docs/current/pltcl.html", "pltcl.pltclu": "https://www.postgresql.org/docs/current/pltcl-overview.html", "set_user": "https://github.com/pgaudit/set_user", @@ -100,7 +100,7 @@ "edb_wait_states": "https://www.enterprisedb.com/docs/pg_extensions/wait_states/", "edbspl": "https://www.enterprisedb.com/docs/epas/latest/epas_compat_spl/02_spl_programs/", "parallel_clone": "undefined", - "pglogical_3.x": "undefined", + "pglogical_3.x": "https://www.enterprisedb.com/docs/pgd/3.7/pglogical/", "refdata": "https://www.enterprisedb.com/docs/pg_extensions/advanced_storage_pack/", "postgis": "https://www.enterprisedb.com/docs/postgis/latest/", "postgis_raster": "undefined", diff --git a/advocacy_docs/pg_extensions/index.mdx b/advocacy_docs/pg_extensions/index.mdx index 9a0b9110175..299880eac4e 100644 --- a/advocacy_docs/pg_extensions/index.mdx +++ b/advocacy_docs/pg_extensions/index.mdx @@ -43,7 +43,7 @@ Categories of extensions: - + @@ -97,15 +97,15 @@ Categories of extensions: - + - + - + @@ -124,14 +124,14 @@ Categories of extensions: - + - + @@ -139,9 +139,9 @@ Categories of extensions: - + - +
Virtual Machines/Physical ServersKubernetesBigAnimal
Extension nameRequires
superuser
access		PostgreSQLEDB
Postgres
Extended
Server		EDB
Postgres
Advanced
Server		PostgreSQLEDB
Postgres
Advanced
Server		PostgreSQLEDB
Postgres
Extended
Server		EDB
Postgres
Advanced
Server
Postgres Geospatial
pgrouting✓✓✓✓✓Q4 2023Q4 2023Q4 2023
postgis✓✓✓✓✓Q4 2023Q4 2023Q4 2023
postgis_raster✓✓✓✓✓Q4 2023Q4 2023Q4 2023
postgis_sfcgal✓✓✓✓✓Q4 2023Q4 2023Q4 2023
postgis_tiger_geocoder✓✓✓✓✓Q4 2023Q4 2023Q4 2023
postgis_topology✓✓✓✓✓Q4 2023Q4 2023Q4 2023
address_standardizer✓✓✓✓✓Q4 2023Q4 2023Q4 2023
address_standardizer_data_us✓✓✓✓✓Q4 2023Q4 2023Q4 2023
pgrouting✓✓✓✓✓Q4 2023Q4 2023Q4 2023
postgis✓✓✓✓✓Q4 2023Q4 2023Q4 2023
postgis_raster✓✓✓✓✓Q4 2023Q4 2023Q4 2023
postgis_sfcgal✓✓✓✓✓Q4 2023Q4 2023Q4 2023
postgis_tiger_geocoder✓✓✓✓✓Q4 2023Q4 2023Q4 2023
postgis_topology✓✓✓✓✓Q4 2023Q4 2023Q4 2023
address_standardizer✓✓✓✓✓Q4 2023Q4 2023Q4 2023
address_standardizer_data_us✓✓✓✓✓Q4 2023Q4 2023Q4 2023
Pgpool
 pgpool_adm✓–✓–––––
 pgpool_recovery✓–✓–––––
fuzzystrmatch✓✓✓✓✓✓✓✓
hstore✓✓✓✓✓✓✓✓
    hstore_plperlYes✓✓✓––✓✓✓
     hstore_plperluYes✓✓✓––✓✓✓
    hstore_plperluYes✓✓✓––✓✓✓
intaggYes✓✓✓✓✓✓✓✓
intarray✓✓✓✓✓✓✓✓
isn✓✓✓✓✓✓✓✓
    plperluYes✓✓✓––✓✓✓
    bool_plperl✓✓✓––✓✓✓
    bool_plperluYes✓✓✓––✓✓✓
plpythonu (default by version)Yes✓✓✓–––––
plpythonuYes✓✓✓–––––
    hstore_plpythonuYes✓✓✓–––––
    jsonb_plpythonuYes✓✓✓–––––
    ltree_plpythonuYes✓✓✓–––––
plpython2u (default 11-14 )✓✓✓––✓✓✓
plpython2u (11-14 )✓✓✓––✓✓✓
    hstore_plpython2u✓✓✓––✓✓✓
    jsonb_plpython2u✓✓✓––✓✓✓
    ltree_plpython2u✓✓✓––✓✓✓
plpython3u (default 15)Yes✓✓✓––✓✓✓
plpython3u (15+)Yes✓✓✓––✓✓✓
    hstore_plpython3uYes✓✓✓––✓✓✓
    jsonb_plpython3uYes✓✓✓––✓✓✓
    ltree_plpython3uYes✓✓✓––✓✓✓
Extension nameRequires
superuser
access		PostgreSQLEDB
Postgres
Extended
Server		EDB
Postgres
Advanced
Server		PostgreSQLEDB
Postgres
Advanced
Server		PostgreSQLEDB
Postgres
Extended
Server		EDB
Postgres
Advanced
Server
edb_pg_tuner✓✓✓✓✓–✓✓
edb_query_advisor✓✓✓––✓✓✓
edb_wait_states✓✓✓––✓✓✓
sql_profiler✓✓✓––✓✓✓
sql_profiler✓✓✓––✓✓✓
EDB Storage Pack
autocluster✓✓✓–––✓✓
refdata✓✓✓–––✓✓
EDB Postgres Advanced Server extensions
dbms_job––✓–––––
dbms_scheduler––✓–––––
 edb_cloneschema––✓–––––
edb_cloneschema––✓–––––
edb_dblink_libpq––✓–✓––✓
edb_dblink_ociYes––✓–✓––✓
edb_dboYes––✓–✓––✓
parallel_clone––✓–––––
EDB Postgres Distributed extensions
bdr 3.x✓✓✓–––––
 bdr 4.x✓✓✓–––––
bdr 4.x✓✓✓–––––
bdr 5.x✓✓✓PreviewPreview–PreviewPreview
pglogical 3.xYes✓✓✓–––––
pglogical 3.xYes✓✓✓–––––
@@ -159,12 +159,12 @@ Categories of extensions: address_standardizer✓✓✓✓✓Q4 2023Q4 2023Q4 2023 address_standardizer_data_us✓✓✓✓✓Q4 2023Q4 2023Q4 2023 Pgpool - pgpool_adm✓–✓––––– - pgpool_recovery✓–✓––––– +pgpool_adm✓–✓––––– +pgpool_recovery✓–✓––––– PLdebugger - pldbgapi✓–✓––––– +pldbgapi✓–✓––––– Foreign Data Wrappers - hdfs_fdwYes✓–✓––––– - mongo_fdwYes✓–✓––––✓ - mysql_fdwYes✓–✓––––✓ +hdfs_fdwYes✓–✓––––– +mongo_fdwYes✓–✓––––✓ +mysql_fdwYes✓–✓––––✓ diff --git a/tools/user/import/extensions/exsp.js b/tools/user/import/extensions/exsp.js index 67eae28fc93..986dbed5627 100644 --- a/tools/user/import/extensions/exsp.js +++ b/tools/user/import/extensions/exsp.js @@ -139,8 +139,13 @@ function composeRow(row, lastRow, currentState) { output.push("") let fullName = row[0]; let trimmedName = fullName.trim(); - let spaceDiff = fullName.length - trimmedName.length - let lookupName=fullName.trim().replace(" ","_") + let spaceDiff=0; + while(spaceDiff3) { + trimmedName = " ".repeat(spaceDiff) + trimmedName + } output.push(composeCell(true, false, false, true, trimmedName, lastRow, false,url)); output.push(composeCell(true, true, false, true, row[5], lastRow, true)); From ade54d3218f221cb55de78c98389f99e5722b61e Mon Sep 17 00:00:00 2001 From: Dj Walker-Morgan Date: Tue, 8 Aug 2023 19:47:33 +0100 Subject: [PATCH 18/19] Added Pgvector link Signed-off-by: Dj Walker-Morgan --- advocacy_docs/pg_extensions/extensionrefs.json | 2 +- advocacy_docs/pg_extensions/index.mdx | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/advocacy_docs/pg_extensions/extensionrefs.json b/advocacy_docs/pg_extensions/extensionrefs.json index 990a6cedd81..7ae2f4fca03 100644 --- a/advocacy_docs/pg_extensions/extensionrefs.json +++ b/advocacy_docs/pg_extensions/extensionrefs.json @@ -63,7 +63,7 @@ "pglogical_2.x": "https://www.enterprisedb.com/docs/supported-open-source/pglogical2/", "pgrouting": "https://pgrouting.org/", "pgsnmpd_(11-13_)": "undefined", - "pgvector": "undefined", + "pgvector": "https://github.com/pgvector/pgvector", "pljava_(11)": "https://tada.github.io/pljava/", "plperl": "https://www.postgresql.org/docs/current/plperl.html", "plperl.plperlu": "https://www.postgresql.org/docs/current/plperl-trusted.html", diff --git a/advocacy_docs/pg_extensions/index.mdx b/advocacy_docs/pg_extensions/index.mdx index 299880eac4e..2481db6b75a 100644 --- a/advocacy_docs/pg_extensions/index.mdx +++ b/advocacy_docs/pg_extensions/index.mdx @@ -91,7 +91,7 @@ Categories of extensions: pgauditYes✓✓–✓–✓–– pglogical 2.x✓✓–––––– pgsnmpd (11-13 )✓–✓––––– -pgvector✓––––––– +pgvector✓––––––– pljava (11)✓–✓––––– plperl✓✓✓––✓✓✓     plperluYes✓✓✓––✓✓✓ From 16888430893c39bd3b0a008eff51116fb6df4bd1 Mon Sep 17 00:00:00 2001 From: Dj Walker-Morgan Date: Wed, 9 Aug 2023 07:54:00 +0100 Subject: [PATCH 19/19] Updated again for changed names Signed-off-by: Dj Walker-Morgan --- .../pg_extensions/extensionrefs.json | 26 +++++++++---------- advocacy_docs/pg_extensions/index.mdx | 8 +++--- 2 files changed, 17 insertions(+), 17 deletions(-) diff --git a/advocacy_docs/pg_extensions/extensionrefs.json b/advocacy_docs/pg_extensions/extensionrefs.json index 7ae2f4fca03..65eaaec7ba3 100644 --- a/advocacy_docs/pg_extensions/extensionrefs.json +++ b/advocacy_docs/pg_extensions/extensionrefs.json @@ -62,25 +62,25 @@ "pgaudit": "https://www.pgaudit.org/", "pglogical_2.x": "https://www.enterprisedb.com/docs/supported-open-source/pglogical2/", "pgrouting": "https://pgrouting.org/", - "pgsnmpd_(11-13_)": "undefined", + "pgsnmpd_(11-13)": "undefined", "pgvector": "https://github.com/pgvector/pgvector", "pljava_(11)": "https://tada.github.io/pljava/", "plperl": "https://www.postgresql.org/docs/current/plperl.html", "plperl.plperlu": "https://www.postgresql.org/docs/current/plperl-trusted.html", "plperl.bool_plperl": "https://www.postgresql.org/docs/current/plperl-funcs.html", "plperl.bool_plperlu": "https://www.postgresql.org/docs/current/plperl-funcs.html", - "plpythonu": "https://www.postgresql.org/docs/current/plpython.html", - "plpythonu.hstore_plpythonu": "undefined", - "plpythonu.jsonb_plpythonu": "undefined", - "plpythonu.ltree_plpythonu": "undefined", - "plpython2u_(11-14_)": "https://www.postgresql.org/docs/11/plpython-python23.html", - "plpython2u_(11-14_).hstore_plpython2u": "https://www.postgresql.org/docs/11/hstore.html#id-1.11.7.25.10", - "plpython2u_(11-14_).jsonb_plpython2u": "https://www.postgresql.org/docs/11/datatype-json.html#id-1.5.7.22.18", - "plpython2u_(11-14_).ltree_plpython2u": "https://www.postgresql.org/docs/11/ltree.html#id-1.11.7.30.8", - "plpython3u_(15+)": "https://www.postgresql.org/docs/current/plpython.html", - "plpython3u_(15+).hstore_plpython3u": "https://www.postgresql.org/docs/current/hstore.html#id-1.11.7.27.11", - "plpython3u_(15+).jsonb_plpython3u": "https://www.postgresql.org/docs/current/datatype-json.html#id-1.5.7.22.20", - "plpython3u_(15+).ltree_plpython3u": "https://www.postgresql.org/docs/current/ltree.html#id-1.11.7.32.9", + "plpythonu_(default_is_2u_for_11-14_and_3u_for_15)": "https://www.postgresql.org/docs/current/plpython.html", + "plpythonu_(default_is_2u_for_11-14_and_3u_for_15).hstore_plpythonu": "undefined", + "plpythonu_(default_is_2u_for_11-14_and_3u_for_15).jsonb_plpythonu": "undefined", + "plpythonu_(default_is_2u_for_11-14_and_3u_for_15).ltree_plpythonu": "undefined", + "plpython2u_(11-14)": "https://www.postgresql.org/docs/11/plpython-python23.html", + "plpython2u_(11-14).hstore_plpython2u": "https://www.postgresql.org/docs/11/hstore.html#id-1.11.7.25.10", + "plpython2u_(11-14).jsonb_plpython2u": "https://www.postgresql.org/docs/11/datatype-json.html#id-1.5.7.22.18", + "plpython2u_(11-14).ltree_plpython2u": "https://www.postgresql.org/docs/11/ltree.html#id-1.11.7.30.8", + "plpython3u_(11-15)": "https://www.postgresql.org/docs/current/plpython.html", + "plpython3u_(11-15).hstore_plpython3u": "https://www.postgresql.org/docs/current/hstore.html#id-1.11.7.27.11", + "plpython3u_(11-15).jsonb_plpython3u": "https://www.postgresql.org/docs/current/datatype-json.html#id-1.5.7.22.20", + "plpython3u_(11-15).ltree_plpython3u": "https://www.postgresql.org/docs/current/ltree.html#id-1.11.7.32.9", "pltcl": "https://www.postgresql.org/docs/current/pltcl.html", "pltcl.pltclu": "https://www.postgresql.org/docs/current/pltcl-overview.html", "set_user": "https://github.com/pgaudit/set_user", diff --git a/advocacy_docs/pg_extensions/index.mdx b/advocacy_docs/pg_extensions/index.mdx index 2481db6b75a..07e91c593bf 100644 --- a/advocacy_docs/pg_extensions/index.mdx +++ b/advocacy_docs/pg_extensions/index.mdx @@ -90,22 +90,22 @@ Categories of extensions: pg_store_plans✓––––––– pgauditYes✓✓–✓–✓–– pglogical 2.x✓✓–––––– -pgsnmpd (11-13 )✓–✓––––– +pgsnmpd (11-13)✓–✓––––– pgvector✓––––––– pljava (11)✓–✓––––– plperl✓✓✓––✓✓✓     plperluYes✓✓✓––✓✓✓     bool_plperl✓✓✓––✓✓✓     bool_plperluYes✓✓✓––✓✓✓ -plpythonuYes✓✓✓––––– +plpythonu (default is 2u for 11-14 and 3u for 15)Yes✓✓✓–––––     hstore_plpythonuYes✓✓✓–––––     jsonb_plpythonuYes✓✓✓–––––     ltree_plpythonuYes✓✓✓––––– -plpython2u (11-14 )✓✓✓––✓✓✓ +plpython2u (11-14)✓✓✓––✓✓✓     hstore_plpython2u✓✓✓––✓✓✓     jsonb_plpython2u✓✓✓––✓✓✓     ltree_plpython2u✓✓✓––✓✓✓ -plpython3u (15+)Yes✓✓✓––✓✓✓ +plpython3u (11-15)Yes✓✓✓––✓✓✓     hstore_plpython3uYes✓✓✓––✓✓✓     jsonb_plpython3uYes✓✓✓––✓✓✓     ltree_plpython3uYes✓✓✓––✓✓✓