Skip to content

docs(gen): documentation review MTA-5696 #4617

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Mar 14, 2025
Merged

docs(gen): documentation review MTA-5696 #4617

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
94008fd
docs(gen): documentation review MTA-5696
SamyOubouaziz Mar 13, 2025
2ade1ce
docs(gen): updated
SamyOubouaziz Mar 13, 2025
b0a03e7
docs(gen): updated
SamyOubouaziz Mar 13, 2025
5519dc6
Update pages/serverless-containers/how-to/modify-container-privacy.mdx
SamyOubouaziz Mar 14, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions docs/DOC_PAGE_TEMPLATE.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ tags: # enter tags here
dates:
validation: 1970-01-01
posted: 1970-01-01
validation_frequency: 96
categories:
- # product category (e.g. compute, serverless, managed-databases, etc.)
---
Expand Down
2 changes: 1 addition & 1 deletion pages/block-storage/reference-content/differences-between-5kiops-volumes.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ content:
paragraph: Learn the key differences between Block Storage and Block Storage Low Latency 5K IOPS volumes to choose the optimal storage solution for your needs.
tags: differences-5kiops volumes block-storage 5kiops
dates:
validation: 2024-09-05
validation: 2025-03-13
posted: 2024-09-05
categories:
- storage
Expand Down
6 changes: 3 additions & 3 deletions pages/serverless-containers/api-cli/deploy-container-api.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ content:
paragraph: Deploy containers using the Scaleway API.
tags: containers api deploy
dates:
validation: 2024-08-28
validation: 2025-03-15
posted: 2021-08-18
categories:
- serverless
Expand Down Expand Up @@ -53,15 +53,15 @@ Refer to the [Scaleway Developers website](https://www.scaleway.com/en/developer
-d '{
"name": "<YOUR_CONTAINER_NAME>",
"namespace_id": "<YOUR_NAMESPACE_ID>",
"runtime": "<RUNTIME>"
"registry_image": "<YOUR_REGISTRY_IMAGE>:<TAG>"
}' \
"https://api.scaleway.com/containers/v1beta1/regions/fr-par/containers"
```

An output similar to the following displays:

```json
{"id":"ef777a64-1f4e-4d43-8227-26927c7de057", "name":"your-container-name", "namespace_id":"example-fb93-43e3-a036-7be69f1af7a1", "status":"created", "environment_variables":{}, "min_scale":0, "max_scale":5, "runtime":"python310", "memory_limit":256, "cpu_limit":140, "timeout":"300s", "handler":"handler.handle", "error_message":null, "privacy":"public", "description":"", "domain_name":"namespaceg04rnwx-container-example.containers.cnt.fr-par.scw.cloud", "secret_environment_variables":[], "http_option":"enabled", "runtime_message":"", "build_message":null, "region":"fr-par"}%
{"id":"example-f150-4c7d-a226-ae201f4a5024","name":"example","namespace_id":"example-50e9-4553-afa0-3b0e6bac0d19","status":"created","environment_variables":{},"min_scale":0,"max_scale":5,"memory_limit":2048,"cpu_limit":1000,"timeout":"300s","error_message":null,"privacy":"public","description":"","registry_image":"rg.fr-par.scw.cloud/funcscwexample/example_image:latest","max_concurrency":50,"domain_name":"funcscwexample.functions.fnc.fr-par.scw.cloud","protocol":"http1","port":8080,"secret_environment_variables":[],"http_option":"enabled","sandbox":"v2","local_storage_limit":1000,"scaling_option":{"concurrent_requests_threshold":50},"created_at":"2025-03-13T14:53:49.753864618Z","updated_at":"2025-03-13T14:53:49.753864618Z","ready_at":null,"health_check":{"failure_threshold":30,"interval":"10s","tcp":{}},"region":"fr-par"}
```

<Message type="note">
Expand Down
42 changes: 25 additions & 17 deletions pages/serverless-containers/api-cli/deploy-container-cli.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,23 +56,31 @@ categories:
An output similar to the following displays:

```
ID 717fb5f9-95c3-4c0b-84db-2321283e46dc
Name <CONTAINER_NAME>
NamespaceID cee31af8-d43e-4078-8f55-c921a9311f47
Status created
MinScale 0
MaxScale 5
Runtime python310
MemoryLimit 256
CPULimit 140
Timeout 5 minutes
Handler handler.handle
Privacy public
Description -
DomainName namespace0leshy-cli-fn-containername.containers.fnc.fr-par.scw.cloud
Region fr-par
HTTPOption enabled
RuntimeMessage -
ID a02135d2-70f1-4ae5-9595-ef93e41b764c
Name example
NamespaceID example-a3e1-4877-bf88-f64f621d0a33
Status pending
MinScale 0
MaxScale 5
MemoryLimit 2048
CPULimit 1000
Timeout 5 minutes
Privacy public
Description -
RegistryImage nginx:latest
MaxConcurrency 50
DomainName example.functions.fnc.fr-par.scw.cloud
Protocol http1
Port 80
HTTPOption enabled
Sandbox v2
LocalStorageLimit 1000
ScalingOption.ConcurrentRequestsThreshold 50
HealthCheck.FailureThreshold 30
HealthCheck.Interval 10 seconds
CreatedAt now
UpdatedAt now
Region fr-par
```

<Message type="note">
Expand Down
2 changes: 1 addition & 1 deletion pages/serverless-containers/how-to/delete-a-container.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ content:
paragraph: How to delete a container in Scaleway.
tags: delete container containers
dates:
validation: 2024-08-28
validation: 2025-03-13
posted: 2021-05-26
categories:
- serverless
Expand Down
8 changes: 4 additions & 4 deletions pages/serverless-containers/how-to/modify-container-privacy.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,14 +7,14 @@ content:
paragraph: Modify the privacy settings of Scaleway Serverless Containers.
tags: container privacy-policy
dates:
validation: 2024-08-28
validation: 2025-03-15
posted: 2021-05-26
categories:
- serverless
- containers
---

This page shows you how to modify a container's [privacy policy](/serverless-containers/concepts/#privacy-policy), if you wish to do so after creation.
This page shows you how to modify a container's [privacy policy](/serverless-containers/concepts/#privacy-policy), after its creation.

<Macro id="requirements" />

Expand All @@ -23,13 +23,13 @@ This page shows you how to modify a container's [privacy policy](/serverless-con
- [Deployed a container](/serverless-containers/how-to/deploy-container/)

<Message type="note">
Setting a container to private will not take care of the actual authentication, as token validation is done at runtime. For further information, refer to the [developers documentation](https://www.scaleway.com/en/developers/api/serverless-containers/#authentication).
Setting a container to private will not handle the actual authentication, as token validation is done at runtime. For further information, refer to the [developers documentation](https://www.scaleway.com/en/developers/api/serverless-containers/#authentication).
</Message>

1. Click **Containers** in the **Serverless** section of the side menu. The containers page displays.
2. Click the relevant containers namespace.
3. Click the name of the container whose privacy policy you want to modify.
4. Click the **Security** tab.
5. In the **Privacy Policies** panel, select **Public** or **Private** as required.
5. In the **Privacy Policies** panel, select **Public** or **Private**, as required.


2 changes: 1 addition & 1 deletion pages/serverless-containers/reference-content/containers-limitations.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ content:
paragraph: Learn about the limitations of Scaleway Serverless Containers.
tags: containers limitations serverless
dates:
validation: 2024-09-02
validation: 2025-03-13
posted: 2021-10-12
categories:
- serverless
Expand Down
7 changes: 4 additions & 3 deletions pages/serverless-functions/api-cli/deploy-function-api.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ content:
paragraph: Deploy Serverless Functions via the Scaleway API following this instructional guide.
tags: functions api deploy
dates:
validation: 2024-08-28
validation: 2025-03-13
posted: 2021-08-18
categories:
- serverless
Expand Down Expand Up @@ -68,7 +68,7 @@ Refer to the [Scaleway Developers website](https://www.scaleway.com/en/developer
3. Create a zip file containing your function's code by following [this procedure](/serverless-functions/how-to/package-function-dependencies-in-zip/).

<Message type="note">
For testing purposes, you can create a zip archive with a simple Python file named `handler.py` inside, that contains the following code:
For testing purposes, you can create a zip archive with a simple Python file named `handler.py` at the root of the archive, that contains the following code:

```python
def handle(event, context):
Expand Down Expand Up @@ -109,4 +109,5 @@ Refer to the [Scaleway Developers website](https://www.scaleway.com/en/developer

```
curl <YOUR_FUNCTION_ENDPOINT>
```
```

2 changes: 1 addition & 1 deletion pages/serverless-functions/api-cli/deploy-function-cli.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ content:
paragraph: Deploy Serverless Functions using Scaleway's CLI with this detailed guide.
tags: functions cli deploy
dates:
validation: 2024-08-28
validation: 2025-03-13
posted: 2021-08-18
categories:
- serverless
Expand Down
2 changes: 1 addition & 1 deletion pages/serverless-jobs/how-to/manage-job-schedule.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ content:
h1: How to manage the scheduling of a Serverless Job
paragraph: Manage job schedules efficiently in Scaleway Serverless.
dates:
validation: 2024-09-02
validation: 2025-03-13
posted: 2024-02-27
categories:
- serverless
Expand Down
2 changes: 1 addition & 1 deletion pages/serverless-sql-databases/how-to/add-users.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ content:
paragraph: Learn how to add users to your Scaleway serverless SQL database.
tags: sql-databases serverless database iam postgresql
dates:
validation: 2024-08-28
validation: 2025-03-13
posted: 2023-08-11
categories:
- serverless
Expand Down
4 changes: 1 addition & 3 deletions pages/serverless-sql-databases/how-to/configure-autoscaling.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ content:
paragraph: Guide to configure autoscaling for Scaleway serverless SQL databases.
tags: database serverless-sql-database serverless-db serverless-database postgresql
dates:
validation: 2024-08-28
validation: 2025-03-13
posted: 2023-08-11
categories:
- serverless
Expand Down Expand Up @@ -39,5 +39,3 @@ This page shows you how to edit the autoscaling of a Serverless SQL Database usi
6. Click **Apply changes**.

The new autoscaling parameters appear in the **Database information** section.


14 changes: 8 additions & 6 deletions pages/serverless-sql-databases/how-to/connect-to-a-database.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
---
meta:
title: How to connect to a Serverless SQL Database
description: Step-by-step guide to connect to a Scaleway serverless SQL database.
description: Step-by-step guide to connect to a Scaleway Serverless SQL Database.
content:
h1: How to connect to a Serverless SQL Database
paragraph: Step-by-step guide to connect to a Scaleway serverless SQL database.
paragraph: Step-by-step guide to connect to a Scaleway Serverless SQL Database.
tags: database serverless-sql-database serverless-db serverless-database postgresql
dates:
validation: 2024-08-28
Expand All @@ -19,7 +19,7 @@ This page shows you how to set up the connection to a Serverless SQL Database us

To connect to a Serverless SQL Database, you can either use a **connection string**, or **connection parameters**.

- A connection string provides the necessary information and parameters to establish a connection between an [IAM user](/iam/concepts/#user) or [application](/iam/concepts/#application) and the database. The string is written as follows:
- A connection string provides the necessary information and parameters to establish a connection between an [IAM user](/iam/concepts/#user) or [application](/iam/concepts/#application), and the database. The string is written as follows:
```sh
postgres://[user-or-application-id]:[api-secret-key]@[database-hostname]:5432/[database-name]?sslmode=require
```
Expand Down Expand Up @@ -59,7 +59,7 @@ To connect to a Serverless SQL Database, you can either use a **connection strin
</Message>
3. Set up the **connection string** or **connection parameters**.
<Tabs id="sdb-connect">
<TabsTab label="With a secret key">
<TabsTab label="With an existing API key">
<br/>
If you already have an [API secret key](/iam/concepts/#api-key), replace the `[INSERT_SECRET_KEY_HERE]` placeholder with your **secret key** as shown below.
- Connection string:
Expand All @@ -75,11 +75,13 @@ To connect to a Serverless SQL Database, you can either use a **connection strin
PGDATABASE="serverless-sqldb-example-db"
```
</TabsTab>
<TabsTab label="Without a secret key">
<TabsTab label="Without an existing API key">
<br/>
If you do not have an [API secret key](/iam/concepts/#api-key), click **Generate new secret key**.
If you do not have an [API key](/iam/concepts/#api-key), click **Generate new secret key**.

A new secret key is created, and inserted directly into the connection string and parameters.

The newly created API key can be found in the [API keys section](https://console.scaleway.com/iam/api-keys) of the Scaleway Console.
</TabsTab>
</Tabs>
4. Copy your connection string or parameters and store them securely, as they will only be shown once.
Expand Down
8 changes: 4 additions & 4 deletions pages/serverless-sql-databases/how-to/delete-a-database.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
---
meta:
title: How to delete a database
description: Step-by-step instructions to delete a Scaleway serverless SQL database.
description: Step-by-step instructions to delete a Scaleway Serverless SQL Database.
content:
h1: How to delete a database
paragraph: Step-by-step instructions to delete a Scaleway serverless SQL database.
tags: database
paragraph: Step-by-step instructions to delete a Scaleway Serverless SQL Database.
tags: database delete drop db suppress stop
dates:
validation: 2024-08-28
validation: 2025-03-13
posted: 2023-08-11
categories:
- serverless
Expand Down
2 changes: 1 addition & 1 deletion pages/serverless-sql-databases/how-to/manage-permissions.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ content:
paragraph: Guide to manage permissions in Scaleway serverless SQL databases.
tags: sql-databases serverless database iam serverless-db serverless-database postgresql
dates:
validation: 2024-08-28
validation: 2025-03-13
posted: 2023-08-11
categories:
- serverless
Expand Down