Skip to content

Commit 8929c7e

Browse files
authored
docs: consistent way of referencing API documentation (#2928)
Sometimes it's referenced as 'API documentation', while other times it's referenced as 'documentation' only. - Some whitespaces were automatically stripped along the way - Fix one grammar issue
1 parent 74233b4 commit 8929c7e

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

52 files changed

+65
-68
lines changed

docs/data-sources/baremetal_offer.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ page_title: "Scaleway: scaleway_baremetal_offer"
55

66
# scaleway_baremetal_offer
77

8-
Gets information about a baremetal offer. For more information, see [the documentation](https://developers.scaleway.com/en/products/baremetal/api).
8+
Gets information about a baremetal offer. For more information, see the [API documentation](https://developers.scaleway.com/en/products/baremetal/api).
99

1010
## Example Usage
1111

docs/data-sources/baremetal_option.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,12 +6,12 @@ page_title: "Scaleway: scaleway_baremetal_option"
66
# scaleway_baremetal_option
77

88
Gets information about a baremetal option.
9-
For more information, see [the documentation](https://developers.scaleway.com/en/products/baremetal/api).
9+
For more information, see the [API documentation](https://developers.scaleway.com/en/products/baremetal/api).
1010

1111
## Example Usage
1212

1313
```hcl
14-
# Get info by option name
14+
# Get info by option name
1515
data "scaleway_baremetal_option" "by_name" {
1616
name = "Remote Access"
1717
}
@@ -37,4 +37,4 @@ In addition to all above arguments, the following attributes are exported:
3737
~> **Important:** Baremetal options' IDs are [zoned](../guides/regions_and_zones.md#resource-ids), which means they are of the form `{zone}/{id}`, e.g. `fr-par-1/11111111-1111-1111-1111-111111111111`
3838

3939
- `name` - The name of the option.
40-
- `manageable` - Is false if the option could not be added or removed.
40+
- `manageable` - Is false if the option could not be added or removed.

docs/data-sources/baremetal_os.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ page_title: "Scaleway: scaleway_baremetal_os"
66
# scaleway_baremetal_os
77

88
Gets information about a baremetal operating system.
9-
For more information, see [the documentation](https://www.scaleway.com/en/developers/api/elastic-metal/#path-os-list-available-oses).
9+
For more information, see the [API documentation](https://www.scaleway.com/en/developers/api/elastic-metal/#path-os-list-available-oses).
1010

1111
You can also use the [scaleway-cli](https://github.com/scaleway/scaleway-cli) with `scw baremetal os list` to list all available operating systems.
1212

docs/data-sources/baremetal_server.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ page_title: "Scaleway: scaleway_baremetal_server"
66
# scaleway_baremetal_server
77

88
Gets information about a baremetal server.
9-
For more information, see [the documentation](https://developers.scaleway.com/en/products/baremetal/api).
9+
For more information, see the [API documentation](https://developers.scaleway.com/en/products/baremetal/api).
1010

1111
## Example Usage
1212

docs/data-sources/k8s_version.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ page_title: "Scaleway: scaleway_k8s_version"
66
# scaleway_k8s_version
77

88
Gets information about a Kubernetes version.
9-
For more information, see [the documentation](https://developers.scaleway.com/en/products/k8s/api).
9+
For more information, see the [API documentation](https://developers.scaleway.com/en/products/k8s/api).
1010

1111
You can also use the [scaleway-cli](https://github.com/scaleway/scaleway-cli) with `scw k8s version list` to list all available versions.
1212

@@ -43,4 +43,4 @@ In addition to all above arguments, the following attributes are exported:
4343

4444
- `available_cnis` - The list of supported Container Network Interface (CNI) plugins for this version.
4545
- `available_container_runtimes` - The list of supported container runtimes for this version.
46-
- `available_feature_gates` - The list of supported feature gates for this version.
46+
- `available_feature_gates` - The list of supported feature gates for this version.

docs/data-sources/vpc_public_gateway_dhcp_reservation.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ page_title: "Scaleway: scaleway_vpc_public_gateway_dhcp_reservation"
66
# scaleway_vpc_public_gateway_dhcp_reservation
77

88
Gets information about a DHCP entry. For further information, please see the
9-
API [documentation](https://www.scaleway.com/en/developers/api/public-gateway/#path-dhcp-entries-list-dhcp-entries)/
9+
[API documentation](https://www.scaleway.com/en/developers/api/public-gateway/#path-dhcp-entries-list-dhcp-entries).
1010

1111
## Example Dynamic
1212

docs/data-sources/vpc_public_gateway_ip.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ page_title: "Scaleway: scaleway_vpc_public_gateway_ip"
77

88
Gets information about a Public Gateway public flexible IP address.
99

10-
For further information, please see the API [documentation](https://www.scaleway.com/en/developers/api/public-gateway/#path-ips-list-ips).
10+
For further information, please see the [API documentation](https://www.scaleway.com/en/developers/api/public-gateway/#path-ips-list-ips).
1111

1212
## Example Usage
1313

docs/data-sources/vpc_public_gateway_pat_rule.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ page_title: "Scaleway: scaleway_vpc_public_gateway_pat_rule"
66
# scaleway_vpc_public_gateway_pat_rule
77

88
Gets information about a Public Gateway PAT rule. For further information, please see the
9-
API [documentation](https://www.scaleway.com/en/developers/api/public-gateway/#path-pat-rules-list-pat-rules).
9+
[API documentation](https://www.scaleway.com/en/developers/api/public-gateway/#path-pat-rules-list-pat-rules).
1010

1111
## Example Usage
1212

docs/resources/apple_silicon.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ page_title: "Scaleway: scaleway_apple_silicon"
66
# Resource: scaleway_apple_silicon
77

88
Creates and manages Scaleway Apple silicon. For more information,
9-
see [the documentation](https://www.scaleway.com/en/developers/api/apple-silicon/).
9+
see the [API documentation](https://www.scaleway.com/en/developers/api/apple-silicon/).
1010

1111
## Example Usage
1212

docs/resources/baremetal_server.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ page_title: "Scaleway: scaleway_baremetal_server"
55

66
# Resource: scaleway_baremetal_server
77

8-
Creates and manages Scaleway Compute Baremetal servers. For more information, see [the documentation](https://www.scaleway.com/en/developers/api/elastic-metal/).
8+
Creates and manages Scaleway Compute Baremetal servers. For more information, see the [API documentation](https://www.scaleway.com/en/developers/api/elastic-metal/).
99

1010
## Example Usage
1111

0 commit comments

Comments
 (0)