From b321aba7044b634dd93f591993980ce745dd355e Mon Sep 17 00:00:00 2001 From: SamyOubouaziz Date: Tue, 29 Oct 2024 09:50:52 +0100 Subject: [PATCH 1/3] chore(gen): documentation review MTA-5202 --- .../scaleway-configuration-file.mdx | 2 +- .../scaleway-configuration-file.mdx | 2 +- .../scaleway-configuration-file.mdx | 2 +- .../scaleway-configuration-file.mdx | 20 +++++++++---------- .../containers/how-to/monitor-container.mdx | 2 +- 5 files changed, 14 insertions(+), 14 deletions(-) diff --git a/developer-tools/scaleway-cli/reference-content/scaleway-configuration-file.mdx b/developer-tools/scaleway-cli/reference-content/scaleway-configuration-file.mdx index 2808d13433..4049989d67 100644 --- a/developer-tools/scaleway-cli/reference-content/scaleway-configuration-file.mdx +++ b/developer-tools/scaleway-cli/reference-content/scaleway-configuration-file.mdx @@ -7,7 +7,7 @@ content: paragraph: This page explains what is the Scaleway configuration file for developer tools and how to use it. tags: developer tools cli configuration config dates: - validation: 2024-04-23 + validation: 2024-10-27 posted: 2023-04-23 categories: - devtools diff --git a/developer-tools/scaleway-sdk/reference-content/scaleway-configuration-file.mdx b/developer-tools/scaleway-sdk/reference-content/scaleway-configuration-file.mdx index c88fece92a..43369f9070 100644 --- a/developer-tools/scaleway-sdk/reference-content/scaleway-configuration-file.mdx +++ b/developer-tools/scaleway-sdk/reference-content/scaleway-configuration-file.mdx @@ -7,7 +7,7 @@ content: paragraph: This page explains what is the Scaleway configuration file for developer tools and how to use it. tags: developer tools cli configuration config sdk dates: - validation: 2024-04-23 + validation: 2024-10-27 posted: 2023-04-23 categories: - devtools diff --git a/developer-tools/terraform/reference-content/scaleway-configuration-file.mdx b/developer-tools/terraform/reference-content/scaleway-configuration-file.mdx index 692afe3ff5..b1966fe14c 100644 --- a/developer-tools/terraform/reference-content/scaleway-configuration-file.mdx +++ b/developer-tools/terraform/reference-content/scaleway-configuration-file.mdx @@ -7,7 +7,7 @@ content: paragraph: This page explains what is the Scaleway configuration file for developer tools and how to use it. tags: developer tools cli api configuration config terraform dates: - validation: 2024-04-23 + validation: 2024-10-27 posted: 2023-04-23 categories: - devtools diff --git a/macros/developer-tools/scaleway-configuration-file.mdx b/macros/developer-tools/scaleway-configuration-file.mdx index 45b44043f9..bc787bca3e 100644 --- a/macros/developer-tools/scaleway-configuration-file.mdx +++ b/macros/developer-tools/scaleway-configuration-file.mdx @@ -44,7 +44,7 @@ You can set up the Scaleway configuration file using several methods. However, w To initialize the configuration without the Scaleway CLI, you can simply create a `config.yaml` file in the appropriate folder: - - a **custom directory** defined as `$SCW_CONFIG_PATH` + - a **custom directory**: `$SCW_CONFIG_PATH` - an **XDG** base directory: `$XDG_CONFIG_HOME/scw/config.yaml` @@ -56,19 +56,19 @@ To initialize the configuration without the Scaleway CLI, you can simply create ### Single profile configuration file -```yaml -access_key: EXAMPLESCW34P0XKFD4 -secret_key: example-2b41-8d52-f888-8c8a460e -default_organization_id: example-468g-4f65-a41e-8b40766c5fc5 -default_project_id: example-468g-4f65-a41e-8b40766c5fc5 -default_zone: fr-par-1 -default_region: fr-par -api_url: https://api.scaleway.com +``` + access_key: EXAMPLESCW34P0XKFD4 + secret_key: example-2b41-8d52-f888-8c8a460e + default_organization_id: example-468g-4f65-a41e-8b40766c5fc5 + default_project_id: example-468g-4f65-a41e-8b40766c5fc5 + default_zone: fr-par-1 + default_region: fr-par + api_url: https://api.scaleway.com ``` ### Multi-profile configuration file -```yaml +``` profiles: myProfile1: access_key: EXAMPLESCW34P0XKFD4 diff --git a/serverless/containers/how-to/monitor-container.mdx b/serverless/containers/how-to/monitor-container.mdx index f2d1a06fdf..d4e39d833e 100644 --- a/serverless/containers/how-to/monitor-container.mdx +++ b/serverless/containers/how-to/monitor-container.mdx @@ -7,7 +7,7 @@ content: paragraph: Guide to monitoring Scaleway Serverless Containers. tags: serverless containers logs metrics cockpit grafana activity dates: - validation: 2024-04-22 + validation: 2024-10-27 posted: 2024-04-22 categories: - serverless From 6ccec5707ed9a3ed6eab07ca0ef91535a0b63ae8 Mon Sep 17 00:00:00 2001 From: SamyOubouaziz Date: Tue, 29 Oct 2024 10:17:42 +0100 Subject: [PATCH 2/3] chore(gen): update --- .../scaleway-configuration-file.mdx | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/macros/developer-tools/scaleway-configuration-file.mdx b/macros/developer-tools/scaleway-configuration-file.mdx index bc787bca3e..394e3ff027 100644 --- a/macros/developer-tools/scaleway-configuration-file.mdx +++ b/macros/developer-tools/scaleway-configuration-file.mdx @@ -57,13 +57,13 @@ To initialize the configuration without the Scaleway CLI, you can simply create ### Single profile configuration file ``` - access_key: EXAMPLESCW34P0XKFD4 - secret_key: example-2b41-8d52-f888-8c8a460e - default_organization_id: example-468g-4f65-a41e-8b40766c5fc5 - default_project_id: example-468g-4f65-a41e-8b40766c5fc5 - default_zone: fr-par-1 - default_region: fr-par - api_url: https://api.scaleway.com +access_key: EXAMPLESCW34P0XKFD4 +secret_key: example-2b41-8d52-f888-8c8a460e +default_organization_id: example-468g-4f65-a41e-8b40766c5fc5 +default_project_id: example-468g-4f65-a41e-8b40766c5fc5 +default_zone: fr-par-1 +default_region: fr-par +api_url: https://api.scaleway.com ``` ### Multi-profile configuration file From 20d356beff7283dd6f5e709a61d164a3d1bdad25 Mon Sep 17 00:00:00 2001 From: SamyOubouaziz Date: Mon, 4 Nov 2024 15:55:57 +0100 Subject: [PATCH 3/3] chore(gen): update --- console/account/how-to/change-console-appearance.mdx | 2 +- .../containers/how-to/create-auth-token-from-console.mdx | 8 +++----- .../reference-content/configure-trigger-inputs.mdx | 4 ++-- serverless/functions/how-to/monitor-function.mdx | 2 +- 4 files changed, 7 insertions(+), 9 deletions(-) diff --git a/console/account/how-to/change-console-appearance.mdx b/console/account/how-to/change-console-appearance.mdx index 620a4ed9ab..51a424ae0b 100644 --- a/console/account/how-to/change-console-appearance.mdx +++ b/console/account/how-to/change-console-appearance.mdx @@ -7,7 +7,7 @@ content: paragraph: Customize the appearance of the Scaleway console. tags: color-scheme change color theme dark-mode change-color dates: - validation: 2024-04-29 + validation: 2024-11-04 posted: 2022-10-12 categories: - console diff --git a/serverless/containers/how-to/create-auth-token-from-console.mdx b/serverless/containers/how-to/create-auth-token-from-console.mdx index 676215503d..615b41842f 100644 --- a/serverless/containers/how-to/create-auth-token-from-console.mdx +++ b/serverless/containers/how-to/create-auth-token-from-console.mdx @@ -7,14 +7,14 @@ content: paragraph: How to create an auth token from the Scaleway console. tags: authentication authentication-token containers auth dates: - validation: 2024-04-29 + validation: 2024-11-04 posted: 2022-10-14 categories: - serverless - containers --- -This page shows you how to create and manage an authentication token from the console. +This page shows you how to create and manage an authentication token from the Scaleway console. @@ -35,7 +35,7 @@ This page shows you how to create and manage an authentication token from the co 5. Click **Generate token** in the **Tokens** panel. A pop-up displays. -6. Enter the token description and set an expiration date for the token. Optionally, tick the box **No expiration date**, to have a token with unlimited validity. Then click **Generate token**. +6. Enter the token description and set an expiration date for the token. Optionally, tick the box **No expiration date**, to have a token with unlimited validity. Then, click **Generate token**. 7. Copy the token from the pop-up and store it in a safe environment. @@ -81,5 +81,3 @@ Tokens will expire by default on their given expiry date. You can delete them ma This action is irreversible, and this token will not be able to access your container anymore. - - diff --git a/serverless/containers/reference-content/configure-trigger-inputs.mdx b/serverless/containers/reference-content/configure-trigger-inputs.mdx index ec273afe63..6fc4733dac 100644 --- a/serverless/containers/reference-content/configure-trigger-inputs.mdx +++ b/serverless/containers/reference-content/configure-trigger-inputs.mdx @@ -7,7 +7,7 @@ content: paragraph: How to configure trigger inputs for Scaleway Serverless Containers. tags: containers dates: - validation: 2024-04-23 + validation: 2024-11-04 posted: 2023-06-09 categories: - serverless @@ -38,7 +38,7 @@ The first parameter to calculate is the **throughput**, which corresponds to the Container throughput = ( 1 / processing time ) * maximum instances ``` -For example, a container that takes 0.1 seconds to complete with a maximum of 10 replicas has a throughput of `( 1 / 0.1 ) * 10 = 100` messages per second. +For example, a container that takes 0.1 second to complete with a maximum of 10 replicas has a throughput of `( 1 / 0.1 ) * 10 = 100` messages per second. As long as the number of events sent to the input per second is lower than the container throughput, the events will be consumed almost immediately. However, if there is a burst of events higher than this value, they will be throttled and buffered in the input while they are consumed. diff --git a/serverless/functions/how-to/monitor-function.mdx b/serverless/functions/how-to/monitor-function.mdx index cac613ba9e..282b51b50c 100644 --- a/serverless/functions/how-to/monitor-function.mdx +++ b/serverless/functions/how-to/monitor-function.mdx @@ -7,7 +7,7 @@ content: paragraph: Monitor the performance and usage of your Scaleway Serverless Functions. tags: serverless functions logs metrics cockpit grafana activity dates: - validation: 2024-04-22 + validation: 2024-11-04 posted: 2024-04-22 categories: - serverless