Skip to content

Commit 3508fa6

Browse files
SamyOubouazizRoRoJ
andauthored
docs(gen): documentation review MTA-5696 (#4617)
* docs(gen): documentation review MTA-5696 * docs(gen): updated * docs(gen): updated * Update pages/serverless-containers/how-to/modify-container-privacy.mdx Co-authored-by: Rowena Jones <[email protected]> --------- Co-authored-by: Rowena Jones <[email protected]>
1 parent fef757f commit 3508fa6

15 files changed

+57
-47
lines changed

docs/DOC_PAGE_TEMPLATE.mdx

+1
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@ tags: # enter tags here
99
dates:
1010
validation: 1970-01-01
1111
posted: 1970-01-01
12+
validation_frequency: 96
1213
categories:
1314
- # product category (e.g. compute, serverless, managed-databases, etc.)
1415
---

pages/block-storage/reference-content/differences-between-5kiops-volumes.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ content:
77
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.
88
tags: differences-5kiops volumes block-storage 5kiops
99
dates:
10-
validation: 2024-09-05
10+
validation: 2025-03-13
1111
posted: 2024-09-05
1212
categories:
1313
- storage

pages/serverless-containers/api-cli/deploy-container-api.mdx

+3-3
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ content:
77
paragraph: Deploy containers using the Scaleway API.
88
tags: containers api deploy
99
dates:
10-
validation: 2024-08-28
10+
validation: 2025-03-15
1111
posted: 2021-08-18
1212
categories:
1313
- serverless
@@ -53,15 +53,15 @@ Refer to the [Scaleway Developers website](https://www.scaleway.com/en/developer
5353
-d '{
5454
"name": "<YOUR_CONTAINER_NAME>",
5555
"namespace_id": "<YOUR_NAMESPACE_ID>",
56-
"runtime": "<RUNTIME>"
56+
"registry_image": "<YOUR_REGISTRY_IMAGE>:<TAG>"
5757
}' \
5858
"https://api.scaleway.com/containers/v1beta1/regions/fr-par/containers"
5959
```
6060

6161
An output similar to the following displays:
6262

6363
```json
64-
{"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"}%
64+
{"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"}
6565
```
6666

6767
<Message type="note">

pages/serverless-containers/api-cli/deploy-container-cli.mdx

+25-17
Original file line numberDiff line numberDiff line change
@@ -56,23 +56,31 @@ categories:
5656
An output similar to the following displays:
5757

5858
```
59-
ID 717fb5f9-95c3-4c0b-84db-2321283e46dc
60-
Name <CONTAINER_NAME>
61-
NamespaceID cee31af8-d43e-4078-8f55-c921a9311f47
62-
Status created
63-
MinScale 0
64-
MaxScale 5
65-
Runtime python310
66-
MemoryLimit 256
67-
CPULimit 140
68-
Timeout 5 minutes
69-
Handler handler.handle
70-
Privacy public
71-
Description -
72-
DomainName namespace0leshy-cli-fn-containername.containers.fnc.fr-par.scw.cloud
73-
Region fr-par
74-
HTTPOption enabled
75-
RuntimeMessage -
59+
ID a02135d2-70f1-4ae5-9595-ef93e41b764c
60+
Name example
61+
NamespaceID example-a3e1-4877-bf88-f64f621d0a33
62+
Status pending
63+
MinScale 0
64+
MaxScale 5
65+
MemoryLimit 2048
66+
CPULimit 1000
67+
Timeout 5 minutes
68+
Privacy public
69+
Description -
70+
RegistryImage nginx:latest
71+
MaxConcurrency 50
72+
DomainName example.functions.fnc.fr-par.scw.cloud
73+
Protocol http1
74+
Port 80
75+
HTTPOption enabled
76+
Sandbox v2
77+
LocalStorageLimit 1000
78+
ScalingOption.ConcurrentRequestsThreshold 50
79+
HealthCheck.FailureThreshold 30
80+
HealthCheck.Interval 10 seconds
81+
CreatedAt now
82+
UpdatedAt now
83+
Region fr-par
7684
```
7785

7886
<Message type="note">

pages/serverless-containers/how-to/delete-a-container.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ content:
77
paragraph: How to delete a container in Scaleway.
88
tags: delete container containers
99
dates:
10-
validation: 2024-08-28
10+
validation: 2025-03-13
1111
posted: 2021-05-26
1212
categories:
1313
- serverless

pages/serverless-containers/how-to/modify-container-privacy.mdx

+4-4
Original file line numberDiff line numberDiff line change
@@ -7,14 +7,14 @@ content:
77
paragraph: Modify the privacy settings of Scaleway Serverless Containers.
88
tags: container privacy-policy
99
dates:
10-
validation: 2024-08-28
10+
validation: 2025-03-15
1111
posted: 2021-05-26
1212
categories:
1313
- serverless
1414
- containers
1515
---
1616

17-
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.
17+
This page shows you how to modify a container's [privacy policy](/serverless-containers/concepts/#privacy-policy), after its creation.
1818

1919
<Macro id="requirements" />
2020

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

2525
<Message type="note">
26-
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).
26+
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).
2727
</Message>
2828

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

3535

pages/serverless-containers/reference-content/containers-limitations.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ content:
77
paragraph: Learn about the limitations of Scaleway Serverless Containers.
88
tags: containers limitations serverless
99
dates:
10-
validation: 2024-09-02
10+
validation: 2025-03-13
1111
posted: 2021-10-12
1212
categories:
1313
- serverless

pages/serverless-functions/api-cli/deploy-function-api.mdx

+4-3
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ content:
77
paragraph: Deploy Serverless Functions via the Scaleway API following this instructional guide.
88
tags: functions api deploy
99
dates:
10-
validation: 2024-08-28
10+
validation: 2025-03-13
1111
posted: 2021-08-18
1212
categories:
1313
- serverless
@@ -68,7 +68,7 @@ Refer to the [Scaleway Developers website](https://www.scaleway.com/en/developer
6868
3. Create a zip file containing your function's code by following [this procedure](/serverless-functions/how-to/package-function-dependencies-in-zip/).
6969

7070
<Message type="note">
71-
For testing purposes, you can create a zip archive with a simple Python file named `handler.py` inside, that contains the following code:
71+
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:
7272

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

110110
```
111111
curl <YOUR_FUNCTION_ENDPOINT>
112-
```
112+
```
113+

pages/serverless-functions/api-cli/deploy-function-cli.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ content:
77
paragraph: Deploy Serverless Functions using Scaleway's CLI with this detailed guide.
88
tags: functions cli deploy
99
dates:
10-
validation: 2024-08-28
10+
validation: 2025-03-13
1111
posted: 2021-08-18
1212
categories:
1313
- serverless

pages/serverless-jobs/how-to/manage-job-schedule.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ content:
66
h1: How to manage the scheduling of a Serverless Job
77
paragraph: Manage job schedules efficiently in Scaleway Serverless.
88
dates:
9-
validation: 2024-09-02
9+
validation: 2025-03-13
1010
posted: 2024-02-27
1111
categories:
1212
- serverless

pages/serverless-sql-databases/how-to/add-users.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ content:
77
paragraph: Learn how to add users to your Scaleway serverless SQL database.
88
tags: sql-databases serverless database iam postgresql
99
dates:
10-
validation: 2024-08-28
10+
validation: 2025-03-13
1111
posted: 2023-08-11
1212
categories:
1313
- serverless

pages/serverless-sql-databases/how-to/configure-autoscaling.mdx

+1-3
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ content:
77
paragraph: Guide to configure autoscaling for Scaleway serverless SQL databases.
88
tags: database serverless-sql-database serverless-db serverless-database postgresql
99
dates:
10-
validation: 2024-08-28
10+
validation: 2025-03-13
1111
posted: 2023-08-11
1212
categories:
1313
- serverless
@@ -39,5 +39,3 @@ This page shows you how to edit the autoscaling of a Serverless SQL Database usi
3939
6. Click **Apply changes**.
4040

4141
The new autoscaling parameters appear in the **Database information** section.
42-
43-

pages/serverless-sql-databases/how-to/connect-to-a-database.mdx

+8-6
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
---
22
meta:
33
title: How to connect to a Serverless SQL Database
4-
description: Step-by-step guide to connect to a Scaleway serverless SQL database.
4+
description: Step-by-step guide to connect to a Scaleway Serverless SQL Database.
55
content:
66
h1: How to connect to a Serverless SQL Database
7-
paragraph: Step-by-step guide to connect to a Scaleway serverless SQL database.
7+
paragraph: Step-by-step guide to connect to a Scaleway Serverless SQL Database.
88
tags: database serverless-sql-database serverless-db serverless-database postgresql
99
dates:
1010
validation: 2024-08-28
@@ -19,7 +19,7 @@ This page shows you how to set up the connection to a Serverless SQL Database us
1919

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

22-
- 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:
22+
- 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:
2323
```sh
2424
postgres://[user-or-application-id]:[api-secret-key]@[database-hostname]:5432/[database-name]?sslmode=require
2525
```
@@ -59,7 +59,7 @@ To connect to a Serverless SQL Database, you can either use a **connection strin
5959
</Message>
6060
3. Set up the **connection string** or **connection parameters**.
6161
<Tabs id="sdb-connect">
62-
<TabsTab label="With a secret key">
62+
<TabsTab label="With an existing API key">
6363
<br/>
6464
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.
6565
- Connection string:
@@ -75,11 +75,13 @@ To connect to a Serverless SQL Database, you can either use a **connection strin
7575
PGDATABASE="serverless-sqldb-example-db"
7676
```
7777
</TabsTab>
78-
<TabsTab label="Without a secret key">
78+
<TabsTab label="Without an existing API key">
7979
<br/>
80-
If you do not have an [API secret key](/iam/concepts/#api-key), click **Generate new secret key**.
80+
If you do not have an [API key](/iam/concepts/#api-key), click **Generate new secret key**.
8181

8282
A new secret key is created, and inserted directly into the connection string and parameters.
83+
84+
The newly created API key can be found in the [API keys section](https://console.scaleway.com/iam/api-keys) of the Scaleway Console.
8385
</TabsTab>
8486
</Tabs>
8587
4. Copy your connection string or parameters and store them securely, as they will only be shown once.

pages/serverless-sql-databases/how-to/delete-a-database.mdx

+4-4
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
11
---
22
meta:
33
title: How to delete a database
4-
description: Step-by-step instructions to delete a Scaleway serverless SQL database.
4+
description: Step-by-step instructions to delete a Scaleway Serverless SQL Database.
55
content:
66
h1: How to delete a database
7-
paragraph: Step-by-step instructions to delete a Scaleway serverless SQL database.
8-
tags: database
7+
paragraph: Step-by-step instructions to delete a Scaleway Serverless SQL Database.
8+
tags: database delete drop db suppress stop
99
dates:
10-
validation: 2024-08-28
10+
validation: 2025-03-13
1111
posted: 2023-08-11
1212
categories:
1313
- serverless

pages/serverless-sql-databases/how-to/manage-permissions.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ content:
77
paragraph: Guide to manage permissions in Scaleway serverless SQL databases.
88
tags: sql-databases serverless database iam serverless-db serverless-database postgresql
99
dates:
10-
validation: 2024-08-28
10+
validation: 2025-03-13
1111
posted: 2023-08-11
1212
categories:
1313
- serverless

0 commit comments

Comments
 (0)