Skip to content

Commit 4e23900

Browse files
SamyOubouazizRoRoJ
andauthored
chore(gen): update concepts with links MTA-6444 (#5684)
* chore(gen): update concepts with links MTA-6444 * chore(gen): update * chore(gen): update * Update pages/serverless-containers/concepts.mdx Co-authored-by: Rowena Jones <[email protected]> * Update pages/object-storage/concepts.mdx Co-authored-by: Rowena Jones <[email protected]> --------- Co-authored-by: Rowena Jones <[email protected]>
1 parent c16b03f commit 4e23900

File tree

5 files changed

+34
-12
lines changed

5 files changed

+34
-12
lines changed

pages/block-storage/concepts.mdx

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,8 @@ Scaleway Block Storage offers two IOPS limits:
3535
- 5000 IOPS (5K IOPS)
3636
- 15 000 IOPS (15K IOPS)
3737

38+
Refer to the [dedicated documentation](/block-storage/reference-content/differences-between-5kiops-volumes/) for more information on the IOPS of each Block Storage volume type.
39+
3840
## Local volume
3941

4042
<LocalVolumes />

pages/file-storage/concepts.mdx

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,8 @@ import Region from '@macros/concepts/region.mdx'
1818

1919
Attaching storage to your Scaleway Instance allows you to use additional or shared storage beyond its [Local Storage](/local-storage/).
2020

21+
Refer to the [dedicated documentation](/file-storage/how-to/attach-file-system/) for information on how to attach a file system.
22+
2123
## Availability Zone
2224

2325
<AvailabilityZone />
@@ -30,10 +32,14 @@ Scaleway File Storage allows you to keep data in an organized hierarchy of files
3032

3133
A file system provides a structured way to manage files and directories in the cloud, so that Instances can access, read, and write data as if it were on a local disk. File systems can be shared by several [Instances](/instances/).
3234

35+
Refer to the [dedicated documentation](/file-storage/how-to/create-file-system/) for information on how to create a file system.
36+
3337
## Mount
3438

3539
Mounting a storage volume allows you you to assign a directory (mount point) to an [attached](#attach) storage volume. The files on that storage become available via the assigned directory. This allows you to read and write files on the storage as if they were part of your local file system.
3640

41+
Refer to the [dedicated documentation](/file-storage/how-to/mount-file-system/) for information on how to mount a file system.
42+
3743
## Region
3844

3945
<Region />

pages/object-storage/concepts.mdx

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ Bucket policies are assigned to [principals](#principal), who will be allowed or
2828

2929
## Bucket website
3030

31-
A feature that allows you to [host static websites on buckets](/object-storage/how-to/use-bucket-website/).
31+
The Bucket website feature enables you to [host static websites directly from your Scaleway Object Storage buckets](/object-storage/how-to/use-bucket-website/). You can serve HTML, CSS, JavaScript, and other static files to your users without needing a separate web server. You can set up a custom domain, configure error pages, and manage routing rules.
3232

3333
## Edge Services
3434

@@ -107,9 +107,13 @@ A storage service based on the Amazon S3 protocol. It allows you to store differ
107107

108108
Contrary to other storage types such as block devices or file systems, Object Storage bundles the data itself along with metadata [tags](#tags) and a [prefix](#prefix), rather than a file name and a file path.
109109

110+
Read our [quickstart documentation](/object-storage/quickstart/) to get started with Scaleway Object Storage.
111+
110112
## Parts
111113

112-
Parts are the chunks of data that compose multipart objects.
114+
Parts are individual segments of a larger object that is uploaded in multiple pieces during a multipart upload process. This method divides large uploads into manageable chunks, improving efficiency and reliability. If one part fails, only that part needs to be retried, rather than the entire file. Each part must be uploaded in sequence and identified by a part number, which helps Scaleway Object Storage to reassemble the complete object accurately after all parts have been successfully uploaded.
115+
116+
Refer to the [dedicated documentation](/object-storage/api-cli/multipart-uploads/) for more information on multipart uploads.
113117

114118
## Prefix
115119

@@ -136,7 +140,7 @@ A principal is the target of a [bucket policy](#bucket-policy). They acquire the
136140

137141
## Retention modes
138142

139-
Object Lock provides two modes to manage object retention, **Compliance** and **Governance**. It allows retention settings on individual objects in addition to default retention settings for all objects within a bucket.
143+
[Object Lock](#object-lock) provides two modes to manage object retention, **Compliance** and **Governance**. It allows retention settings on individual objects in addition to default retention settings for all objects within a bucket.
140144

141145
- **Compliance**: When this mode is set, an object version cannot be overwritten or deleted by any user. If the Compliance mode is configured for an object, then its retention mode cannot be changed, and its retention period cannot be shortened. In other words, it ensures that an object version cannot be overwritten or deleted for the duration of the retention period.
142146

@@ -151,6 +155,8 @@ Object Lock provides two modes to manage object retention, **Compliance** and **
151155
- The object does not have a Legal Hold in place. If it does, the Legal Hold Status Token must be set to OFF before deletion.
152156
- When the above criteria are met, you'll be able to use delete-object --version-id to permanently delete an object.
153157

158+
Refer to the [dedicated documentation](/object-storage/api-cli/object-lock/) for information on how to use object lock.
159+
154160
## Retention period
155161

156162
A retention period specifies a fixed period for which an object remains [locked](#object-lock). During this period, your object is WORM-protected and cannot be overwritten or deleted.

pages/serverless-containers/concepts.mdx

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ The startup process steps are:
4444
* Starting the container. Optimize your container startup speed to minimize this step (e.g., avoid waiting for slow connections or downloading large objects at startup)
4545
* Waiting for the container to listen on the configured port.
4646

47-
[How to reduce cold starts](/serverless-containers/faq/#how-can-i-reduce-the-cold-starts-of-serverless-containers)
47+
[How to reduce cold starts](/serverless-containers/faq/#how-can-i-reduce-the-cold-starts-of-serverless-containers).
4848

4949
## Commands and arguments
5050

@@ -81,16 +81,18 @@ A container is a package of software that includes all dependencies: code, runti
8181
8282
## Container image
8383
84-
A container image is a file that includes all the requirements and instructions of a complete and executable version of an application.
84+
A container image is a file that includes all the requirements and instructions of a complete and executable version of an application. Container images can be easily stored using [Scaleway Container Registry](/container-registry/quickstart/).
8585
8686
## Container Registry
8787
88-
Container Registry is the place where your images are stored before being deployed. We recommend using Scaleway Container Registry for optimal integration and performances. See the [migration guide](/serverless-containers/api-cli/migrate-external-image-to-scaleway-registry/) for full details.
88+
Container Registry is the place where your images are stored before being deployed. We recommend using [Scaleway Container Registry](/container-registry/quickstart/) for optimal integration and performance. See the [migration guide](/serverless-containers/api-cli/migrate-external-image-to-scaleway-registry/) for full details.
8989
9090
## Deployment
9191
9292
Some parameter changes require a new deployment of the container to take effect. The deployment happens without causing downtime, as traffic is switched to the newest version once it is ready.
9393
94+
Refer to the [dedicated documentation](/serverless-containers/reference-content/deploy-container/) for information on the different deployment methods.
95+
9496
## Endpoint
9597
9698
An endpoint is the URL generated to access your resource. It can be customized with [custom domains](#custom-domain).
@@ -145,9 +147,9 @@ Performance metrics for your Serverless resources are natively available. Refer
145147

146148
## Namespace
147149

148-
A namespace is a folder with some settings that allows you to [group your containers](/serverless-containers/how-to/create-manage-delete-containers-namespace/).
150+
A namespace is a folder with some settings that allows you to group your containers. Containers in the same namespace can share environment variables, secrets, and access tokens, defined at the namespace level.
149151

150-
Containers in the same namespace can share environment variables, secrets, and access tokens, defined at the namespace level.
152+
Refer to the [dedicated documentation](/serverless-containers/how-to/create-manage-delete-containers-namespace/) for information on how to create, manage, and delete namespaces.
151153

152154
## Port
153155

@@ -181,7 +183,7 @@ While DHCP is built into all new Private Networks, it may not be automatically a
181183

182184
## Registry endpoint
183185

184-
The registry endpoint parameter is the resource linked to the container image used in your Serverless Container.
186+
The registry endpoint parameter is the resource linked to the container image used in your Serverless Container. Endpoints for the [Scaleway Container Registry](/container-registry/) namespaces can be found in the Scaleway Console.
185187

186188
## Request timeout
187189

pages/serverless-functions/concepts.mdx

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -14,11 +14,13 @@ import ServerlessConcepts from '@macros/serverless/serverless-concepts.mdx'
1414
Autoscaling refers to the ability of Serverless Functions to automatically adjust the number of instances without manual intervention.
1515
Scaling mechanisms ensure that resources are provisioned dynamically to handle incoming requests efficiently while minimizing idle capacity and cost.
1616

17+
Refer to the [dedicated documentation](/serverless-functions/reference-content/functions-autoscaling/) for more information on autoscaling.
18+
1719
## Build step
1820

1921
Before deploying Serverless Functions, they have to be built. This step occurs during deployment.
2022

21-
Once the Function is built into an image, it will be pushed to [Container Registry](#container-registry)
23+
Once the Function is built into an image, it will be pushed to [Container Registry](#container-registry).
2224

2325
## Cold Start
2426

@@ -83,15 +85,15 @@ Serverless offers a built-in logging system based on Scaleway Cockpit to track t
8385

8486
## Max scale
8587

86-
This parameter sets the maximum number of function instances. You should adjust it based on your function's traffic spikes, keeping in mind that you may wish to limit the maximum scale to manage costs effectively.
88+
This parameter sets the maximum number of function instances for the [autoscaling](#autoscaling) feature. You should adjust it based on your function's traffic spikes, keeping in mind that you may wish to limit the maximum scale to manage costs effectively.
8789

8890
## Metrics
8991

9092
Performance metrics for your Serverless resources are natively available. Refer to [monitoring Serverless Functions](/serverless-functions/how-to/monitor-function/) for more information.
9193

9294
## Min scale
9395

94-
Customizing the minimum scale for Serverless can help ensure that an instance remains pre-allocated and ready to handle requests, reducing delays associated with cold starts. However, this setting also impacts the costs of your Serverless Function.
96+
Customizing the [autoscaling](#autoscaling) minimum scale for Serverless can help ensure that an instance remains pre-allocated and ready to handle requests, reducing delays associated with cold starts. However, this setting also impacts the costs of your Serverless Function.
9597

9698
## Namespace
9799

@@ -106,6 +108,8 @@ A NATS trigger is a mechanism that connects a function to a [NATS](/nats/concept
106108
For each message that is sent to a NATS subject, the NATS trigger reads the message and invokes the associated function with the message as the input parameter.
107109
The function can then process the message and perform any required actions, such as updating a database or sending a notification.
108110

111+
Refer to the [dedicated documentation](/serverless-functions/how-to/add-trigger-to-a-function/) for information on how to add a NATS trigger to a function.
112+
109113
## Privacy policy
110114

111115
A function's privacy policy defines whether a function may be executed anonymously (**public**) or only via an authentication mechanism provided by the [Scaleway API](https://www.scaleway.com/en/developers/api/serverless-functions/#authentication) (**private**).
@@ -137,6 +141,8 @@ A queue trigger is a mechanism that connects a function to a queue created with
137141
For each message that is sent to a queue, the trigger reads the message, and invokes the associated function with the message as the input parameter.
138142
The function can then process the message and perform any required actions, such as updating a database or sending a notification.
139143

144+
Refer to the [dedicated documentation](/serverless-functions/how-to/add-trigger-to-a-function/) for information on how to add a queue trigger to a function.
145+
140146
## Request timeout
141147

142148
Request timeout is the maximum amount of time a request to a Serverless Function is allowed to run before the request is terminated. The purpose of this parameter is to ensure long-running requests do not hang indefinitely, which could impact resource usage and scalability.

0 commit comments

Comments
 (0)