fix: errors in platform folder (#61)

.github/vale/styles/Aiven/Generic.yml

@@ -5,7 +5,6 @@ ignorecase: true
 tokens:
   - click here
   - follow the steps
-  - if you want to
   - this article
   - this guide
   - this help article

.github/vale/styles/Aiven/WeaselWords.yml

@@ -7,6 +7,7 @@ tokens:
   - quickly
   - merely
   - simply
+  # - best
   - hardly
   - shortly
   - slowly

.github/vale/styles/Aiven/Wordiness-error.yml

@@ -0,0 +1,15 @@
+extends: substitution
+message: "Using '%s' instead of '%s'."
+ignorecase: true
+level: error
+action:
+  name: replace
+swap:
+  spin up: start
+  if you want to: to
+  you need to: imperative
+  pre-requisites: prerequisite
+  (?:take|apply)? ?(?:the )?following steps: nothing
+  and then: and
+  to see a list: to list
+  proceed as follows: nothing

.github/vale/styles/Aiven/Wordiness.yml

@@ -123,5 +123,4 @@ swap:
   these instructions: use the title of the page
   in case: if
   in the case of: if
-  pre-requisites: prerequisites
-  (?:take|apply)? ?(?:the )?following steps: nothing
+  check that: ensure

.github/vale/styles/config/vocabularies/Aiven/accept.txt

@@ -33,6 +33,7 @@ Centrify
 checkpointing
 CIDRs
 ClickHouse
+Cloudera
 CloudWatch
 codecs
 compliances
@@ -294,12 +295,14 @@ Unschedule
 untrusted
 UpCloud
 upsert
+URIs?
 UUID
 UUIDs
 vectorizing
 virtualized
 VM
 VMs
+ECEs?
 VNet
 VPC/MS
 VPCs?

.markdownlint.jsonc

@@ -20,6 +20,15 @@
   "MD050": {"style": "asterisk"},
   "MD013": {"line_length": 90},
   "MD033": {
-    "allowed_elements": ["table", "DocCardList", "Clouds", "details", "summary"]
+    "allowed_elements": [
+      "table",
+      "DocCardList",
+      "Clouds",
+      "details",
+      "summary",
+      "EarlyBadge",
+      "LimitedBadge",
+      "ProBadge"
+    ]
   }
 }

.vscode/aiven.code-snippets

@@ -132,5 +132,10 @@
     "scope": "markdown",
     "prefix": ["contact", "sales"],
     "body": ["contact the [sales team](mailto:sales@aiven.io)"]
+  },
+  "Contact support": {
+    "scope": "markdown",
+    "prefix": ["contact", "support"],
+    "body": ["contact the [support team](mailto:support@aiven.io)"]
   }
 }

docs/integrations/datadog/datadog-logs.md

@@ -4,14 +4,14 @@ title: Send logs to Datadog
 
 Use the Aiven Rsyslog integration to send the logs from your Aiven services to Datadog.
 
-You will need:
+Before you begin, ensure you know:
 
--   A Datadog account, and which region it is in.
--   A Datadog API key. Generate an API key by visiting **Organization
-    settings** under your account menu, and then choose **API Keys**.
-    The **New Key** button will give you an API key. Make a note of it.
--   An Aiven account with a project set up. You\'ll need the name of the
-    project.
+- The region of your Datadog account.
+- Your Datadog API key. Generate an API key for your Datadog account
+  in the **Organization settings**, and click **API Keys** > **New Key**. Make sure to
+  copy this key.
+- An Aiven account with a project set up. You'll need the name of the
+  project.
 
 ## Configure the integration
 
@@ -20,28 +20,28 @@ setup only needs to be done once.
 
 1.  Log in to the [Aiven Console](https://console.aiven.io/), and select
     **Integration endpoints** from the left sidebar in the project page.
-2.  Select **Syslog** from the list in the **Integration endpoints**
-    screen, and then select **Add new endpoint**.
-3.  Configure the settings for the new endpoint:
+1.  Select **Syslog** from the list in the **Integration endpoints**
+    screen, and select **Add new endpoint**.
+1.  Configure the settings for the new endpoint:
     -   **Endpoint name** is how you will refer to this logs integration
         when linking it to other Aiven services
     -   **Server** and **Port** (leave TLS enabled):
         -   For region USA use `intake.logs.datadoghq.com` and `10516`
         -   For region EU use `tcp-intake.logs.datadoghq.eu` and `443`
-    -   **Format** set to \"custom\"
-4.  Configure the **Log Template** field. You will need to replace the
+    -   **Format** set to `custom`.
+1.  Configure the **Log Template** field. You will need to replace the
     following values:
 
     | Variable             | Description                        |
     | -------------------- | ---------------------------------- |
     | `DATADOG_API_KEY`    | From your Datadog account settings |
     | `AIVEN_PROJECT_NAME` | Found in the web console           |
 
-This is the format to use, replacing the variables listed. Don\'t edit
+This is the format to use, replacing the variables listed. Don't edit
 the values surrounded by `%` signs, such as `%msg%` as these are used in
 constructing the log line:
 
-```
+```text
 DATADOG_API_KEY <%pri%>1 %timestamp:::date-rfc3339% %HOSTNAME%.AIVEN_PROJECT_NAME %app-name% - - - %msg%
 ```
 
@@ -62,7 +62,7 @@ this correlation with the metrics. See the [Datadog
 documentation](https://docs.datadoghq.com/integrations/rsyslog).
 :::
 
-4.  Select **Create** to save the endpoint.
+1.  Select **Create** to save the endpoint.
 
 ## Send logs from an Aiven service to Datadog
 
@@ -73,12 +73,12 @@ To send logs to Datadog:
 
     ![Screenshot of system integrations including rsyslog](/images/integrations/rsyslog-service-integration.png)
 
-2.  Pick the log integration you created earlier from the dropdown and
+1.  Pick the log integration you created earlier from the dropdown and
     choose **Enable**.
 
-3.  Visit Datadog and look under \"Logs\" to see the data flowing within
+1.  Visit Datadog and look under \"Logs\" to see the data flowing within
     a few minutes.
 
 ## Related pages
 
-Learn more about [Datadog and Aiven](/docs/integrations/datadog).
+- [Datadog and Aiven](/docs/integrations/datadog)

docs/integrations/datadog/datadog-metrics.md

@@ -6,14 +6,12 @@ Send metrics from your Aiven service to your Datadog account.
 
 ## Prepare your Datadog account
 
-Before you begin, ensure that you have the following details ready:
+Before you begin, ensure you know:
 
--   Determine whether your Datadog account is located in the US or EU
-    region.
--   A Datadog API key. Generate an API key for your Datadog account by
-    visiting the **Organization settings** in your account menu. Select
-    **API Keys** and then select **New Key** to obtain the API key. Make
-    sure to copy this key.
+- The region of your Datadog account.
+- Your Datadog API key. Generate an API key for your Datadog account
+  in the **Organization settings**, and click **API Keys** > **New Key**. Make sure to
+  copy this key.
 
 ## Configure the service integration endpoint
 
@@ -22,21 +20,20 @@ you intend to use. Afterward, multiple services can use this service
 integration endpoint.
 
 1.  Log in to the [Aiven Console](https://console.aiven.io/).
-2.  In the **Services** screen, select **Integration endpoints** on the
+1.  In the **Services** screen, select **Integration endpoints** on the
     left sidebar.
-3.  Select **Datadog** and then select **Add new endpoint** or **Create
-    new**.
-4.  Configure the endpoint by providing a name for this integration and
+1.  Select **Datadog** > **Add new endpoint** or **Create new**.
+1.  Configure the endpoint by providing a name for this integration and
     entering the API key you copied earlier. Ensure that the correct
     region is selected.
 
     ![Screenshot of the Datadog configuration screen](/images/integrations/configure-datadog-service-integration.png)
 
-5.  Optionally, include additional tags that will be used when sending
+1.  Optionally, include additional tags that will be used when sending
     metrics to Datadog. Refer to
     [Add custom tags Datadog integration](/docs/integrations/datadog/add-custom-tags-to-datadog) to learn more about adding tags to the Datadog
     integration. You can always add or edit tags later.
-6.  Select **Add endpoint** to save this configuration.
+1.  Select **Add endpoint** to save this configuration.
 
 ## Add Datadog metrics integration to your Aiven service
 
@@ -45,18 +42,18 @@ metric tracking in Datadog, follow these steps:
 
 1.  In the [Aiven Console](https://console.aiven.io/), select your
     service.
-2.  From the **Overview** page of your service, scroll to **Service
+1.  From the **Overview** page of your service, scroll to **Service
     integrations** and select **Manage integrations**.
-3.  In the **Integrations** screen, select **Datadog Metrics**.
-4.  Select the Datadog endpoint you want to use from the drop-down list
+1.  In the **Integrations** screen, select **Datadog Metrics**.
+1.  Select the Datadog endpoint you want to use from the drop-down list
     and select **Enable**.
 
-:::tip
-If you're using Aiven for Apache Kafka® you can also
-[customise the metrics sent to Datadog](/docs/products/kafka/howto/datadog-customised-metrics).
-:::
+    :::tip
+    If you're using Aiven for Apache Kafka® you can also
+    [customise the metrics sent to Datadog](/docs/products/kafka/howto/datadog-customised-metrics).
+    :::
 
-5.  Return to your Datadog dashboard and after a few minutes, you should
+1.  Return to your Datadog dashboard and after a few minutes, you should
     see the data start to arrive from your Aiven services.
 
 ## Related pages

docs/integrations/prometheus-system-metrics.md

@@ -2,17 +2,15 @@
 title: Prometheus system metrics
 ---
 
-Learn how to check what metrics are available for monitoring your
-service using Prometheus, and find out which of the available metrics
-are particularly worth monitoring and why.
+Learn how to check what metrics are available for monitoring your service using Prometheus, and find out which of the available metrics are particularly worth monitoring and why.
 
 ## About the Prometheus integration
 
 The Prometheus integration allows you to monitor your Aiven services and
 understand the resource usage. Using this integration, you can also
 track some non-service-specific metrics that may be worth monitoring.
 
-To start using Prometheus for monitoring the metrics, you need to
+To start using Prometheus for monitoring the metrics,
 [configure the Prometheus integration and set up the Prometheus server](/docs/platform/howto/integrations/prometheus-metrics).
 
 ## Get a list of available service metrics
@@ -30,7 +28,7 @@ request to your Prometheus service endpoint.
     -   Username
     -   Password
 
-2.  Make a request to get a snapshot of your metrics, replacing the
+1.  Make a request to get a snapshot of your metrics, replacing the
     placeholders in the following code with the values for your service:
 
     ```bash
@@ -98,7 +96,7 @@ collect and monitor:
 | Metrics             | Description                                                                                                           |
 | ------------------- | --------------------------------------------------------------------------------------------------------------------- |
 | `disk_free`         | Free space on the service disk                                                                                        |
-| `disk_used`         | Used space on the disk, for example, `8.0e+9` (8,000,000,000 bytes)                                                   |
+| `disk_used`         | Used space on the disk, for example, `1.0e+9` (8,000,000,000 bytes)                                                   |
 | `disk_total`        | Total space on the disk (free and used)                                                                               |
 | `disk_used_percent` | Percentage of the disk space used equal to `disk_used / disk_total * 100`, for example, `80` (80% service disk usage) |
 | `disk_inodes_free`  | Number of index nodes available on the service disk                                                                   |

docs/integrations/rsyslog.md

@@ -2,22 +2,20 @@
 title: Remote syslog integration
 ---
 
-In addition to using Aiven for OpenSearch® to store the logs from your
-Aiven services, you can also integrate with an external monitoring
-system that supports the rsyslog protocol.
+In addition to using Aiven for OpenSearch® to store the logs from your Aiven services, you can also integrate with an external monitoring system that supports the rsyslog protocol.
 
 ## Creating rsyslog integration
 
 ### Add rsyslog integration endpoint
 
-As the first step, you need to add the remote syslog you want to send
+Add the remote syslog you want to send
 the log to into the project that contains the service you want to
 integrate.
 
 This can be configured from the **Integration endpoints** page in the
 Aiven Console.
 
-![\"Create new Syslog endpoint\" dialog](/images/integrations/remote-syslog-endpoint.png)
+!["Create new Syslog endpoint" dialog](/images/integrations/remote-syslog-endpoint.png)
 
 Another option is to use the [Aiven
 Client](https://github.com/aiven/aiven-client) .
@@ -102,14 +100,14 @@ CLI though the examples are easier to copy and paste in the CLI form.
 
 ### Coralogix {#rsyslog_coralogix}
 
-For [Coralogix](https://coralogix.com/) integration you need to use a
+For a [Coralogix](https://coralogix.com/) integration, use a
 custom `logline` format with your key and company ID.
 
 The Syslog Endpoint to use for `server` depends on your account:
 
--   if it ends with `.com` use `syslogserver.coralogix.com`
--   if it ends with `.us` use `syslogserver.coralogix.us`
--   if it ends with `.in` use `syslogserver.app.coralogix.in`
+-   If it ends with `.com`, use `syslogserver.coralogix.com`.
+-   If it ends with `.us`, use `syslogserver.coralogix.us`.
+-   If it ends with `.in`, use `syslogserver.app.coralogix.in`.
 
 See the Coralogix [Rsyslog](https://coralogix.com/docs/) documentation
 for more information.
@@ -128,7 +126,7 @@ avn service integration-endpoint-create --project your-project \
 
 ### Loggly® {#rsyslog_loggly}
 
-For [Loggly](hthtps://www.loggly.com/) integration, you need to use a
+For [Loggly](hthtps://www.loggly.com/) integration, use a
 custom `logline` format with your token.
 
 ```bas
@@ -141,7 +139,7 @@ avn service integration-endpoint-create --project your-project \
 
 ### Mezmo (LogDNA) {#rsyslog_mezmo}
 
-For [Mezmo](https://www.mezmo.com/) syslog integration you need to use a
+For [Mezmo](https://www.mezmo.com/) syslog integration, use a
 custom `logline` format with your key.
 
 ```bash
@@ -154,7 +152,7 @@ avn service integration-endpoint-create --project your-project \
 
 ### New Relic {#rsyslog_new_relic}
 
-For [New Relic](https://newrelic.com/) Syslog integration you need to
+For [New Relic](https://newrelic.com/) Syslog integration,
 use a custom `logline` format with your license key. This is so you can
 prepend your [New Relic License
 Key](https://docs.newrelic.com/docs/apis/intro-apis/new-relic-api-keys/#license-key)
@@ -167,7 +165,7 @@ The value to use for `server` depends on the account location:
     endpoint will not work for an EU account)
 -   `newrelic.syslog.nr-data.net` for other regions
 
-For more information see [Use TCP endpoint to forward logs to New
+For more information, see [Use TCP endpoint to forward logs to New
 Relic](https://docs.newrelic.com/docs/logs/log-api/use-tcp-endpoint-forward-logs-new-relic/)
 
 ```bash
@@ -182,7 +180,7 @@ avn service integration-endpoint-create --project your-project \
 
 As [Papertrail](https://www.papertrail.com/) identifies the client based
 on the server and port you only need to copy the appropriate values from
-the \"Log Destinations\" page and use those as the values for `server`
+the "Log Destinations" page and use those as the values for `server`
 and `port` respectively. You **do not need** the ca-bundle as the
 Papertrail servers use certificates signed by a known CA. You also need
 to set the format to `rfc3164` .
@@ -196,7 +194,7 @@ avn service integration-endpoint-create --project your-project \
 
 ### Sumo Logic® {#rsyslog_sumo_logic}
 
-For [Sumo Logic](https://www.sumologic.com/) you need to use a custom
+For [Sumo Logic](https://www.sumologic.com/), use a custom
 `logline` format with your collector token, use the server and port of
 the collector, and replace `YOUR_DEPLOYMENT` with one of `au`, `ca`,
 `de`, `eu`, `fed`, `in`, `jp`, `us1` or `us2`. See [Cloud Syslog