Skip to content

Commit

Permalink
Apply suggestions from code review
Browse files Browse the repository at this point in the history
Co-authored-by: Julia March <[email protected]>
  • Loading branch information
cnivolle and juliamrch authored Nov 26, 2024
1 parent e9d7dfc commit 5f547f8
Show file tree
Hide file tree
Showing 4 changed files with 7 additions and 7 deletions.
4 changes: 2 additions & 2 deletions content/doc/account/ssh-keys-management.md
Original file line number Diff line number Diff line change
Expand Up @@ -108,7 +108,7 @@ You may already have an SSH key and so do not need to generate a new one. To che
1. Whether you use macOS or Linux, open your Terminal application.
2. Run `cd ~/.ssh/` in your Terminal.
3. If the folder exists, run `ls` and check if a pair of key exists : *id_ed25519* and *id_ed25519.pub*.
Using *id_rsa* and *id_rsa.pub* is fine too. We are just advocating the use of *ed25519*.
Using *id_rsa* and *id_rsa.pub* is fine too. The recommendation here is to consider using *ed25519* instead.
Smaller to copy and way stronger than 2048-bit RSA keys.
If you can find them, you do not need to generate a new one, simply go to the following
"Add your key on Clever Cloud" part!
Expand Down Expand Up @@ -139,7 +139,7 @@ If you see "*access denied*" or "*password:*" when you [push on Clever Cloud](ht

### Through CC API or Clever cURL

You can also add a **public SSH key** from the command line with a simple cURL request to [our API](../openapi). The simpler way to do that is to use our CLI, [Clever Tools](https://github.com/CleverCloud/clever-tools), and its `clever curl` command once logged in:
You can also add a **public SSH key** from the command line using a cURL request to [our API](../openapi). The simpler way to do that is to use Clever Cloud CLI, [Clever Tools](https://github.com/CleverCloud/clever-tools), and its `clever curl` command once logged in:

Check warning on line 142 in content/doc/account/ssh-keys-management.md

View workflow job for this annotation

GitHub Actions / vale

[vale] content/doc/account/ssh-keys-management.md#L142

[Google.We] Try to avoid using first-person plural like 'our'.
Raw output
{"message": "[Google.We] Try to avoid using first-person plural like 'our'.", "location": {"path": "content/doc/account/ssh-keys-management.md", "range": {"start": {"line": 142, "column": 86}}}, "severity": "WARNING"}

Check notice on line 142 in content/doc/account/ssh-keys-management.md

View workflow job for this annotation

GitHub Actions / vale

[vale] content/doc/account/ssh-keys-management.md#L142

[Google.Contractions] Use 'that's' instead of 'that is'.
Raw output
{"message": "[Google.Contractions] Use 'that's' instead of 'that is'.", "location": {"path": "content/doc/account/ssh-keys-management.md", "range": {"start": {"line": 142, "column": 130}}}, "severity": "INFO"}

```bash
clever curl -X PUT -H "Content-Type: application/json" --data "\"$(cat ~/.ssh/yourkey.pub)\"" https://api.clever-cloud.com/v2/self/keys/newkeyname
Expand Down
2 changes: 1 addition & 1 deletion content/doc/administrate/database-migration.md
Original file line number Diff line number Diff line change
Expand Up @@ -59,4 +59,4 @@ As soon as you do so, the database will be set in read-only mode and the migrati

If the process succeeds, you will get a success screen. Every linked applications will automatically restart to use the new configuration. Please make sure to update configuration that do not use environment variable if you have some.

In case the database migration fails, you will be informed at wich point it did and a button to contact our support team will appear. Reach out to [Clever Cloud Support](https://console.clever-cloud.com/ticket-center-choice) with you add-on ID (available in the **Addon Dashboard** section) and they will help you finish the process.
In case the database migration fails, you will be informed at which point it did and a button to contact our support team will appear. Reach out to [Clever Cloud Support](https://console.clever-cloud.com/ticket-center-choice) with you add-on ID (available in the **Addon Dashboard** section) and they will help you finish the process.

Check warning on line 62 in content/doc/administrate/database-migration.md

View workflow job for this annotation

GitHub Actions / vale

[vale] content/doc/administrate/database-migration.md#L62

[Google.Will] Avoid using 'will'.
Raw output
{"message": "[Google.Will] Avoid using 'will'.", "location": {"path": "content/doc/administrate/database-migration.md", "range": {"start": {"line": 62, "column": 43}}}, "severity": "WARNING"}

Check notice on line 62 in content/doc/administrate/database-migration.md

View workflow job for this annotation

GitHub Actions / vale

[vale] content/doc/administrate/database-migration.md#L62

[Google.Passive] In general, use active voice instead of passive voice ('be informed').
Raw output
{"message": "[Google.Passive] In general, use active voice instead of passive voice ('be informed').", "location": {"path": "content/doc/administrate/database-migration.md", "range": {"start": {"line": 62, "column": 48}}}, "severity": "INFO"}

Check warning on line 62 in content/doc/administrate/database-migration.md

View workflow job for this annotation

GitHub Actions / vale

[vale] content/doc/administrate/database-migration.md#L62

[Google.We] Try to avoid using first-person plural like 'our'.
Raw output
{"message": "[Google.We] Try to avoid using first-person plural like 'our'.", "location": {"path": "content/doc/administrate/database-migration.md", "range": {"start": {"line": 62, "column": 106}}}, "severity": "WARNING"}

Check warning on line 62 in content/doc/administrate/database-migration.md

View workflow job for this annotation

GitHub Actions / vale

[vale] content/doc/administrate/database-migration.md#L62

[Google.Will] Avoid using 'will'.
Raw output
{"message": "[Google.Will] Avoid using 'will'.", "location": {"path": "content/doc/administrate/database-migration.md", "range": {"start": {"line": 62, "column": 123}}}, "severity": "WARNING"}

Check failure on line 62 in content/doc/administrate/database-migration.md

View workflow job for this annotation

GitHub Actions / vale

[vale] content/doc/administrate/database-migration.md#L62

[Vale.Spelling] Did you really mean 'Addon'?
Raw output
{"message": "[Vale.Spelling] Did you really mean 'Addon'?", "location": {"path": "content/doc/administrate/database-migration.md", "range": {"start": {"line": 62, "column": 266}}}, "severity": "ERROR"}

Check warning on line 62 in content/doc/administrate/database-migration.md

View workflow job for this annotation

GitHub Actions / vale

[vale] content/doc/administrate/database-migration.md#L62

[Google.Will] Avoid using 'will'.
Raw output
{"message": "[Google.Will] Avoid using 'will'.", "location": {"path": "content/doc/administrate/database-migration.md", "range": {"start": {"line": 62, "column": 302}}}, "severity": "WARNING"}
2 changes: 1 addition & 1 deletion content/doc/find-help/troubleshooting.md
Original file line number Diff line number Diff line change
Expand Up @@ -161,7 +161,7 @@ You have to pay all of your pending invoices to recover your data.

GitHub does not give us access to organizations created or joined *after* you've linked your GitHub account to Clever Cloud (which is a good thing). So you need to let the Clever Cloud API access it. You can do that on <https://GitHub.com/settings/applications>.

You can of course reach to [Clever Cloud Support](https://console.clever-cloud.com/ticket-center-choice) if this page was not helpful enough.
Feel free to reach to [Clever Cloud Support](https://console.clever-cloud.com/ticket-center-choice) if this page wasn't helpful enough.

{{% /details %}}

Expand Down
6 changes: 3 additions & 3 deletions content/guides/pgpool.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ Pgpool-II is not available on Docker instances. If you want to use Pgpool-II, yo
The various features are available in the [official Pgpool documentation](https://www.pgpool.net/docs/latest/en/html/index.html).

{{< callout type="info" >}}
We only support the **Streaming** mode, which is the most used and recommended mode for Pgpool-II. If you need other modes or features that are not supported on Clever Cloud, please contact [Clever Cloud Support](https://console.clever-cloud.com/ticket-center-choice).
PostreSQL add-ons only support the **Streaming** mode, which is the most used and recommended mode for Pgpool-II. If you need other modes or features that aren't supported on Clever Cloud, contact [Clever Cloud Support](https://console.clever-cloud.com/ticket-center-choice).
{{< /callout >}}

## How to configure Pgpool-II
Expand All @@ -64,7 +64,7 @@ If you ever need to stop using Pgpool-II, you can remove this variable or set it

Your application will use a Unix Domain Socket to connect to Pgpool-II. Unix domain sockets are faster than TCP sockets because there is no handshake and the connection is made locally on the same machine. A special environment variable will be injected to your environment variables: `CC_PGPOOL_SOCKET_PATH`. This variable contains the path to the Unix Domain Socket you have to connect to. See [Usage](#usage) below for some examples on how to use it.

The available Pgpool-II variables and their descriptions are available on our [environment variables reference page](https://www.clever-cloud.com/doc/reference/reference-environment-variables/).
The available Pgpool-II variables and their descriptions are available on the [environment variables reference page](https://www.clever-cloud.com/doc/reference/reference-environment-variables/).

### Concurrent session and pool size

Expand Down Expand Up @@ -106,7 +106,7 @@ It's also possible to specify the lifetime of a Pgpool-II child process (`CC_PGP

Use Pgpool-II to distribute the load and separate **WRITE** and **READ** queries between your PostgreSQL servers.

When using the **Streaming** mode, it's not Pgpool-II that manages the replication of your databases. Replication must be set up on the PostgreSQL side, otherwise known as **binary**, **Hot Standby** or **Streaming** replication. To schedule this procedure, you can contact [Clever Cloud Support](https://console.clever-cloud.com/ticket-center-choice) or make a request via our [sales form](https://www.clever-cloud.com/en/contact-sales).
When using the **Streaming** mode, it's not Pgpool-II that manages the replication of your databases. Clever Cloud engineers must manually set up the replication on the PostgreSQL side, otherwise known as **binary**, **Hot Standby** or **Streaming** replication. To schedule this procedure, you can contact [Clever Cloud Support](https://console.clever-cloud.com/ticket-center-choice) or make a request via our [sales form](https://www.clever-cloud.com/en/contact-sales).

Check warning on line 109 in content/guides/pgpool.md

View workflow job for this annotation

GitHub Actions / vale

[vale] content/guides/pgpool.md#L109

[Google.We] Try to avoid using first-person plural like 'our'.
Raw output
{"message": "[Google.We] Try to avoid using first-person plural like 'our'.", "location": {"path": "content/guides/pgpool.md", "range": {"start": {"line": 109, "column": 408}}}, "severity": "WARNING"}

Once replication is in place, you can use the `CC_PGPOOL_FOLLOWERS` environment variable to add the followers to your Pgpool-II configuration. This variable is in **JSON** format, and must contain the **host**, **port** and **weight** of each follower.

Expand Down

0 comments on commit 5f547f8

Please sign in to comment.