Skip to content
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.

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

chore(gen): docs review MTA-5542 #4384

Merged
merged 6 commits into from
Feb 12, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
11 changes: 6 additions & 5 deletions pages/account/how-to/change-language.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ content:
paragraph: Switch languages in the Scaleway account interface.
tags: account language change
dates:
validation: 2024-07-29
validation: 2025-02-11
posted: 2021-06-22
categories:
- console
Expand All @@ -20,10 +20,11 @@ You can choose which language you would like to view the [Scaleway console](/acc
- A [Scaleway account](https://console.scaleway.com)

1. Log into the [Scaleway console](https://console.scaleway.com).
2. Click your Organization name in the top right corner of the Dedibox console to open the Organization drop-down menu (A), then click the **Profile** button (B). The **User Account** screen displays:
<Lightbox src="scaleway-console-menu.webp" alt="" />
3. In the User information section, click the **Edit profile** button. The **Edit your account profile** screen displays:
<Lightbox src="scaleway-edit-profile.webp" alt="" />

2. Click your Organization name in the top right corner of the console to open the Organization drop-down menu, then click the **Profile** button. The **User Account** screen displays.

3. In the User information section, click the **Edit profile** button. The **Edit your account profile** screen displays.

4. Choose your preferred language from the drop-down list, then click **Confirm changes**.

Your console will now be displayed in your preferred language, which will also be used for all marketing and product communications you receive. You can change your preferred language at any time by repeating this procedure.
16 changes: 10 additions & 6 deletions pages/account/how-to/configure-support-plans.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ content:
paragraph: Set up and configure support plans in Scaleway.
tags: support-plans support-plan configure
dates:
validation: 2024-07-29
validation: 2025-02-11
posted: 2021-06-22
categories:
- console
Expand All @@ -18,14 +18,18 @@ categories:
- A Scaleway account logged into the [console](https://console.scaleway.com)
- [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization

The default support plan for an Organization is the **Basic** plan, but it can be upgraded on the **Support Plan** tab of the Organization page:
The default support plan for an Organization is the **Basic** plan, but it can be upgraded from the Scaleway console.

<Lightbox src="scaleway-support-plans-overview.webp" alt="" />
1. Click on the name of your Organization in the top-right corner of the console, then select **Support plan**.

- Select a plan and click **Select Plan** to proceed. A pop-up displays a disclaimer message informing you that your payment will be made automatically on the current month's invoice. Make sure you have carefully read the message.
- Click **I understand** to confirm the change.
<Lightbox src="scaleway-support-plans-overview.webp" alt="" />

<Lightbox src="scaleway-support-plan-confirmation.webp" alt="" />

2. Select a plan, and click **Select Plan** to proceed. A pop-up displays a disclaimer message informing you that your payment will be made automatically on the current month's invoice.

3. Read the message carefully, then click **I understand** to confirm the change.

<Lightbox src="scaleway-support-plan-confirmation.webp" alt="" />

An overview of your previous and current plans is available under **Support Plans History**.

Expand Down
11 changes: 5 additions & 6 deletions pages/account/how-to/manage-my-personal-data-gdpr.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ content:
paragraph: Manage personal data under GDPR regulations in Scaleway.
tags: personal-data manage privacy portability
dates:
validation: 2024-07-29
validation: 2025-02-11
posted: 2021-05-28
categories:
- console
Expand All @@ -29,11 +29,10 @@ This page offers you a number of possibilities to manage your personal data and
## How to access your personal data

1. Scroll to the **Access your personal data** panel.
2. Either:
- Check the first box to obtain information about your personal data processed by Scaleway, or
- Check the second box to obtain a copy of your personal data processed by Scaleway
3. Check the box marked **I certify that I have the necessary rights to make this request**.
4. Click **Send request**.
2. Check the first box to obtain information about your personal data processed by scaleway.
3. Check the second box to obtain a copy of your personal data processed by Scaleway.
4. Check the box marked **I certify that I have the necessary rights to make this request**.
5. Click **Send request**.

## How to rectify your personal data

Expand Down
2 changes: 1 addition & 1 deletion pages/account/how-to/verify-identity.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ content:
paragraph: Verify your identity for secure Scaleway account access.
tags: verification identify account id id-verification
dates:
validation: 2024-07-29
validation: 2025-02-11
posted: 2021-06-11
categories:
- console
Expand Down
2 changes: 1 addition & 1 deletion pages/account/quickstart.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ content:
paragraph: Quickly get started with managing Scaleway accounts.
tags: create-account delete-account create-resources create corporate
dates:
validation: 2024-07-29
validation: 2025-02-11
posted: 2021-05-26
categories:
- console
Expand Down
8 changes: 4 additions & 4 deletions pages/object-storage/api-cli/migrating-buckets.mdx
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
---
meta:
title: Migrating data from one bucket to another
description: Learn to migrate buckets between accounts and regions with the Scaleway CLI.
description: Learn to migrate buckets between accounts and regions with the AWS CLI.
content:
h1: Migrating data from one bucket to another
paragraph: Learn to migrate buckets between accounts and regions with the Scaleway CLI.
paragraph: Learn to migrate buckets between accounts and regions with the AWS CLI.
tags: object storage object-storage bucket migrate
dates:
validation: 2024-07-29
validation: 2025-02-11
posted: 2018-09-14
categories:
- storage
Expand All @@ -25,7 +25,7 @@ categories:
```
aws s3api create-bucket --bucket BUCKET-TARGET
```
2. Copy the objects between the Object Storage buckets.
2. Copy the objects between the Object Storage buckets using the [sync](https://docs.aws.amazon.com/cli/latest/reference/s3/sync.html) command.
<Message type="important">
If you have objects in the Scaleway `Glacier` storage class you must [restore](/object-storage/how-to/restore-an-object-from-glacier/) them before continuing.
</Message>
Expand Down
39 changes: 25 additions & 14 deletions pages/object-storage/api-cli/share-buckets-read-only.mdx
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
---
meta:
title: Sharing Object Storage buckets in read-only mode
description: Share Scaleway Object Storage buckets with read-only access using the CLI.
description: Share Scaleway Object Storage buckets with read-only access using the AWS CLI.
content:
h1: Sharing Object Storage buckets in read-only mode
paragraph: Share Scaleway Object Storage buckets with read-only access using the CLI.
tags: object storage bucket read only read-only
paragraph: Share Scaleway Object Storage buckets with read-only access using the AWS CLI.
tags: object storage bucket read only read-only aws cli
dates:
validation: 2024-07-29
validation: 2025-02-11
posted: 2021-05-19
---

Expand All @@ -21,9 +21,9 @@ dates:
- Installed the [AWS CLI](/object-storage/api-cli/object-storage-aws-cli/)
- An [Object Storage bucket](/object-storage/how-to/create-a-bucket/)


You can implement a [bucket policy](/object-storage/api-cli/bucket-policy/) to grant a Scaleway Organization or Project **Read** rights to a bucket in a different Project.
<Lightbox src="scaleway-read-only-schema.webp" alt="" />

## Principle

For example, you are logged in to Organization A and you have a bucket (A1) inside Project A. You wish to share the bucket in read-only mode with users in Organization B, Project B.

Expand All @@ -33,9 +33,15 @@ To guarantee that they can only view contents, include `"s3:ListBucket"` and `"s

Specify which resources they can access under **Resource**:

- `"<BUCKET_NAME>"` - Grants access to the bucket, but not to the objects inside. If the `s3:ListBucket` action is applied, this resource specification is required.
- `"<BUCKET_NAME>/*"` - Grants access to all objects inside a bucket, but not to the bucket itself. If the `s3:GetObject` action is applied, this resource specification is required.
- `"<BUCKET_NAME>/<PREFIX>/*"` - Grants access only to objects with the specified prefix inside a bucket, but not to the bucket itself. For example, if you apply a bucket policy that specifies `"my_files/movie/*"` under **Resource**, you would grant access to all objects with the `movie/` prefix, but not to other objects in `my_files/` bucket. If the `s3:GetObject` action is applied, this resource specification is required.
- `"<BUCKET_NAME>"`: Grants access to the bucket, but not to the objects inside. If the `s3:ListBucket` action is applied, this resource specification is required.

- `"<BUCKET_NAME>/*"`: Grants access to all objects inside a bucket, but not to the bucket itself. If the `s3:GetObject` action is applied, this resource specification is required.

- `"<BUCKET_NAME>/<PREFIX>/*"`: Grants access only to objects with the specified prefix inside a bucket, but not to the bucket itself. For example, if you apply a bucket policy that specifies `"my_files/movie/*"` under **Resource**, you would grant access to all objects with the `movie/` prefix, but not to other objects in `my_files/` bucket. If the `s3:GetObject` action is applied, this resource specification is required.

## Creating the bucket policy

1. Create a file named `bucket-policy.json` and add the following code to it:

```json
{
Expand All @@ -60,9 +66,14 @@ Specify which resources they can access under **Resource**:
]
}
```
Apply the policy using the [PutBucketPolicy](/object-storage/api-cli/bucket-operations/#putbucketpolicy) API call or run the following aws-cli command:

```
aws s3api put-bucket-policy --bucket <SOURCE_BUCKET> --profile default_project --policy file://bucket-policy.json
```
You can provide the user in Organization B with the name of your bucket. If the policy is correctly applied, they will be able to see bucket A1 included in their bucket list when running `List_Buckets`. If they know the name of an object, they can view their details by running [`Get_Object`](/object-storage/api-cli/object-operations/#getobject).
2. Apply the policy using the [PutBucketPolicy](/object-storage/api-cli/bucket-operations/#putbucketpolicy) API call or run the following aws-cli command:

```
aws s3api put-bucket-policy --bucket <SOURCE_BUCKET> --profile default_project --policy file://bucket-policy.json
```
<Message type="note">
Refer to the [dedicated documentation](/object-storage/api-cli/create-bucket-policy/) for more information on how to create bucket policies.
</Message>

You can now provide the user in Organization B with the name of your bucket. If the policy is correctly applied, they will be able to see bucket A1 included in their bucket list when running `List_Buckets`. If they know the name of an object, they can view its details by running [`Get_Object`](/object-storage/api-cli/object-operations/#getobject).
2 changes: 1 addition & 1 deletion pages/object-storage/reference-content/cname-record.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ content:
paragraph: Learn how to set up and manage CNAME records for Scaleway Edge Services pipelines. Follow our detailed guide to configure your custom domain and enhance your cloud accessibility.
tags: edge-services pipeline cname dns
dates:
validation: 2024-07-25
validation: 2025-02-11
categories:
- network
---
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ content:
paragraph: Optimize performance when using Scaleway Object Storage for your data.
tags: object storage object-storage performance tuning better enhance throughput latency optimize
dates:
validation: 2024-06-17
validation: 2025-02-11
posted: 2023-11-24
categories:
- storage
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ content:
paragraph: Discover how to configure SSL/TLS certificates for Scaleway Edge Services pipelines. Follow our comprehensive guide to secure your custom domains and ensure data protection.
tags: edge-services pipeline ssl-tls certificate ssl tls pem certificate-authority root-certificate pem chain ca
dates:
validation: 2024-07-25
validation: 2025-02-11
categories:
- network
---
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ content:
paragraph: Guide to setting up cron schedules in Scaleway Serverless Containers.
tags: serverless containers cron crontab schedule cronjob
dates:
validation: 2024-07-29
validation: 2025-02-10
posted: 2023-12-12
categories:
- serverless
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ content:
paragraph: Guide to adding a custom domain name to your Scaleway serverless function.
tags: functions custom-domain
dates:
validation: 2024-07-23
validation: 2025-02-10
posted: 2022-02-21
categories:
- serverless
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ content:
paragraph: Generate an authentication token from the Scaleway console for Serverless Functions.
tags: authentication-token functions
dates:
validation: 2024-07-23
validation: 2025-02-10
posted: 2022-10-14
categories:
- serverless
Expand Down Expand Up @@ -82,5 +82,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 function anymore.

</Message>


2 changes: 1 addition & 1 deletion pages/serverless-functions/how-to/delete-a-function.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ content:
h1: How to delete a function
paragraph: Learn how to delete Serverless Functions from Scaleway.
dates:
validation: 2024-07-23
validation: 2025-02-11
posted: 2021-05-26
---

Expand Down
6 changes: 2 additions & 4 deletions pages/serverless-functions/how-to/manage-a-function.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -7,13 +7,13 @@ content:
paragraph: Detailed guide on managing Serverless Functions within Scaleway.
tags: functions
dates:
validation: 2024-07-23
validation: 2025-02-10
posted: 2021-05-26
categories:
- serverless
---

This page shows you how to manage a function, in order to edit it or verify/change its deployment parameters after creation.
This page shows you how to manage a function, in order to edit it, or verify/change its deployment parameters after creation.

<Macro id="requirements" />

Expand All @@ -29,5 +29,3 @@ This page shows you how to manage a function, in order to edit it or verify/chan
- **Function code**: The code of your function. You can either enter it directly using the inline code editor or import it from a ZIP file.
- **Handler**: The functions handler.
5. Click **Deploy function** to save your changes.


2 changes: 1 addition & 1 deletion pages/serverless-functions/quickstart.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ content:
paragraph: Quickstart guide to deploying and managing Serverless Functions on Scaleway.
tags: functions namespace
dates:
validation: 2024-07-29
validation: 2025-02-10
posted: 2021-05-26
categories:
- serverless
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ content:
paragraph: Learn to set up and manage cron schedules in Scaleway Serverless Functions.
tags: serverless functions cron crontab schedule cronjob
dates:
validation: 2024-07-02
validation: 2025-02-11
posted: 2023-12-12
categories:
- serverless
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ content:
paragraph: Understand billing for Scaleway Serverless Functions with this guide.
tags: functions serverless serverless-functions billing serverless-billing serverless-functions-billing
dates:
validation: 2024-07-02
validation: 2025-02-11
posted: 2023-06-15
categories:
- serverless
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ content:
paragraph: Learn about limitations for Scaleway Serverless Functions including resource and execution constraints.
tags: functions limitations serverless
dates:
validation: 2024-07-23
validation: 2025-02-10
posted: 2021-10-12
categories:
- serverless
Expand Down Expand Up @@ -41,7 +41,7 @@ This section contains usage limits that apply when using Serverless Functions.

\** Total function memory is the sum of the memory allocated to all your functions at their maximum Scale.

\*** Use [Serverless Jobs](/serverless-jobs/) for tasks up to 24h.
\*** Maximum duration of a single HTTP request before this request is timed out. Use [Serverless Jobs](/serverless-jobs/) for tasks up to 24h.

These limits are enforced as [Organization quotas](/organizations-and-projects/additional-content/organization-quotas/#serverless-functions).

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ content:
paragraph: Guide to configuring runtimes for Scaleway Serverless Functions.
tags: functions serverless runtimes information configuration extensions modules parameters
dates:
validation: 2024-07-23
validation: 2025-02-10
posted: 2022-12-28
categories:
- serverless
Expand All @@ -19,6 +19,8 @@ This page contains useful information on how Serverless Functions runtimes are b

### PHP 8.2 runtime configuration

PHP parameters for the [PHP 8.2](https://www.php.net/ChangeLog-8.php#8.2.0) runtime

| Parameter | Value |
|-----------------------|-------|
| `upload_max_filesize` | 2M |
Expand Down