Skip to content

Commit b55cbf8

Browse files
nerda-codesnerda-codes
committed
docs(add): review
1 parent 2ed5f2b commit b55cbf8

19 files changed

+129
-111
lines changed

‎docs/data-sources/bloc_snapshot.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -5,13 +5,13 @@ page_title: "Scaleway: scaleway_block_snapshot"
55

66
# scaleway_block_snapshot
77

8-
`scaleway_block_snapshot` is used to retrieve information about a Block Storage volume snapshot.
8+
The `scaleway_block_snapshot` data source is used to retrieve information about a Block Storage volume snapshot.
99

1010
Refer to the Block Storage [product documentation](https://www.scaleway.com/en/docs/storage/block/) and [API documentation](https://www.scaleway.com/en/developers/api/block/) for more information.
1111

1212
## Retrieve a volume's snapshot
1313

14-
The following commands allow you to retrieve information about a Block Storage volume snapshot, using several methods:
14+
The following commands allow you to:
1515

1616
- retrieve a snapshot specified by its name
1717
- retrieve a snapshot specified by its name and the ID of the Block Storage volume it is associated with

‎docs/data-sources/block_volume.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ Refer to the Block Storage [product documentation](https://www.scaleway.com/en/d
1010

1111
## Retrieve a Block Storage volume
1212

13-
The following commands allow you to retrieve information about a Block Storage volume, using two methods:
13+
The following commands allow you to:
1414

1515
- retrieve a Block Storage volume specified by its name
1616
- retrieve a Block Storage volume specified by its ID
@@ -30,7 +30,7 @@ data "scaleway_block_volume" "my_volume" {
3030

3131
## Arguments reference
3232

33-
This section lists the arguments that you can provide to the `scaleway_block_volume` data source to filter and retrieve the desired volume. Each argument has a specific purpose:
33+
This section lists the arguments that you can provide to the `scaleway_block_volume` data source to filter and retrieve the desired volume.
3434

3535
- `volume_id` - (Optional) The unique identifier of the volume. Only one of `name` and `volume_id` should be specified.
3636
- `name` - (Optional) The name of the volume. Only one of `name` and `volume_id` should be specified.

‎docs/data-sources/cockpit.md

+4-2
Original file line numberDiff line numberDiff line change
@@ -36,14 +36,16 @@ data "scaleway_cockpit" "main" {
3636

3737
## Arguments reference
3838

39-
- `project_id` - Specifies the ID of the Scaleway Project that the Cockpit is associated with. If not specified, it defaults to the [provider's](../index.md#project_id) `project_id`.
39+
This section lists the arguments that you can provide to the `scaleway_cockpit` data source to filter and retrieve the desired Cockpit.
40+
41+
- `project_id` - Specifies the ID of the Scaleway Project that the Cockpit is associated with. If not specified, it defaults to the Project ID specified in the [provider configuration](../index.md#project_id).
4042

4143
- `plan` - (Optional) Specifies the name or ID of the pricing plan to use.
4244

4345

4446
## Attributes reference
4547

46-
In addition to all arguments above, the following attributes are exported:
48+
The `scaleway_cockpit` data source exports certain attributes once the Cockpit information is retrieved. These attributes can be referenced in other parts of your Terraform configuration.
4749

4850
- `plan_id` - (Deprecated) ID of the current pricing plan
4951
- `endpoints` - (Deprecated) A list of [endpoints](https://www.scaleway.com/en/docs/observability/cockpit/concepts/#endpoints) related to Cockpit, each with specific URLs:

‎docs/data-sources/cockpit_plan.md

+6-2
Original file line numberDiff line numberDiff line change
@@ -4,10 +4,12 @@ page_title: "Scaleway: scaleway_cockpit_plan"
44
---
55
# scaleway_cockpit_plan
66

7-
The page provides documentation for `scaleway_cockpit_plan`, which is used to fetch details about a specific Scaleway Cockpit pricing plan by its name. This information can then be used to configure resources like `scaleway_cockpit`.
7+
The `scaleway_cockpit_plan` data source is used to fetch details about a specific Scaleway Cockpit pricing plan. This information can then be used to configure resources like `scaleway_cockpit`.
88

99
Find out more about [pricing plans](https://console.scaleway.com/cockpit/plans) in the Scaleway console.
1010

11+
Refer to Cockpit's [product documentation](https://www.scaleway.com/en/docs/observability/cockpit/concepts/) and [API documentation](https://www.scaleway.com/en/developers/api/cockpit/regional-api) for more information.
12+
1113
## Fetch and associate a pricing plan to a Cockpit
1214

1315
The following command shows how to fetch information about the `premium` pricing plan and how to associate it with the Cockpit of your Scaleway default Project.
@@ -24,4 +26,6 @@ resource "scaleway_cockpit" "main" {
2426

2527
## Arguments reference
2628

27-
- `name` - This is a required argument that specifies the name of the pricing plan you want to retrieve information about.
29+
This section lists the arguments that you can provide to the `scaleway_cockpit_plan` data source to filter and retrieve the desired plan.
30+
31+
- `name` - (Required) Name of the pricing plan you want to retrieve information about.

‎docs/data-sources/domain_record.md

+4-6
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ Refer to the Domains and DNS [product documentation](https://www.scaleway.com/en
1212

1313
## Query domain records
1414

15-
The following commands allow you to query domain records using two methods:
15+
The following commands allow you to:
1616

1717
- query a domain record specified by the DNS zone (`domain.tld`), the record name (`www`), the record type (`A`), and the record content (`1.2.3.4`).
1818
- query a domain record specified by the DNS zone (`domain.tld`) and the unique record ID (`11111111-1111-1111-1111-111111111111`).
@@ -35,7 +35,7 @@ data "scaleway_domain_record" "by_id" {
3535

3636
## Arguments reference
3737

38-
This section lists the arguments that can be provided to the `scaleway_domain_record` data source:
38+
This section lists the arguments that you can provide to the `scaleway_domain_record` data source to filter and retrieve the desired record:
3939

4040
- `dns_zone` - (Optional) The DNS zone (domain) to which the record belongs. This is a required field in both examples above but is optional in the context of defining the data source.
4141

@@ -47,13 +47,11 @@ This section lists the arguments that can be provided to the `scaleway_domain_re
4747

4848
- `record_id` - (Optional) The unique identifier of the record. Cannot be used with `name`, `type`, and `data`.
4949

50-
- `project_id` - (Defaults to the Project ID specified in the [provider configuration](../index.md#project_id)). The ID of the project associated with the domain.
50+
- `project_id` - (Defaults to the Project ID specified in the [provider configuration](../index.md#project_id)). The ID of the Project associated with the domain.
5151

5252
## Attributes reference
5353

54-
This section lists the attributes that are exported by the scaleway_domain_record data source. These attributes can be referenced in other parts of your Terraform configuration:
55-
56-
In addition to all arguments above, the following attributes are exported:
54+
This section lists the attributes that are exported when the `scaleway_domain_record` data source is created. These attributes can be referenced in other parts of your Terraform configuration:
5755

5856
- `id` - The unique identifier of the record.
5957

‎docs/data-sources/domain_zone.md

+5-5
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ page_title: "Scaleway: scaleway_domain_zone"
55

66
# scaleway_domain_zone
77

8-
The `scaleway_domain_record` data source is used to get information about a DNS zone within a specific domain and subdomain in Scaleway Domains and DNS.
8+
The `scaleway_domain_zone` data source is used to get information about a DNS zone within a specific domain and subdomain in Scaleway Domains and DNS.
99

1010
Refer to the Domains and DNS [product documentation](https://www.scaleway.com/en/docs/network/domains-and-dns/) and [API documentation](https://www.scaleway.com/en/developers/api/domains-and-dns/) for more information.
1111

@@ -23,20 +23,20 @@ data "scaleway_domain_zone" "main" {
2323

2424
## Arguments reference
2525

26-
This section lists the arguments that can be provided to the `scaleway_domain_record` data source:
26+
This section lists the arguments that you can provide to the `scaleway_domain_zone` data source to filter and retrieve the desired DNS zone:
2727

2828

2929
- `domain` - (Required) The primary domain name where the DNS zone is located. This is a mandatory field.
3030

3131
- `subdomain` - (Required) The subdomain (or zone name) within the primary domain. This is a mandatory field.
3232

33-
- `project_id` - ([Defaults to the provider's](../index.md#project_id) `project_id`). The ID of the Scaleway Project associated with the domain. If not specified, it defaults to the `project_id` set in the provider configuration.
33+
- `project_id` - (Defaults to Project ID specified in [the provider configuration](../index.md#project_id)). The ID of the Scaleway Project associated with the domain. If not specified, it defaults to the `project_id` set in the provider configuration.
3434

3535
## Attributes reference
3636

37-
This section lists the attributes that are exported by the `scaleway_domain_zone` data source. These attributes can be referenced in other parts of your Terraform configuration:
37+
This section lists the attributes that are exported when the `scaleway_domain_zone` data source is created. These attributes can be referenced in other parts of your Terraform configuration:
3838

39-
- `id` - The unique identifier of the zone, formatted as `{subdomain}.{domain}`.
39+
- `id` - The unique identifier of the zone, in the `{subdomain}.{domain}` format.
4040

4141
- `ns` - The list of name servers for the zone.
4242

‎docs/data-sources/secret.md

+5-5
Original file line numberDiff line numberDiff line change
@@ -9,13 +9,13 @@ The `scaleway_secret` data source is used to get information about a specific se
99

1010
Refer to the Secret Manager [product documentation](https://www.scaleway.com/en/docs/identity-and-access-management/secret-manager/) and [API documentation](https://www.scaleway.com/en/developers/api/secret-manager/) for more information.
1111

12-
## Crrate a secret and get its information
12+
## Create a secret and get its information
1313

14-
The following commands show you how to:
14+
The following commands allow you to:
1515

1616
- create a secret named `foo` with the description `barr`
17-
- retrieve the secret information using the secret's ID
18-
- retrieve the secret information using the secret's name
17+
- retrieve the secret's information using the secret's ID
18+
- retrieve the secret's information using the secret's name
1919

2020
```hcl
2121
// Create a secret
@@ -37,7 +37,7 @@ data "scaleway_secret" "by_name" {
3737

3838
## Arguments reference
3939

40-
This section lists the arguments that can be provided to the `scaleway_secret` data source:
40+
This section lists the arguments that you can provide to the `scaleway_secret` data source to filter and retrieve the desired secret:
4141

4242

4343
- `name` - (Optional) The name of the secret.

‎docs/data-sources/secret_version.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ Refer to the Secret Manager [product documentation](https://www.scaleway.com/en/
1212

1313
## Use Secret Manager
1414

15-
The following commands show you how to:
15+
The following commands allow you to:
1616

1717
- create a secret named `fooii`
1818
- create a new version of `fooii` containing data (`your_secret`)
@@ -63,7 +63,7 @@ output "scaleway_secret_access_payload_by_id" {
6363

6464
## Arguments reference
6565

66-
This section lists the arguments that can be provided to the `scaleway_secret_version` data source:
66+
This section lists the arguments that you can provide to the `scaleway_secret_version` data source to filter and retrieve the desired version:
6767

6868
- `secret_id` - (Optional) The ID of the secret associated with the secret version. Only one of `secret_id` and `secret_name` should be specified.
6969

@@ -85,10 +85,10 @@ see [Sensitive Data in State](https://developer.hashicorp.com/terraform/language
8585

8686
## Attributes reference
8787

88-
This section lists the attributes that are exported when the `scaleway_secret_version` data source is created:
88+
This section lists the attributes that are exported by the `scaleway_secret_version` data source. These attributes can be referenced in other parts of your Terraform configuration:
8989

9090
- `description` - (Optional) The description of the secret version (e.g. `my-new-description`).
91-
- `data` - The data payload of the secret version. This is a sensitive attribute containing the secret value. Learn more in the [data section](#data)
91+
- `data` - The data payload of the secret version. This is a sensitive attribute containing the secret value. Learn more in the [data section](#data).
9292
- `status` - The status of the secret version.
9393
- `created_at` - The date and time of the secret version's creation in RFC 3339 format.
9494
- `updated_at` - The date and time of the secret version's last update in RFC 3339 format.

‎docs/resources/block_snapshot.md

+6-8
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ Refer to the Block Storage [product documentation](https://www.scaleway.com/en/d
1111

1212
## Create a snapshot of a Block Storage volume
1313

14-
The following command shows you how to create a snapshot named `some-snapshot-name` from a Block Storage volume specified by its ID.
14+
The following command allows you to create a snapshot (`some-snapshot-name`) from a Block Storage volume specified by its ID.
1515

1616
```terraform
1717
resource "scaleway_block_volume" "block_volume" {
@@ -28,27 +28,25 @@ resource "scaleway_block_snapshot" "block_snapshot" {
2828

2929
## Arguments reference
3030

31-
The following arguments are supported:
31+
This section lists the arguments that are supported:
3232

3333
- `volume_id` - (Optional) The ID of the volume to take a snapshot from.
3434
- `name` - (Optional) The name of the snapshot. If not provided, a name will be randomly generated.
35-
- `zone` - (Defaults to the zone specified in the [provider's configuration](../index.md#zone)). The [zone](../guides/regions_and_zones.md#zones) in which the snapshot should be created.
36-
- `project_id` - (Defaults to the Project ID specified in the [provider's configuration](../index.md#project_id)). The ID of the Scaleway Project the snapshot is associated with.
35+
- `zone` - (Defaults to the zone specified in the [provider configuration](../index.md#zone)). The [zone](../guides/regions_and_zones.md#zones) in which the snapshot should be created.
36+
- `project_id` - (Defaults to the Project ID specified in the [provider configuration](../index.md#project_id)). The ID of the Scaleway Project the snapshot is associated with.
3737
- `tags` - (Optional) A list of tags to apply to the snapshot.
3838

3939
## Attributes reference
4040

41-
This section lists the attributes that are exported by the `scaleway_block_snapshot` resource:
41+
This section lists the attributes that are exported when the `scaleway_block_snapshot` resource is created:
4242

4343
- `id` - The ID of the snapshot.
4444

4545
~> **Important:** The IDs of Block Storage volumes snapshots are [zoned](../guides/regions_and_zones.md#resource-ids), meaning that the zone is part of the ID, in the form `{zone}/{id}`. For example, a snapshot ID migt be `fr-par-1/11111111-1111-1111-1111-111111111111`.
4646

4747
## Import
4848

49-
This section explains how to import the snapshot of a Block Storage volume using the zoned ID format:
50-
51-
The following command shows you how to import snapshots using the `{zone}/{id}` format.
49+
This section explains how to import the snapshot of a Block Storage volume using the zoned ID format (`{zone}/{id}`).
5250

5351
```bash
5452
terraform import scaleway_block_snapshot.main fr-par-1/11111111-1111-1111-1111-111111111111

‎docs/resources/block_volume.md

+5-5
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ Refer to the Block Storage [product documentation](https://www.scaleway.com/en/d
1111

1212
## Create a Block Storage volume
1313

14-
The following command shows you how to create a Block Storage volume of 20 GB with the desired [IOPS](https://www.scaleway.com/en/docs/storage/block/concepts/#iops).
14+
The following command allows you to create a Block Storage volume of 20 GB with a 5000 [IOPS](https://www.scaleway.com/en/docs/storage/block/concepts/#iops).
1515

1616
### Basic
1717

@@ -46,23 +46,23 @@ resource "scaleway_block_volume" "main" {
4646

4747
## Arguments reference
4848

49-
This section lists the arguments that can be provided to the `scaleway_block_volume` resource:
49+
This section lists the arguments that are supported:
5050

5151
- `iops` - (Required) The maximum [IOPs](https://www.scaleway.com/en/docs/storage/block/concepts/#iops) expected, must match available options.
5252
- `name` - (Optional) The name of the volume. If not provided, a name will be randomly generated.
5353
- `size_in_gb` - (Optional) The size of the volume in gigabytes. Only one of `size_in_gb`, and `snapshot_id` should be specified.
5454
- `snapshot_id` - (Optional) If set, the new volume will be created from this snapshot. Only one of `size_in_gb`, `snapshot_id` should be specified.
5555
- `tags` - (Optional) A list of tags to apply to the volume.
56-
- `zone` - (Defaults to the zone specified in the [provider's configuration](../index.md#zone)). The [zone](../guides/regions_and_zones.md#zones) in which the volume should be created.
57-
- `project_id` - (Defaults to the Project ID specified in the [provider's configurqtion](../index.md#project_id)). The ID of the Project the volume is associated with.
56+
- `zone` - (Defaults to the zone specified in the [provider configuration](../index.md#zone)). The [zone](../guides/regions_and_zones.md#zones) in which the volume should be created.
57+
- `project_id` - (Defaults to the Project ID specified in the [provider configurqtion](../index.md#project_id)). The ID of the Project the volume is associated with.
5858

5959
## Attributes reference
6060

6161
This section lists the attributes that are exported when the `scaleway_block_volume` resource is created:
6262

6363
- `id` - The ID of the volume.
6464

65-
~> **Important:** The IDs of Block Storage volumes are [zoned](../guides/regions_and_zones.md#resource-ids), meaning that the zone is part of the ID, in the form `{zone}/{id}`. For example, a volume ID migt be `fr-par-1/11111111-1111-1111-1111-111111111111`.
65+
~> **Important:** The IDs of Block Storage volumes are [zoned](../guides/regions_and_zones.md#resource-ids), meaning that the zone is part of the ID, in the `{zone}/{id}` format. For example, a volume ID might look like the following: `fr-par-1/11111111-1111-1111-1111-111111111111`.
6666

6767
- `organization_id` - The Organization ID the volume is associated with.
6868

‎docs/resources/cockpit.md

+12-5
Original file line numberDiff line numberDiff line change
@@ -13,11 +13,18 @@ The `scaleway_cockpit` resource allows you to create and manage Scaleway Cockpit
1313

1414
Refer to Cockpit's [product documentation](https://www.scaleway.com/en/docs/observability/cockpit/concepts/) and [API documentation](https://www.scaleway.com/en/developers/api/cockpit/regional-api) for more information.
1515

16-
For more information consult the [documentation](https://www.scaleway.com/en/docs/observability/cockpit/concepts/).
17-
1816
## Use Cockpit
1917

18+
<<<<<<< HEAD
2019
### Manage Cockpit in the Scaleway default Project
20+
=======
21+
The following commands allow you to:
22+
23+
- activate Cockpit in the Scaleway default Project
24+
- activate Cockpit in a given Project specified by the Project ID
25+
- create a Grafana user in the default Project
26+
- create a Grafana folder
27+
>>>>>>> 3679c45b (docs(add): review)
2128
2229
```terraform
2330
// Activate Cockpit in the default Project
@@ -66,12 +73,12 @@ resource "grafana_folder" "test_folder" {
6673

6774
## Arguments reference
6875

69-
- `project_id` - - `project_id` - (Defaults to the Project specified in the [provider's configuration](../index.md#project_id)) The ID of the Project the Cockpit is associated with.
76+
- `project_id` - (Defaults to the Project specified in the [provider's configuration](../index.md#project_id)) The ID of the Project the Cockpit is associated with.
7077
- `plan` - (Optional) Name of the plan to use. Available plans are: free, premium, and custom.
7178

7279
## Attributes reference
7380

74-
This section lists the attributes that are automatically exported when the `scaleway_cockpit` resource is created:
81+
This section lists the attributes that are exported when the `scaleway_cockpit` resource is created:
7582

7683
- `plan_id` - (Deprecated) The ID of the current pricing plan.
7784
- `endpoints` - (Deprecated) A list of [endpoints](https://www.scaleway.com/en/docs/observability/cockpit/concepts/#endpoints) related to Cockpit, each with specific URLs:
@@ -83,7 +90,7 @@ This section lists the attributes that are automatically exported when the `scal
8390

8491
## Import
8592

86-
This section explains how to import Cockpits using its `{project_id}`:
93+
This section explains how to import a Cockpit using its `{project_id}`.
8794

8895
```bash
8996
terraform import scaleway_cockpit.main 11111111-1111-1111-1111-111111111111

0 commit comments

Comments
 (0)