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): doc review MTA-5305 #4041

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open
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
16 changes: 8 additions & 8 deletions console/account/troubleshooting/cannot-erase-account.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ content:
paragraph: Resolve issues encountered when deleting Scaleway accounts.
tags: account close delete deactivate close-account
dates:
validation: 2024-10-01
validation: 2024-27-11
posted: 2024-03-28
categories:
- console
Expand All @@ -19,17 +19,17 @@ categories:
When you click the **Send request** button, an error message appears. This message says that you still have active resources.

### Cause
You have active resources, preventing us from proceeding with your request.
You have active resources, preventing us from proceeding with your request.

### Solution
You can check all your active resources from your [Organization dashboard](https://console.scaleway.com/organization). If one or more resources are listed, they are active. You need to delete all of them manually. In this situation, you must wait for the current month's invoice to be paid before sending another request to erase your account.
### Solution
You can check all your active resources from your [Organization dashboard](https://console.scaleway.com/organization). If one or more resources are listed, they are active. You need to delete all of them manually. In this situation, you must wait for the current month's invoice to be paid before sending another request to erase your account.


### Problem
I received an email explaining that my request to erase my account and personal data had failed.
I received an email explaining that my request to erase my account and personal data had failed.

### Cause
You may have unpaid consumption, preventing us from proceeding with your request.
You may have unpaid consumption, preventing us from proceeding with your request.

### Solution
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.
### Solution
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.
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ content:
paragraph: Fix issues preventing login to Scaleway accounts.
tags: login unrecognized-ip password 2fa
dates:
validation: 2024-05-14
validation: 2024-11-27
posted: 2022-10-19
categories:
- console
Expand All @@ -20,7 +20,7 @@ When logging into your Scaleway account, you may encounter the following message

<Lightbox src="scaleway-unrecognized-ip.webp" alt="" />

This means you tried to log into your account from an unknown [IP address](/network/public-gateways/concepts/#ip-address). You may be logging in from a new device or location. As a security measure, we require you to use a [magic link](/console/account/concepts/#magic-link) to complete authentication.
This means you tried to log into your account from an unknown [IP address](/network/public-gateways/concepts/#ip-address). You may be logging in from a new device or location. As a security measure, we require you to use a [magic link](/console/account/concepts/#magic-link) to complete authentication.

1. Check your inbox for the latest email sent by the Scaleway team.
2. Click the **Authenticate myself** button in the email.
Expand All @@ -41,14 +41,14 @@ If you forgot or lost your password, you need to reset it. There are several met

## I have lost my 2FA device

Refer to the [How to use two-factor authentication (MFA)](/console/account/how-to/use-2fa/) page to find the instructions to recover access to your MFA device.
Refer to the [How to use two-factor authentication (MFA)](/console/account/how-to/use-2fa/) page to find the instructions to recover access to your MFA device.

Remember that if you lose both your MFA device and backup codes, you will need to gather all the following information:

* Email address
* Postal address
* If your account is:
- an individual account, a document proving your identity (passport or local ID card)
- an individual account, a document proving your identity (passport or local ID card)
- a corporate account, a copy of a business registration certificate,
and a certified translation in either English or French if the document was issued in another language
* A phone number to contact you
Expand Down
4 changes: 2 additions & 2 deletions developer-tools/scaleway-sdk/go-sdk.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ content:
paragraph: This page explains how to install and use the Scaleway Go software development kit (SDK)
tags: devtools sdk go-sdk go golang
dates:
validation: 2024-05-23
validation: 2024-11-27
posted: 2023-11-14
categories:
- devtools
Expand Down Expand Up @@ -81,7 +81,7 @@ func main() {

## Example

To create a Kubernetes cluster on Scaleway using the Go SDK, you would typically interact with the `scaleway` SDK package. The specific details can change, so you should always refer to the latest documentation.
To create a Kubernetes cluster on Scaleway using the Go SDK, you would typically interact with the `scaleway` SDK package. The specific details can change, so you should always refer to the latest documentation.
Below is a conceptual example of how you might use the Scaleway Go SDK to create a Kubernetes (Kapsule) cluster with 3 nodes:

```go
Expand Down
4 changes: 2 additions & 2 deletions developer-tools/scaleway-sdk/js-sdk.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ content:
paragraph: This page explains how to install and use the Scaleway JS software development kit (SDK)
tags: devtools sdk go-sdk scaleway-sdk go golang
dates:
validation: 2024-05-23
validation: 2024-11-27
posted: 2023-11-14
categories:
- devtools
Expand Down Expand Up @@ -41,7 +41,7 @@ const api = new Registry.v1.API(client)

## Using the SDK

The SDK is written in TypeScript, offering the full benefits of this language.
The SDK is written in TypeScript, offering the full benefits of this language.

* For any product, its types are available under `Product.version`. For example, access the `Image` interface of Registry v1 using `Registry.v1.Image`.

Expand Down
34 changes: 17 additions & 17 deletions developer-tools/scaleway-sdk/python-sdk.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,32 +5,32 @@ meta:
content:
h1: Scaleway Python software development kit (SDK)
paragraph: This page explains how to install and use the Scaleway Python software development kit (SDK)
tags: devtools sdk python-sdkscaleway-sdk
tags: devtools sdk python-sdkscaleway-sdk
dates:
validation: 2024-05-23
validation: 2024-11-27
posted: 2023-11-14
categories:
- devtools
---

The Scaleway Python SDK offers an efficient way for developers to interact with Scaleway's cloud services programmatically.
This powerful tool simplifies the automation of various tasks, including server management, storage operations, and networking setup.
It encapsulates these functions into user-friendly Python method invocations by taking care of the complexity of direct API calls and authentication.
The Scaleway Python SDK offers an efficient way for developers to interact with Scaleway's cloud services programmatically.
This powerful tool simplifies the automation of various tasks, including server management, storage operations, and networking setup.
It encapsulates these functions into user-friendly Python method invocations by taking care of the complexity of direct API calls and authentication.
This makes it easier to integrate Scaleway's cloud resources into applications or manage these resources directly from code.

## Installation of the Python SDK

The SDK caters to different programming needs by offering both synchronous and asynchronous versions. You can easily install the version that suits your project's requirements:

**For the synchronous version:**
```bash
pip install scaleway
```
- **Synchronous version**:
```bash
pip install scaleway
```

**For the asynchronous version:**
```bash
pip install scaleway-async
```
- **Asynchronous version**:
```bash
pip install scaleway-async
```

<Message type="note">
While this library is optimized for Python 3.8, it maintains compatibility with newer Python versions, ensuring a broad scope of applicability.
Expand All @@ -40,7 +40,7 @@ pip install scaleway-async

You need a pair of access and secret keys to connect to Scaleway API. Check out the documentation to find out [how to retrieve them](/identity-and-access-management/iam/how-to/create-api-keys/).

`scaleway` APIs must be initialized with a `scaleway.Client`.
`scaleway` APIs must be initialized with `scaleway.Client`.

A minimal setup would look like this:

Expand All @@ -61,8 +61,8 @@ registry_api = RegistryV1API(client)

## Example

To create a Kubernetes cluster on Scaleway using the Python SDK, you would typically interact with the `scaleway` SDK package. The specific details can change, so you should always refer to the latest documentation.
Below is a conceptual example of how you might use the Scaleway Python SDK to create a Kubernetes (Kapsule) cluster with 3 nodes:
To create a Kubernetes cluster on Scaleway using the Python SDK, you would typically interact with the `scaleway` SDK package. The specific details can change, so you should always refer to the latest documentation.
Below is an example of how you can use the Scaleway Python SDK to create a Kubernetes (Kapsule) cluster with 3 nodes:

```python
import time
Expand Down Expand Up @@ -156,4 +156,4 @@ print(f"Node pool created with ID: {node_pool_id}")

## Further resources

For further information about the Scaleway Python SDK, refer to the [official SDK repository](https://github.com/scaleway/scaleway-sdk-python) on GitHub.
For further information about the Scaleway Python SDK, refer to the [official SDK repository](https://github.com/scaleway/scaleway-sdk-python) on GitHub.
4 changes: 2 additions & 2 deletions developer-tools/terraform/quickstart.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,9 @@ meta:
content:
h1: Terraform for Scaleway - Quickstart
paragraph: This page explains how to install and configure Terraform with Scaleway as a provider
tags: devtools terraform tf scaleway-provider scaleway-terraform
tags: devtools terraform tf scaleway-provider scaleway-terraform
dates:
validation: 2024-05-14
validation: 2024-11-27
posted: 2023-10-24
categories:
- devtools
Expand Down
4 changes: 2 additions & 2 deletions serverless/containers/reference-content/use-cases.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -7,13 +7,13 @@ content:
paragraph: Explore use cases for Scaleway Serverless Containers.
tags: Containers serverless use-cases
dates:
validation: 2024-05-14
validation: 2024-11-27
posted: 2023-04-24
categories:
- serverless
---

Scaleway Serverless Containers can be used in endless use cases:
Scaleway Serverless Containers can be used in many use cases:
- Push directly your containers to production hosting
- Automation
- Integration with your ecosystem
Expand Down
4 changes: 2 additions & 2 deletions serverless/functions/reference-content/use-cases.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -7,13 +7,13 @@ content:
paragraph: Explore use cases for Scaleway Serverless Functions in various scenarios.
tags: functions serverless use-cases
dates:
validation: 2024-05-14
validation: 2024-11-27
posted: 2023-04-24
categories:
- serverless
---

Scaleway Serverless Functions can be used in endless use cases:
Scaleway Serverless Functions can be used in many use cases:
* Automation for specific tasks
* Integration with your ecosystem to help scale specific routes of your code
* CI/CD integration
Expand Down
2 changes: 1 addition & 1 deletion serverless/jobs/how-to/run-job.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ content:
paragraph: Learn how to run jobs in Scaleway Serverless platform efficiently.
tags: run execute start serverless job scaleway contextual-options parameters
dates:
validation: 2024-05-23
validation: 2024-11-27
posted: 2023-11-14
categories:
- serverless
Expand Down
2 changes: 1 addition & 1 deletion serverless/jobs/how-to/stop-job.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ content:
paragraph: Discover methods to stop jobs running on Scaleway Serverless.
tags: stop execute abort start serverless job scaleway
dates:
validation: 2024-05-23
validation: 2024-11-27
posted: 2023-12-12
categories:
- serverless
Expand Down
2 changes: 1 addition & 1 deletion serverless/jobs/quickstart.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ content:
paragraph: Get started with Scaleway Serverless Jobs quickly and easily.
tags: jobs serverless namespace
dates:
validation: 2024-05-16
validation: 2024-11-27
posted: 2023-11-07
categories:
- serverless
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ content:
paragraph: Integrate IAM with Scaleway Object Storage for enhanced access control.
tags: object storage command bucket amazon-s3 iam permissions acl policy
dates:
validation: 2024-05-14
validation: 2024-11-27
posted: 2023-01-17
categories:
- storage
Expand Down Expand Up @@ -145,5 +145,3 @@ Consider an Organization in which a user and an application must perform specifi
<Message type="note">
Refer to the [Bucket policies overview](/storage/object/api-cli/bucket-policy/#bucket-policies-description) for more information on the different elements of a bucket policy.
</Message>


11 changes: 7 additions & 4 deletions storage/object/api-cli/create-bucket-policy.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ content:
paragraph: Create custom bucket policies in Scaleway Object Storage using the CLI.
tags: bucket policy bucket bucket-policy object storage object-storage s3
dates:
validation: 2024-05-14
validation: 2024-11-27
posted: 2021-01-17
categories:
- storage
Expand All @@ -30,7 +30,7 @@ To create and apply a bucket policy from the [Scaleway console](https://console/

1. Create a `bucket-policy.json` file.

2. Open it in a code editor and paste the code below inside. This statement **only allows the specified user** to see the bucket and its objects.
2. Open it in a code editor and paste the code below inside. This sample bucket policy contains a statement that **only allows the specified user** to see the bucket and the objects it contains.
```json
{
"Version": "2023-04-17",
Expand Down Expand Up @@ -65,9 +65,9 @@ Refer to the [Bucket policies description](/storage/object/api-cli/bucket-policy

Make sure that you have [installed the AWS CLI](/storage/object/api-cli/object-storage-aws-cli/) before proceeding.

1. Open a terminal and access the folder containing the `bucket-policy.json` file.
1. Open a terminal and access the folder containing the previously created `bucket-policy.json` file.

2. Run the command below to apply the policy. Replace `<BUCKET_NAME>` with the name of your bucket.
2. Run the command below to apply the policy. Make sure to replace `<BUCKET_NAME>` with the name of your bucket.
```sh
aws s3api put-bucket-policy --bucket <BUCKET_NAME> --policy file://bucket-policy.json
```
Expand Down Expand Up @@ -103,6 +103,9 @@ Make sure that you have [installed the AWS CLI](/storage/object/api-cli/object-s

## How to delete a bucket policy

<Message type="note">
To delete a bucket policy, you must have [Owner](/identity-and-access-management/iam/concepts/#owner) status, or the necessary [IAM permissions](/storage/object/reference-content/s3-iam-permissions-equivalence/).

Run the command below to delete the policy of a specific bucket. Replace `<BUCKET_NAME>` with the name of your bucket.

```sh
Expand Down
Loading