Skip to content

[doc] Enhance installation page#100

Closed
pchovelon wants to merge 3 commits intomainfrom
doc-enhance-installation
Closed

[doc] Enhance installation page#100
pchovelon wants to merge 3 commits intomainfrom
doc-enhance-installation

Conversation

@pchovelon
Copy link
Copy Markdown
Collaborator

Three commits to enhance installation page.

Signed-off-by: Pierrick Chovelon <pierrick.chovelon@dalibo.com>
Signed-off-by: Pierrick Chovelon <pierrick.chovelon@dalibo.com>
Signed-off-by: Pierrick Chovelon <pierrick.chovelon@dalibo.com>
Comment thread docs/docs/installation.md

1. Install the plugin by applying the manifest located in the
`kubernetes` directory :
`cert-manager` must be installed before pgBackRest plugin.
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this is already listed on the introduction / first page. Do we need to list it again ?

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I say yes :) or at least a text to show how to verify the requirements

Comment thread docs/docs/installation.md

``` console
$ kubectl apply -f \
kubectl apply -f \
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't know if we should remove the $. If so, we should also change the console type and review all places where we provide commands.

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

When using the shortcut to copy and paste code, the $ is taken and then we cannot paste text.
So I suggest to remove it, and remove it in all code blocs.

@pchovelon pchovelon closed this Apr 17, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants