Skip to content

Commit 62e53a1

Browse files
nerda-codesLaure-diremyleone
authored
docs(review): review of documentation pages (#2620)
* docs(fix): reviewed data sources * docs(fix): block volume resources * docs(add): cpt and block volume resource review * docs(add): review doc last part * docs(add): review * docs(fix): fix markdown-link-check * docs(fix): titles * docs(fix): fix tfproviderdocs * Update docs/data-sources/secret_version.md Co-authored-by: nerda-codes <[email protected]> * docs(fix): fix link * docs(fix): links * docs(fix): lists --------- Co-authored-by: Laure-di <[email protected]> Co-authored-by: Rémy Léone <[email protected]>
1 parent 7e1a732 commit 62e53a1

19 files changed

+418
-267
lines changed

docs/data-sources/bloc_snapshot.md

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

66
# scaleway_block_snapshot
77

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

10-
## Example Usage
10+
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.
11+
12+
## Retrieve a volume's snapshot
13+
14+
The following commands allow you to:
15+
16+
- retrieve a snapshot specified by its name
17+
- retrieve a snapshot specified by its name and the ID of the Block Storage volume it is associated with
18+
- retrieve a snapshot specified by its ID
1119

1220
```terraform
1321
// Get info by snapshot name
@@ -29,14 +37,14 @@ data "scaleway_block_snapshot" "my_snapshot" {
2937

3038
## Argument Reference
3139

32-
The following arguments are supported:
40+
This section lists the arguments that you can provide to the `scaleway_block_snapshot` data source to filter and retrieve the desired snapshot. Each argument has a specific purpose:
3341

34-
- `snapshot_id` - (Optional) The ID of the snapshot. Only one of `name` and `snapshot_id` should be specified.
35-
- `name` - (Optional) The name of the snapshot. Only one of `name` and `snapshot_id` should be specified.
36-
- `volume_id` - (Optional) The ID of the volume from which the snapshot has been created.
37-
- `zone` - (Defaults to [provider](../index.md#zone) `zone`) The [zone](../guides/regions_and_zones.md#zones) in which the snapshot exists.
38-
- `project_id` - (Optional) The ID of the project the snapshot is associated with.
42+
- `snapshot_id` - (Optional) The unique identifier of the snapshot. Only one of `name` and `snapshot_id` should be specified.
43+
- `name` - (Optional) The name of the snapshot. Only one of name or snapshot_id should be specified.
44+
- `volume_id` - (Optional) The unique identifier of the volume from which the snapshot was created.
45+
- `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 exists.
46+
- `project_id` - (Optional) The unique identifier of the Project to which the snapshot is associated.
3947

4048
## Attributes Reference
4149

42-
Exported attributes are the ones from `scaleway_block_snapshot` [resource](../resources/block_snapshot.md)
50+
The `scaleway_block_snapshot` data source exports certain attributes once the snapshot information is retrieved. These attributes can be referenced in other parts of your Terraform configuration. The exported attributes are those that come from the `scaleway_block_snapshot` [resource](../resources/block_snapshot.md)

docs/data-sources/block_volume.md

+14-7
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,16 @@ page_title: "Scaleway: scaleway_block_volume"
55

66
# scaleway_block_volume
77

8-
Gets information about a Block Volume.
8+
The `scaleway_block_volume` data source is used to retrieve information about a Block Storage volume.
9+
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.
10+
11+
## Retrieve a Block Storage volume
12+
13+
The following commands allow you to:
14+
15+
- retrieve a Block Storage volume specified by its name
16+
- retrieve a Block Storage volume specified by its ID
917

10-
## Example Usage
1118

1219
```terraform
1320
// Get info by volume name
@@ -23,13 +30,13 @@ data "scaleway_block_volume" "my_volume" {
2330

2431
## Argument Reference
2532

26-
The following arguments are supported:
33+
This section lists the arguments that you can provide to the `scaleway_block_volume` data source to filter and retrieve the desired volume.
2734

28-
- `volume_id` - (Optional) The ID of the volume. Only one of `name` and `volume_id` should be specified.
35+
- `volume_id` - (Optional) The unique identifier of the volume. Only one of `name` and `volume_id` should be specified.
2936
- `name` - (Optional) The name of the volume. Only one of `name` and `volume_id` should be specified.
30-
- `zone` - (Defaults to [provider](../index.md#zone) `zone`) The [zone](../guides/regions_and_zones.md#zones) in which the volume exists.
31-
- `project_id` - (Optional) The ID of the project the volume is associated with.
37+
- `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 exists.
38+
- `project_id` - (Optional) The unique identifier of the Project to which the volume is associated.
3239

3340
## Attributes Reference
3441

35-
Exported attributes are the ones from `scaleway_block_volume` [resource](../resources/block_volume.md)
42+
The `scaleway_block_volume` data source exports certain attributes once the volume information is retrieved. These attributes can be referenced in other parts of your Terraform configuration. The exported attributes are those that come from the `scaleway_block_volume` [resource](../resources/block_volume.md).

docs/data-sources/cockpit.md

+25-16
Original file line numberDiff line numberDiff line change
@@ -8,39 +8,48 @@ page_title: "Scaleway: scaleway_cockpit"
88
~> **Important:** The data source `scaleway_cockpit` has been deprecated and will no longer be supported. Instead, use resource `scaleway_cockpit`.
99

1010
-> **Note:**
11-
As of April 2024, Cockpit has introduced regionalization to offer more flexibility and resilience.
12-
If you have customized dashboards in Grafana for monitoring Scaleway resources, please update your queries to accommodate the new regionalized [data sources](../resources/cockpit_source.md).
11+
As of April 2024, Cockpit has introduced [regionalization](https://www.scaleway.com/en/docs/observability/cockpit/concepts/#region) to offer more flexibility and resilience.
12+
If you have created customized dashboards with data for your Scaleway resources before April 2024, you will need to update your queries in Grafana, with the new regionalized [data sources](../resources/cockpit_source.md).
1313

14-
Gets information about the Scaleway Cockpit.
14+
The `scaleway_cockpit` data source is used to retrieve information about a Scaleway Cockpit associated with a given Project. This can be the default Project or a specific Project identified by its ID.
1515

16-
For more information consult the [documentation](https://www.scaleway.com/en/docs/observability/cockpit/concepts/).
16+
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.
1717

18-
## Example Usage
18+
## Retrieve a Cockpit
19+
20+
The following commands allow you to:
21+
22+
- get information on the Cockpit associated with your Scaleway default Project
23+
- get information on the Cockpit associated with a specific Scaleway Project
1924

2025
```hcl
21-
// Get default project's cockpit
26+
// Get the default Project's Cockpit
2227
data "scaleway_cockpit" "main" {}
2328
```
2429

2530
```hcl
26-
// Get a specific project's cockpit
31+
// Get a specific Project's Cockpit
2732
data "scaleway_cockpit" "main" {
2833
project_id = "11111111-1111-1111-1111-111111111111"
2934
}
3035
```
3136

32-
## Arguments Reference
37+
## Argument Reference
38+
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).
3342

34-
- `project_id` - (Defaults to [provider](../index.md#project_id) `project_id`) The ID of the project the cockpit is associated with.
43+
- `plan` - (Optional) Specifies the name or ID of the pricing plan to use.
3544

3645

3746
## Attributes Reference
3847

39-
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.
4049

41-
- `plan_id` - (Deprecated) The ID of the current plan
42-
- `endpoints` - (Deprecated) Endpoints
43-
- `metrics_url` - (Deprecated) The metrics URL
44-
- `logs_url` - (Deprecated) The logs URL
45-
- `alertmanager_url` - (Deprecated) The alertmanager URL
46-
- `grafana_url` - (Deprecated) The grafana URL
50+
- `plan_id` - (Deprecated) ID of the current pricing plan
51+
- `endpoints` - (Deprecated) A list of [endpoints](https://www.scaleway.com/en/docs/observability/cockpit/concepts/#endpoints) related to Cockpit, each with specific URLs:
52+
- `metrics_url` - (Deprecated) URL for [metrics](https://www.scaleway.com/en/docs/observability/cockpit/concepts/#metric) to retrieve in the [Data sources tab](https://console.scaleway.com/cockpit/dataSource) of the Scaleway console.
53+
- `logs_url` - (Deprecated) URL for [logs](https://www.scaleway.com/en/docs/observability/cockpit/concepts/#logs) to retrieve in the [Data sources tab](https://console.scaleway.com/cockpit/dataSource) of the Scaleway console.
54+
- `alertmanager_url` - (Deprecated) URL for the [Alert manager](https://www.scaleway.com/en/docs/observability/cockpit/concepts/#alert-manager).
55+
- `grafana_url` - (Deprecated) URL for Grafana.

docs/data-sources/cockpit_plan.md

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

7-
Gets information about a Scaleway Cockpit plan.
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

9-
## Example Usage
9+
Find out more about [pricing plans](https://console.scaleway.com/cockpit/plans) in the Scaleway console.
10+
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+
13+
## Fetch and associate a pricing plan to a Cockpit
14+
15+
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.
1016

1117
```hcl
1218
data "scaleway_cockpit_plan" "premium" {
@@ -18,6 +24,8 @@ resource "scaleway_cockpit" "main" {
1824
}
1925
```
2026

21-
## Arguments Reference
27+
## Argument reference
28+
29+
This section lists the arguments that you can provide to the `scaleway_cockpit_plan` data source to filter and retrieve the desired plan.
2230

23-
- `name` - (Required) The name of the plan.
31+
- `name` - (Required) Name of the pricing plan you want to retrieve information about.

docs/data-sources/domain_record.md

+28-22
Original file line numberDiff line numberDiff line change
@@ -5,20 +5,28 @@ page_title: "Scaleway: scaleway_domain_record"
55

66
# scaleway_domain_record
77

8-
Gets information about a domain record.
8+
The `scaleway_domain_record` data source is used to get information about an existing domain record.
99

10-
## Example Usage
10+
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.
11+
12+
13+
## Query domain records
14+
15+
The following commands allow you to:
16+
17+
- 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`).
18+
- query a domain record specified by the DNS zone (`domain.tld`) and the unique record ID (`11111111-1111-1111-1111-111111111111`).
1119

1220
```hcl
13-
# Get record by name, type and data
21+
# Query record by DNS zone, record name, type and content
1422
data "scaleway_domain_record" "by_content" {
1523
dns_zone = "domain.tld"
1624
name = "www"
1725
type = "A"
1826
data = "1.2.3.4"
1927
}
2028
21-
# Get info by ID
29+
# Query record by DNS zone and record ID
2230
data "scaleway_domain_record" "by_id" {
2331
dns_zone = "domain.tld"
2432
record_id = "11111111-1111-1111-1111-111111111111"
@@ -27,33 +35,31 @@ data "scaleway_domain_record" "by_id" {
2735

2836
## Argument Reference
2937

30-
- `dns_zone` - (Optional) The IP address.
38+
This section lists the arguments that you can provide to the `scaleway_domain_record` data source to filter and retrieve the desired record:
39+
40+
- `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.
3141

32-
- `name` - (Required) The name of the record (can be an empty string for a root record).
33-
Cannot be used with `record_id`.
42+
- `name` - (Required when not using `record_id`) The name of the record, which can be an empty string for a root record. Cannot be used with `record_id`.
3443

35-
- `type` - (Required) The type of the record (`A`, `AAAA`, `MX`, `CNAME`, `DNAME`, `ALIAS`, `NS`, `PTR`, `SRV`, `TXT`, `TLSA`, or `CAA`).
36-
Cannot be used with `record_id`.
44+
- `type` - (Required when not using `record_id`) The type of the record (`A`, `AAAA`, `MX`, `CNAME`, etc.). Cannot be used with `record_id`.
3745

38-
- `data` - (Required) The content of the record (an IPv4 for an `A`, a string for a `TXT`...).
39-
Cannot be used with `record_id`.
46+
- `data` - (Required when not using `record_id`) The content of the record (e.g., an IPv4 address for an `A` record or a string for a `TXT` record). Cannot be used with `record_id`.
4047

41-
- `record_id` - (Optional) The record ID.
42-
Cannot be used with `name`, `type` and `data`.
48+
- `record_id` - (Optional) The unique identifier of the record. Cannot be used with `name`, `type`, and `data`.
4349

44-
- `project_id` - (Defaults to [provider](../index.md#project_id) `project_id`) The ID of the project the domain is associated with.
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.
4551

4652
## Attributes Reference
4753

4854
In addition to all arguments above, the following attributes are exported:
4955

50-
- `id` - The ID of the record.
56+
- `id` - The unique identifier of the record.
5157

52-
~> **Important:** Domain records' IDs are of the form `{dns_zone}/{id}`, e.g. `subdomain.domain.tld/11111111-1111-1111-1111-111111111111`
58+
~> **Important:** Domain records' IDs are formatted as `{dns_zone}/{id}` (e.g. `subdomain.domain.tld/11111111-1111-1111-1111-111111111111`).
5359

54-
- `ttl` - Time To Live of the record in seconds.
55-
- `priority` - The priority of the record (mostly used with an `MX` record)
56-
- `geo_ip` - Dynamic record base on user geolocalisation ([More information about dynamic records](../resources/domain_record.md#dynamic-records))
57-
- `http_service` - Dynamic record base on URL resolve ([More information about dynamic records](../resources/domain_record.md#dynamic-records))
58-
- `weighted` - Dynamic record base on IP weights ([More information about dynamic records](../resources/domain_record.md#dynamic-records))
59-
- `view` - Dynamic record based on the client’s (resolver) subnet ([More information about dynamic records](../resources/domain_record.md#dynamic-records))
60+
- `ttl` - The Time To Live (TTL) of the record in seconds.
61+
- `priority` - The priority of the record, mainly used with `MX` records.
62+
- `geo_ip` - Information about dynamic records based on user geolocation. [Find out more about dynamic records](../resources/domain_record.md#dynamic-records).
63+
- `http_service` - Information about dynamic records based on URL resolution. [Find out more about dynamic records](../resources/domain_record.md#dynamic-records).
64+
- `weighted` - Information about dynamic records based on IP weights. [Find out more about dynamic records](../resources/domain_record.md#dynamic-records).
65+
- `view` - Information about dynamic records based on the client’s (resolver) subnet. [Find out more about dynamic records](../resources/domain_record.md#dynamic-records).

docs/data-sources/domain_zone.md

+19-12
Original file line numberDiff line numberDiff line change
@@ -5,10 +5,16 @@ page_title: "Scaleway: scaleway_domain_zone"
55

66
# scaleway_domain_zone
77

8-
Gets information about a domain zone.
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.
9+
10+
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.
911

1012
## Example Usage
1113

14+
### Query a domain zone
15+
16+
The following command allows you to retrieve information about the DNS zone for the subdomain `test` within the domain `scaleway-terraform.com`.
17+
1218
```hcl
1319
# Get zone
1420
data "scaleway_domain_zone" "main" {
@@ -19,28 +25,29 @@ data "scaleway_domain_zone" "main" {
1925

2026
## Argument Reference
2127

22-
The following arguments are supported:
28+
This section lists the arguments that you can provide to the `scaleway_domain_zone` data source to filter and retrieve the desired DNS zone:
29+
2330

24-
- `domain` - (Required) The domain where the DNS zone will be created.
31+
- `domain` - (Required) The primary domain name where the DNS zone is located. This is a mandatory field.
2532

26-
- `subdomain` - (Required) The subdomain(zone name) to create in the domain.
33+
- `subdomain` - (Required) The subdomain (or zone name) within the primary domain. This is a mandatory field.
2734

28-
- `project_id` - (Defaults to [provider](../index.md#project_id) `project_id`) The ID of the project the domain is associated with.
35+
- `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.
2936

3037
## Attributes Reference
3138

3239
In addition to all arguments above, the following attributes are exported:
3340

34-
- `id` - The ID of the zone, which is of the form `{subdomain}.{domain}`
41+
- `id` - The unique identifier of the zone, in the `{subdomain}.{domain}` format.
3542

36-
- `ns` - NameServer list for zone.
43+
- `ns` - The list of name servers for the zone.
3744

38-
- `ns_default` - NameServer default list for zone.
45+
- `ns_default` - The default list of name servers for the zone.
3946

40-
- `ns_master` - NameServer master list for zone.
47+
- `ns_master` - The master list of name servers for the zone.
4148

42-
- `status` - The domain zone status.
49+
- `status` - The status of the domain zone.
4350

44-
- `message` - Message
51+
- `message` - Message associated with the domain zone (typically used for status or error messages).
4552

46-
- `updated_at` - The date and time of the last update of the DNS zone.
53+
- `updated_at` - The date and time of the last update to the DNS zone.

0 commit comments

Comments
 (0)