Skip to content

Commit 6301f82

Browse files
SamyOubouazizbene2k1RoRoJ
authored
chore(gen): documentation review MTA-5103 (#3782)
* chore(gen): documentation review MTA-5103 * chore(gen): update * chore(gen): update * chore(gen): update * chore(gen): update * chore(gen): update * chore(gen): update * Apply suggestions from code review Co-authored-by: Benedikt Rollik <[email protected]> Co-authored-by: Rowena Jones <[email protected]> --------- Co-authored-by: Benedikt Rollik <[email protected]> Co-authored-by: Rowena Jones <[email protected]>
1 parent bf2b2c5 commit 6301f82

File tree

12 files changed

+41
-45
lines changed

12 files changed

+41
-45
lines changed

console/account/how-to/recover-a-lost-password.mdx

Lines changed: 11 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ content:
77
paragraph: Recover a lost password for your Scaleway account.
88
tags: account password recovery login
99
dates:
10-
validation: 2024-03-27
10+
validation: 2024-10-01
1111
posted: 2021-06-11
1212
categories:
1313
- console
@@ -19,29 +19,30 @@ If you forget or lose the password to your [Scaleway account](https://console.sc
1919

2020
- A [Scaleway](https://www.scaleway.com/en/) account
2121

22-
## Passwordless authentication using a Magic Link
22+
## Log in without a password using a magic link
2323

24-
The [Magic Link](/console/account/how-to/log-in-to-the-console/) allows you to access your account without a password, using multifactor authentication.
24+
The [magic link](/console/account/how-to/log-in-to-the-console/) allows you to access your account without a password, using multifactor authentication.
2525

26-
Click **Send a Magic Link** on the Login page of the Scaleway console.
26+
Click **Send magic link** on the Login page of the Scaleway console.
2727

2828
A secret link is sent to your email. You can access your account by clicking on the link.
2929

30-
## Password reset using email validation
30+
## Reset your password using email validation
3131

3232
If you forget or lose your password, you can request to reset it.
3333

34-
1. Go to the [lost password](https://console.scaleway.com/forgot-password/) page of the console:
34+
1. From the [Scaleway console login page](https://account.scaleway.com/), Click **Log in with password**.
35+
1. Click **Forgot your password?**, or access the [lost password](https://console.scaleway.com/forgot-password/) page.
3536
2. Enter your email address and click **Reset password**. A password reset link is sent to your email address.
3637
3. Click the link in the email address to reset your password.
3738
4. Enter your new password and click **Reset password** to set the new password for your account. You are redirected to the Login page.
3839
5. Log in to the console with your email address and your new password.
3940

40-
## Password recovery in case of lost email account
41+
## Recover your password if you lost access to your email account
4142

42-
If you lose access to your email account, it will not be possible to reset the password directly from the Scaleway console.
43+
If you lose access to your email account, you will not be able to reset the password directly from the Scaleway console.
4344

44-
In case you can no longer access your email account, you must send us a request to update your contact information with the following pieces of identification:
45+
If you cannot access your email account, you must send us a request to update your contact information with the following pieces of identification:
4546

4647
* Email address
4748
* Postal address
@@ -53,7 +54,7 @@ In case you can no longer access your email account, you must send us a request
5354
* Copy of your last Scaleway invoice or the amount charged if you do not have a copy
5455
* A card or bank statement showing your Scaleway invoice debit
5556

56-
Once you have gathered all the required documents, the request has to be sent by email to: [[email protected]](mailto:[email protected]).
57+
Once you have gathered all the required documents, send the request by email to: [[email protected]](mailto:[email protected]).
5758

5859
We will update the email address on receipt of the application, subject to validation.
5960

console/account/troubleshooting/cannot-erase-account.mdx

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,19 @@
11
---
22
meta:
3-
title: I cannot erase my account and personal data
3+
title: I cannot close my account and erase personal data
44
description: Resolve issues encountered when deleting Scaleway accounts.
55
content:
66
h1: I cannot erase my account and personal data
77
paragraph: Resolve issues encountered when deleting Scaleway accounts.
88
tags: account close delete deactivate close-account
99
dates:
10-
validation: 2024-03-28
10+
validation: 2024-10-01
1111
posted: 2024-03-28
1212
categories:
1313
- console
1414
---
1515

16-
## My request to erase my account and personal data has failed
16+
## My request to close my account and erase personal data has failed
1717

1818
### Problem
1919
When you click the **Send request** button, an error message appears. This message says that you still have active resources.
@@ -32,4 +32,4 @@ I received an email explaining that my request to erase my account and personal
3232
You may have unpaid consumption, preventing us from proceeding with your request.
3333

3434
### Solution
35-
You can check your consumption from your [Billing space](https://console.scaleway.com/billing). All invoices must be marked as paid, and your current consumption must be zero. Once these criteria are met, you can send another request to delete your account and personal data.
35+
You can check your consumption from your [Billing space](https://console.scaleway.com/billing). All invoices must be marked as paid, and your current consumption must be zero. Once these criteria are met, you can send another request to delete your account and erase personal data.

faq/serverless-functions.mdx

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ content:
66
h1: Serverless Functions
77
hero: assets/faas.webp
88
dates:
9-
validation: 2024-03-25
9+
validation: 2024-10-03
1010
category: serverless
1111
---
1212

@@ -16,21 +16,21 @@ category: serverless
1616

1717
Serverless Functions is billed on a pay-as-you-go basis. Three components are taken into account:
1818

19-
* **Monthly Request number:** each time your function is invoked we increase a counter.
19+
* **Monthly request number:** each time your function is invoked we increase a counter.
2020

2121
* **Resource consumption:** this component is obtained by multiplying the memory tiers chosen by the duration of each function invocation.
2222

23-
* **Resources provision:** in order to mitigate cold start, users can choose to keep some function Instances warm (by filing the min scale value). We then charge for the provisioned resources similarly to the Resources consumption component.
23+
* **Resources provision:** in order to mitigate cold start, users can choose to keep some function instances warm (by filing the minimum scale value). We then charge for the provisioned resources similarly to the Resources consumption component.
2424

2525
The scheme below illustrates our billing model:
2626

2727
<Lightbox src={["scaleway-Billing-FaaS-1-DEF.webp", "scaleway-Billing-FaaS-2-DEF.webp"]} size={"medium"} alt={["Functions Billing", "Functions Billing"]} />
2828

2929
### Pricing
3030

31-
* **Monthly requests:** **€0.15 per million requests** and we offer **1M free requests** per account per month.
31+
* **Monthly requests:** **€0.15 per million requests**, and we offer **1M free requests** per account per month.
3232

33-
* **Resources consumption:** **€1.20 per 100 000 GB-s** and we provide **400 000 GB-s free tiers** per account and per month.
33+
* **Resources consumption:** **€1.20 per 100 000 GB-s**, and we provide **400 000 GB-s free tiers** per account and per month.
3434

3535
| Memory provisioned | Cost per second |
3636
|---------------------|-----------------|
@@ -157,7 +157,7 @@ Serverless Functions use cases are wide so [several ways to deploy functions](/s
157157

158158
## How can I test my functions locally?
159159

160-
Local development is useful for debugging, profiling, testing etc... so we provide libraries to do this: [local testing doc](/serverless/functions/reference-content/local-testing/).
160+
Scaleway provides libraries to run your functions locally, for debugging, profiling, and testing purposes. Refer to the [dedicated documentation](/serverless/functions/reference-content/local-testing/) for more information.
161161

162162
## Where can I find some advanced code examples for functions?
163163

faq/serverless-jobs.mdx

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ content:
66
h1: Serverless Jobs
77
hero: assets/serverless-jobs.webp
88
dates:
9-
validation: 2024-03-25
9+
validation: 2024-10-03
1010
category: serverless
1111
---
1212

@@ -84,19 +84,18 @@ Serverless Jobs are integrated with [Cockpit](/observability/cockpit/quickstart/
8484

8585
## Can I cancel or modify a Serverless Job after it has started?
8686

87-
An ongoing Serverless Job can be interrupted during its execution from the **Job runs** section of a job's **Overview** tab.
87+
An ongoing Serverless Job can be interrupted during its execution from the **Job runs** section of a job's **Overview** tab. Refer to the [dedicated docmentation](/serverless/jobs/how-to/stop-job/) for more information.
8888

8989
## How can I automate the deployment and management of Scaleway Serverless Jobs?
9090

9191
Scaleway Serverless Jobs is part of the Scaleway ecosystem, it can therefore be driven using the [Scaleway CLI](/developer-tools/scaleway-cli/quickstart/), the [Scaleway API](https://www.scaleway.com/en/developers/api/), and other [developer tools](https://www.scaleway.com/en/developers/). Our serverless ecosystem offers a lot of possibilities with event-driven architectures, and integrations with more products of the Scaleway ecosystem are under active development.
9292

93-
## Do Serverless Jobs offer parallelization?
93+
## Can I run multiple Serverless Jobs at the same time?
9494

95-
Not yet. Scaleway Serverless Jobs will soon offer parallelization via a `parallelism` parameter for each job. This will automatically launch a given number of replicas of the Job container in parallel.
95+
When starting a job, you can use contextual options to define the number of jobs to execute at the same time. Refer to the [dedicated documentation](/serverless/jobs/how-to/run-job/#how-to-run-a-job-with-contextual-options) for more information.
9696

9797
## How can I configure access to a Private Network?
9898

9999
Scaleway Serverless Jobs does not currently support Scaleway VPC or Private Networks, though this feature is under development.
100100

101-
To add network restrictions on your resource, consult the [list of prefixes used at Scaleway](https://www.scaleway.com/en/peering/). Serverless resources do not have dedicated or predictable IP addresses.
102-
101+
To add network restrictions on your resource, consult the [list of prefixes used at Scaleway](https://www.scaleway.com/en/peering/). Serverless resources do not have dedicated or predictable IP addresses.

faq/serverless-sql-databases.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ category: serverless
1414

1515
You are billed both for the compute resources provisioned and the storage used. You can see the cost estimate in the Database creation wizard.
1616

17-
- **Compute**: You are billed based on compute resources (vCPU and RAM) provisioned to handle your workload. Provisioned resources evolve according to the [autoscaling](/serverless/sql-databases/reference-content/serverless-sql-databases-overview/#autoscaling) parameter and stay between the minimum and maximum thresholds defined for your database. For each vCPU provisioned, 4 GB of RAM will be allocated.
17+
- **Compute**: You are billed based on compute resources (vCPU and RAM) provisioned to handle your workload. Provisioned resources evolve according to the [autoscaling](/serverless/sql-databases/reference-content/serverless-sql-databases-overview/#autoscaling) parameter, and stay between the minimum and maximum thresholds defined for your database. For each vCPU provisioned, 4 GB of RAM will be allocated.
1818

1919
- **Storage**: You are billed for the storage consumed by your database. Storage price is based on the size of your database (in GB) and includes 7 days of automated backups at no additional costs. Storage is always billed even if your database is in an active state or idle state.
2020

serverless/containers/how-to/add-a-custom-domain-to-a-container.mdx

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ content:
77
paragraph: Add a custom domain to Scaleway Serverless Containers.
88
tags: custom-domain container serverless cname record
99
dates:
10-
validation: 2024-03-27
10+
validation: 2024-10-01
1111
posted: 2022-02-21
1212
categories:
1313
- serverless
@@ -23,10 +23,10 @@ Each container comes with an automatically generated domain, on which it is avai
2323
- A running [Serverless Container](/serverless/containers/how-to/deploy-a-container-from-scaleway-container-registry/)
2424
- Registered a domain name with the provider of your choice and have access to the domain name's DNS zone file
2525

26-
If you are using **Cloudflare DNS**, see the note below regarding proxying.
27-
2826
1. On your domain provider's platform (for example, [Scaleway's domains](/network/domains-and-dns/how-to/manage-dns-records/)), add a CNAME record pointing to your container default URL in the domain's DNS zone file.
2927

28+
29+
3030
<Message type="note">
3131
- All domains are supported.
3232
- When using a root domain:
@@ -81,15 +81,15 @@ HTTP-01 challenge failure (and by extension, a custom domain in `error` status)
8181
| DNS record is not available yet. | This can be the case if the custom domain is created immediately after the CNAME is configured on your DNS provider side. | As a rule of thumb, wait a few minutes after creating the CNAME on your DNS provider, or at least wait until the DNS record is available on main resolvers (`1.1.1.1`, `8.8.8.8`). |
8282
| DNS cache is stale (still pointing to an old endpoint). | If the custom domain was pointing to another endpoint before adding the CNAME record to the Serverless Container, and if the TTL is greater than the maximum time of the check (3 min), it can sometimes happen that the custom domain still resolves to the old endpoint, thus making the challenge fail. | Wait until DNS entry is available and use a smaller TTL. |
8383
| Negative DNS cache is stale | If the initial check fails (DNS record is not available yet), and the negative TTL configured on your DNS provider side is high, the negative TTL will prevent subsequent checks from querying the nameserver again, until it expires. Depending on the negative TTL configured, this can take more or less time. | Either reduce the negative TTL in your DNS provider configuration, or just wait until you are sure DNS record is available. If you already tried to add the custom domain and faced this issue, you likely have to wait for the negative TTL to expire before making another attempt (so the cache can also expire on our side). |
84-
| Route `/.well-known/acme-challenge` is not handled correctly. | To perform the HTTP-01 challenge, a call will be made on `<your_custom_domain>/.well-known/acme-challenge/<token>`. If you are using a proxying/caching tool (like Cloudflare) between the custom domain and the Serverless Container endpoint, a cached version of that route can be served, making the check fails. | Don't configure caching rules for routes starting with `/.well-known/acme-challenge`. See an example below with Cloudflare. |
84+
| Route `/.well-known/acme-challenge` is not handled correctly. | To perform the HTTP-01 challenge, a call will be made on `<your_custom_domain>/.well-known/acme-challenge/<token>`. If you are using a proxying/caching tool (like Cloudflare) between the custom domain and the Serverless Container endpoint, a cached version of that route can be served, making the check fails. | Do not configure caching rules for routes starting with `/.well-known/acme-challenge`. Refer to the example below with Cloudflare. |
8585

8686
Example of configuration on Cloudflare to disable caching with "Cache rules":
8787

8888
<Lightbox src="cloudflare-bypass-cache-well-known-acme-challenge.webp" size="medium" alt="Bypass cache for /.well-known/acme-challenge routes" />
8989

9090
## Migrating an active domain
9191

92-
Read this section if you are trying to migrate a domain that is already serving a live website/API/web application -- but not yet hosted on a Serverless Container -- and you are trying to migrate.
92+
Read this section if you are trying to migrate a domain that is already serving a live website/API/web application, but not yet hosted on a Serverless Container.
9393

9494
To clarify, let's take a concrete example:
9595

serverless/containers/reference-content/containers-concurrency.mdx

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ content:
66
h1: Containers concurrency
77
paragraph: Learn about concurrency settings for Scaleway Serverless Containers.
88
dates:
9-
validation: 2024-03-26
9+
validation: 2024-10-03
1010
posted: 2024-03-26
1111
tags: serverless containers concurrency concurrent execution scaling parallelism parallel instances
1212
categories:
@@ -20,8 +20,6 @@ Concurrency determines the number of incoming requests a single instance of a co
2020

2121
A higher number of instances processing requests at the same time implies a greater usage of memory and [vCPU](/serverless/containers/concepts/#vcpu), and consequently a higher cost.
2222

23-
24-
2523
## Maximum concurrent requests per instance
2624

2725
When [deploying a container](/serverless/containers/how-to/deploy-a-container-from-scaleway-container-registry/), Scaleway Serverless Containers allows you to edit the **Maximum concurrent requests per instance** parameter.

serverless/containers/reference-content/deploy-container.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ content:
66
h1: Methods to deploy Serverless Containers
77
paragraph: Step-by-step guide to deploying a container on Scaleway.
88
dates:
9-
validation: 2024-03-27
9+
validation: 2024-10-03
1010
posted: 2023-03-10
1111
---
1212

@@ -58,7 +58,7 @@ Installation instructions and documentation are available in the [Scaleway CLI r
5858

5959
## Scaleway SDKs
6060

61-
The Scaleway SDKs allow you to manage your resources directly from your favorite languages.
61+
The Scaleway Software Development Kits (SDK) allow you to manage your resources directly from your favorite languages.
6262

6363
The available SDKs are:
6464

serverless/functions/reference-content/local-testing.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ content:
77
paragraph: Learn how to test your Serverless Functions locally before deployment on Scaleway.
88
tags: functions serverless local testing
99
dates:
10-
validation: 2024-03-27
10+
validation: 2024-10-03
1111
posted: 2023-03-06
1212
categories:
1313
- serverless
@@ -51,5 +51,5 @@ with different libraries available to your local development environment.
5151
Performance during local testing can differ from the deployed Serverless Functions environment, and will involve [limitations](/serverless/functions/reference-content/functions-limitations/) around resource usage and quotas.
5252

5353
<Message type="note">
54-
CPU/Memory settings do not apply when testing functions locally.
54+
CPU/memory settings do not apply when testing functions locally.
5555
</Message>

serverless/jobs/reference-content/jobs-limitations.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ content:
77
paragraph: Learn the limitations of Scaleway Serverless Jobs.
88
tags: Jobs limitations serverless
99
dates:
10-
validation: 2024-03-28
10+
validation: 2024-10-03
1111
posted: 2021-03-28
1212
categories:
1313
- serverless
@@ -25,7 +25,7 @@ This section contains usage limits that apply when using Serverless Jobs.
2525
| Max ephemeral storage | 10 GB | Job run |
2626
| CPU max | 6 VCPU | Job run |
2727
| Memory max | 16 GB | Job run |
28-
| timeout | 24h | Job run |
28+
| Timeout | 24h | Job run |
2929

3030
## Default values for CPU and memory limits
3131

0 commit comments

Comments
 (0)