Skip to content

Commit 7f59d9e

Browse files
chore(gen): doc review MTA-6082 (#5026)
* chore(gen): doc review MTA-6082 * chore(gen): update * chore(gen): update * chore(gen): update * chore(gen): update * chore(gen): update * chore(gen): update * chore(gen): update
1 parent ab88afe commit 7f59d9e

File tree

26 files changed

+87
-83
lines changed

26 files changed

+87
-83
lines changed

pages/block-storage/api-cli/managing-a-volume.mdx

Lines changed: 23 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ content:
77
paragraph: Master Block Storage with our comprehensive guide. Learn to format, mount, transfer data, and expand partitions efficiently. Perfect for all skill levels.
88
tags: volume block-storage block mount format use
99
dates:
10-
validation: 2024-12-06
10+
validation: 2025-06-09
1111
posted: 2019-11-29
1212
categories:
1313
- block-storage
@@ -20,7 +20,6 @@ This documentation only explains how to mount **additional block volumes to your
2020

2121
- A Scaleway account logged into the [console](https://console.scaleway.com)
2222
- [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization
23-
- An [SSH key](/organizations-and-projects/how-to/create-ssh-key/)
2423
- An [Instance](/instances/concepts/#instance)
2524
- [Attached](/block-storage/how-to/attach-a-volume/) an additional Block Storage volume to your Instance
2625

@@ -29,7 +28,6 @@ This documentation only explains how to mount **additional block volumes to your
2928
In order to mount and use your Block Storage volume, you need to connect to the Instance it is attached to, via SSH.
3029
Then, check that the volume is available, format it, and mount it following the instructions below.
3130

32-
3331
### Verifying device availability
3432

3533
1. Connect to your Instance with `ssh`.
@@ -41,8 +39,7 @@ Then, check that the volume is available, format it, and mount it following the
4139
lsblk
4240
```
4341

44-
45-
You should see an output similar to the following. The root Block volume `sda`, runs your OS. The Block volume named `sdb` is the one we will be mounting to the Instance.
42+
You should see an output similar to the following. The root Block volume `sda`, contains your OS. The Block volume named `sdb` is the one we will be mounting to the Instance.
4643

4744
```sh no-copy
4845
root@scw-festive-agnesi:~# lsblk
@@ -58,8 +55,6 @@ Then, check that the volume is available, format it, and mount it following the
5855
The Scaleway ecosystem uses [GB](https://en.wikipedia.org/wiki/Gigabyte) to define storage sizes and not [GiB](https://en.wikipedia.org/wiki/Gibibyte) as the default on linux.
5956
</Message>
6057

61-
---
62-
6358
### Formatting the Block volume
6459

6560
Formatting your volume prepares it for storing files.
@@ -100,19 +95,19 @@ Formatting your volume prepares it for storing files.
10095

10196
Once you have created your file system, you need to define where you want to mount your volume, and create a mount point (directory) for it.
10297

103-
1. Create the mount point. Feel free to replace `block-volume` with another name for your mount point.
98+
1. Create the mount point. You can replace `block-volume` with another name for your mount point.
10499
```
105100
mkdir /mnt/block-volume
106101
```
107102
2. Mount the volume. We recommend that you use the `defaults` option, as in the command below.
108103
```
109-
# Make sure that you replace sdX with the name of your volume
104+
# Replace sdX with the name of your volume
110105
mount -o defaults /dev/sdX /mnt/block-volume
111106
```
112107

113108
If you want to see all available options, you can run `man mount` on your Instance.
114109

115-
3. Run the following command to check if your file system was properly mounted:
110+
3. Run the following command to check if your volume was properly mounted:
116111
```
117112
lsblk
118113
```
@@ -147,14 +142,14 @@ echo "UUID=$(blkid --output value /dev/sdX | head -n1) /mnt/block-volume ext4 de
147142

148143
### Transferring data from your local machine to the remote Block volume
149144

150-
You may wish to transfer files from your local machine to your Instance's remote Block volume. This can be achieved with [rsync](https://en.wikipedia.org/wiki/Rsync), a tool for efficiently transferring and copying files. The rsync utility is pre-installed on most Linux distributions and macOS.
145+
You can transfer files from your local machine to your Instance's remote Block volume with [rsync](https://en.wikipedia.org/wiki/Rsync), a tool for efficiently transferring and copying files. The rsync utility is pre-installed on most Linux distributions and macOS.
151146

152147
1. Check that rsync is installed on your local machine with the following command:
153148
```
154149
rsync --version
155150
```
156151

157-
You should see an output similar to the following:
152+
An output similar to the following displays:
158153

159154
```sh no-copy
160155
rsync version 3.1.3 protocol version 31
@@ -176,14 +171,18 @@ You may wish to transfer files from your local machine to your Instance's remote
176171
- For Linux CentOS/ Fedora, you can use the YUM package manager: `sudo yum install rsync`.
177172
- On Mac OSX with the Homebrew package manager, you can use `brew install rsync`.
178173
</Message>
174+
179175
2. On your local machine, open a new terminal and use the following command to create a file called `hello-world.txt`:
180176
```
181177
nano hello-world.txt
182178
```
183179

184180
3. Enter the text `Hello World!`.
185-
4. Press `Ctrl O`, `Enter`, and `Ctrl X` to save and exit the file.
181+
182+
4. Press `Ctrl+O`, then `Enter`, then `Ctrl+X` to save and exit the file.
183+
186184
5. Enter the following command to transfer the file to your Instance's mounted block volume. Ensure that you use your own Instance's IP address:
185+
187186
```
188187
rsync -a hello-world.txt root@<your_instance_ip>:/mnt/block-volume
189188
```
@@ -194,16 +193,18 @@ The file is now transferred. You can connect to your Instance again, and use the
194193

195194
## Increasing the partition size of the volume with growpart
196195

196+
`growpart` allows you to resize partitions. If you have increased the size of the partition's underlying volume, for example, you can increase the size of the partition to make use of the additional space.
197+
197198
<Message type="important">
198-
- We recommend that you make a backup of your data using the [snapshot](/block-storage/how-to/create-a-snapshot/) feature, before increasing the partition size of your volume. This helps you avoid any potential data loss.
199-
- You need to have partitioned your volume to follow the procedure below
200-
- If the partition you want to resize is mounted, you need to [unmount it](/block-storage/api-cli/unmounting-a-volume/) beforehand
199+
- Make sure to make a backup of your data using the [snapshot](/block-storage/how-to/create-a-snapshot/) feature beforehand to avoid any potential data loss
200+
- You must have partitioned your volume to follow the procedure below
201+
- If the partition you want to resize is mounted, you must [unmount it](/block-storage/api-cli/unmounting-a-volume/) beforehand
201202
</Message>
202203

203-
`growpart` allows you to resize partitions. If you have increased the size of the partition's underlying volume, for example, you might want to increase the size of the partition to make use of the additional space.
204-
205204
1. Connect to your Instance using [SSH](/instances/how-to/connect-to-instance/).
205+
206206
2. Use the `lsblk` command to identify your volume partition. Ensure that the partition is **not mounted before you resize it**. In the following example, we are resizing `sdb1`:
207+
207208
```
208209
root@scw-festive-agnesi:~# lsblk
209210
NAME MAJ:MIN RM SIZE RO TYPE MOUNTPOINTS
@@ -216,20 +217,19 @@ The file is now transferred. You can connect to your Instance again, and use the
216217
```
217218

218219
3. Use `growpart` to increase the partition size of your Block Storage volume (here `sdb1`):
220+
219221
```
220222
# Replace /dev/sdX 1 with the name of your partition
221223
growpart /dev/sdX 1
222224
```
223225

224-
<Message type="tip">
225-
Make sure that you add a space between the device identifier (`/dev/sdX`) and the partition number (`1`).
226-
</Message>
226+
An output similar to the following displays:
227227

228-
You should see an output similar to the following:
229228
```
230229
CHANGED: partition=1 start=0 old: size=39061504 end=39061504 new: size=58490880 end=58490880
231230
```
232-
4. Use `lsblk` to check that the partition was correctly resized. In the following output, you can see in the `SIZE` field that our partition `sbd1` went from `18.6G` (step 2) to `27.9G`.
231+
232+
4. Use `lsblk` to check that the partition was correctly resized. In the following output, you can see that our partition `sbd1` went from `18.6G` (step 2) to `27.9G`.
233233
```
234234
root@scw-festive-agnesi:~# lsblk
235235
NAME MAJ:MIN RM SIZE RO TYPE MOUNTPOINTS

pages/block-storage/api-cli/unmounting-a-volume.mdx

Lines changed: 8 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -7,38 +7,37 @@ content:
77
paragraph: Learn how to safely unmount a Block Storage volume from your Instance, and ensure data integrity.
88
tags: volume block-storage block unmount
99
dates:
10-
validation: 2024-12-06
10+
validation: 2025-06-09
1111
posted: 2023-11-23
1212
categories:
1313
- block-storage
1414
- storage
1515
---
1616

17-
1817
## Unmounting a Block Storage volume
1918

20-
2119
Unmounting a volume means detaching it from the operating system so it is no longer accessible. You can do this if you want to stop using it, prevent data corruption, or plan to [detach it](/block-storage/how-to/detach-a-volume/) from your Instance and attach it to another. This page shows you how to unmount a volume from the operating system using the `umount` command.
20+
2221
<Macro id="requirements" />
2322

2423
- A Scaleway account logged into the [console](https://console.scaleway.com)
2524
- [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization
26-
- Created an [SSH key](/organizations-and-projects/how-to/create-ssh-key/)
2725
- Created an [Instance](/instances/how-to/create-an-instance/) with an additional Block Storage volume
2826

27+
1. Open a terminal and use the following command to [connect to your Instance](/instances/how-to/connect-to-instance/). Make sure that you replace `<your_instance_ip>` with your Instance's IP. You can also find the SSH command in your Instance's **Overview** tab in the Scaleway console.
2928

30-
1. Open a terminal and use the following command to connect to your Instance. Make sure that you replace `<your_instance_ip>` with your Instance's IP. You can also find the SSH command in your Instance's **Overview** tab in the Scaleway console.
3129
```
3230
ssh root@<your_instance_ip>
3331
```
34-
2. Use `lsblk` to check where your volume is mounted. You should see an output similar to the following:
32+
33+
2. Run the `lsblk` command to check where your volume is mounted. You should see an output similar to the following:
3534

3635
```
3736
root@scw-heuristic-shtern:~# lsblk
3837
NAME MAJ:MIN RM SIZE RO TYPE MOUNTPOINTS
3938
sdb 8:0 0 18.6G 0 disk /mnt/block-volume
4039
```
41-
3. Unmount the volume to remove it from your current setup. Replace `/mnt/block-volume` with your mount point.
40+
3. Run the command below to unmount the volume to remove it from your current setup. Replace `/mnt/block-volume` with your mount point.
4241
```
4342
umount /mnt/block-volume
4443
```
@@ -48,9 +47,7 @@ Unmounting a volume means detaching it from the operating system so it is no lon
4847
NAME MAJ:MIN RM SIZE RO TYPE MOUNTPOINT
4948
sdb 8:0 0 18.6G 0 disk
5049
```
51-
<Message type="important">
52-
Remember to edit the `/etc/fstab` file and delete the line corresponding to your block volume if you have used [Persistent Mounting](/block-storage/api-cli/managing-a-volume/#using-fstab-for-persistent-mounting).
53-
</Message>
5450

55-
Refer to the [dedicated documentation](/block-storage/api-cli/managing-a-volume/) for more information about managing your Block Storage volumes.
51+
5. If you have used [Persistent Mounting](/block-storage/api-cli/managing-a-volume/#using-fstab-for-persistent-mounting), edit the `/etc/fstab` file and delete the line corresponding to your block volume.
5652

53+
Your Block Storage volume is now unmounted from your Instance. Refer to the [dedicated documentation](/block-storage/api-cli/managing-a-volume/) for more information about managing your Block Storage volumes.

pages/block-storage/concepts.mdx

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,8 @@ content:
77
paragraph: Explore essential concepts of Block Storage, including block devices, IOPS, SANs, local volumes, and their roles in enhancing storage performance and reliability.
88
tags: block storage volumes concept
99
dates:
10-
validation: 2024-11-13
10+
validation: 2025-06-09
11+
posted: 2023-11-23
1112
categories:
1213
- block-storage
1314
- storage
@@ -19,7 +20,7 @@ A block device is a storage volume on a network-connected storage system that is
1920

2021
## IOPS
2122

22-
IOPS or Input/Ouptut Operations Per Second, is a unit of measurement that indicates how many input or output operations a storage device is performing per second.
23+
IOPS or Input/Ouptut Operations Per Second, is a unit of measurement that indicates how many read/write operations a storage device is performing per second.
2324

2425
Scaleway Block Storage Low Latency offers two IOPS limits:
2526

pages/object-storage/api-cli/combining-iam-and-object-storage.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ content:
77
paragraph: Integrate IAM with Scaleway Object Storage for enhanced access control.
88
tags: object storage command bucket amazon-s3 iam permissions acl policy
99
dates:
10-
validation: 2024-11-27
10+
validation: 2025-06-12
1111
posted: 2023-01-17
1212
categories:
1313
- storage

pages/object-storage/api-cli/enable-sse-c.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ content:
77
paragraph: Enable server-side encryption with customer-provided keys (SSE-C) in Scaleway.
88
tags: object storage server side encryption sse sse-c cli s3
99
dates:
10-
validation: 2024-11-12
10+
validation: 2025-06-12
1111
posted: 2024-05-30
1212
categories:
1313
- storage

pages/object-storage/concepts.mdx

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,8 @@ content:
77
paragraph: Understand key concepts and features of Scaleway Object Storage.
88
tags: retention endpoint object-storage storage bucket acl multipart object amazon-s3 retention signature versioning archived
99
dates:
10-
validation: 2024-11-27
10+
validation: 2025-06-09
11+
posted: 2021-05-26
1112
categories:
1213
- storage
1314
- object-storage
@@ -90,7 +91,7 @@ A multipart upload consists of three steps:
9091

9192
- The client initiates the upload to a specific bucket
9293
- The different parts are uploaded
93-
- Object Storage constructs the object from the uploaded parts
94+
- Object Storage builds the object from the uploaded parts
9495

9596
## Object
9697

@@ -116,7 +117,7 @@ Parts are the chunks of data that compose multipart objects.
116117

117118
## Prefix
118119

119-
A prefix is a string of characters at the beginning of the [object key name](#object). They are often used to organize your data similarly to directories and to manage object [lifecycle](#lifecycle-configuration). However, prefixes are not directories.
120+
A prefix is a string of characters at the beginning of the [object key name](#object). They are often used to organize your data similarly to directories, and to manage object [lifecycle](#lifecycle-configuration). However, prefixes are not directories.
120121

121122
In the context of Scaleway Object Storage, prefixes are used to display folders in the Scaleway console for practical reasons. The `/` character in a prefix is used as a delimiter to allow you to organize your objects hierarchically.
122123

pages/object-storage/how-to/create-bucket-policy.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ content:
77
paragraph: Create and apply bucket policies for Object Storage.
88
tags: bucket policy bucket console object storage aws-s3 access
99
dates:
10-
validation: 2024-11-05
10+
validation: 2025-06-09
1111
posted: 2024-05-30
1212
categories:
1313
- storage

pages/object-storage/reference-content/supported-checksums.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ content:
77
paragraph: Discover the checksums supported by Scaleway Object Storage.
88
tags: object storage checksum supported aws object integrity
99
dates:
10-
validation: 2024-11-14
10+
validation: 2025-06-09
1111
posted: 2024-11-14
1212
categories:
1313
- network

pages/scaleway-sdk/go-sdk.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ content:
77
paragraph: This page explains how to install and use the Scaleway Go software development kit (SDK)
88
tags: devtools sdk go-sdk go golang
99
dates:
10-
validation: 2024-11-27
10+
validation: 2025-06-09s
1111
posted: 2023-11-14
1212
categories:
1313
- devtools

pages/scaleway-sdk/js-sdk.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ content:
77
paragraph: This page explains how to install and use the Scaleway JS software development kit (SDK)
88
tags: devtools sdk go-sdk scaleway-sdk go golang
99
dates:
10-
validation: 2024-11-27
10+
validation: 2025-06-09
1111
posted: 2023-11-14
1212
categories:
1313
- devtools

pages/scaleway-sdk/python-sdk.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ content:
77
paragraph: This page explains how to install and use the Scaleway Python software development kit (SDK)
88
tags: devtools sdk python-sdkscaleway-sdk
99
dates:
10-
validation: 2024-11-27
10+
validation: 2025-06-09
1111
posted: 2023-11-14
1212
categories:
1313
- devtools

pages/serverless-containers/concepts.mdx

Lines changed: 8 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ content:
77
paragraph: Key concepts of Scaleway Serverless Containers.
88
tags: containers cold-start concurrency container-registry environment-variables jwt vcpu serverless scale autoscaling
99
dates:
10-
validation: 2024-11-14
10+
validation: 2025-05-26
1111
categories:
1212
- serverless
1313
---
@@ -138,15 +138,15 @@ The Serverless infrastructure manages incoming request traffic. In scenarios lik
138138

139139
## Logging
140140

141-
Serverless Containers offers a built-in logging system based on Cockpit to track the activity of your resources: see [monitoring Serverless Containers](/serverless-containers/how-to/monitor-container/).
141+
Serverless Containers offers a built-in logging system based on Cockpit to track the activity of your resources. Refer to [monitoring Serverless Containers](/serverless-containers/how-to/monitor-container/) for more information.
142142

143143
## Max scale
144144

145-
This parameter sets the maximum number of container instances. You should adjust it based on your container's traffic spikes, keeping in mind that you may wish to limit the max scale to manage costs effectively.
145+
This parameter sets the maximum number of container instances. You should adjust it based on your container's traffic spikes, keeping in mind that you may wish to limit the maximum scale to manage costs effectively.
146146

147147
## Metrics
148148

149-
Performance metrics for your Serverless resources are natively available: see [monitoring Serverless Containers](/serverless-containers/how-to/monitor-container/).
149+
Performance metrics for your Serverless resources are natively available. Refer to [monitoring Serverless Containers](/serverless-containers/how-to/monitor-container/) for more information.
150150

151151
## Min scale
152152

@@ -188,7 +188,7 @@ Refer to the [dedicated FAQ](/serverless-containers/faq/#how-can-i-configure-acc
188188
A queue trigger is a mechanism that connects a container to a queue created with [Scaleway Queues](/queues/concepts/#scaleway-queues), and invokes the container automatically whenever a message is added to the queue.
189189

190190
For each message that is sent to a queue, the trigger reads the message and invokes the associated container with the message as the input parameter.
191-
The container can then process the message and perform any required actions, such as updating a database or sending a notification.
191+
The container can then process the message, and perform any required actions, such as updating a database or sending a notification.
192192

193193
## Registry endpoint
194194

@@ -204,11 +204,10 @@ Use cases:
204204

205205
## Rolling update
206206

207-
When deploying a new version of a Serverless Container, a rolling update is applied by default. This means that the new version of the service is gradually rolled out to your users without downtime.
208-
Here is how it works:
207+
When deploying a new version of a Serverless Container, a rolling update is applied by default. The new version of the service is gradually rolled out to your users without downtime, as follows:
209208

210209
* When a new version of your container is deployed, the platform automatically starts routing traffic to it incrementally, while still serving requests from the old version until the new one is fully deployed.
211-
* Once the new version is successfully running, we gradually shift all traffic to it, ensuring zero downtime.
210+
* Once the new version is successfully running, the platform gradually shifts all traffic to it, ensuring zero downtime.
212211
* The old version is decommissioned once the new version is fully serving traffic.
213212

214213
This process ensures a seamless update experience, minimizing user disruption during deployments. If needed, you can also manage traffic splitting between versions during the update process, allowing you to test new versions with a subset of traffic before fully migrating to it.
@@ -223,7 +222,7 @@ Refer to the [dedicated documentation](/serverless-containers/reference-content/
223222

224223
## Scale to zero
225224

226-
One of the advantages of Serverless Containers is that when your container is not triggered, it does not consume any resources, which enables great savings.
225+
When provisioned with a [minimum scale](#min-scale) of `0`, Serverless Containers scale down to zero active instances as long as they are not triggered. While idling, they do not consume any resources, which allows to reduce the cost of your infrastructure.
227226

228227
## Secrets
229228

0 commit comments

Comments
 (0)