Skip to content

Commit a58bbfc

Browse files
authored
doc: format examples and relocate inference model datasource (#3121)
* doc: format examples * docs: relocate inference model datasource
1 parent 77939e4 commit a58bbfc

34 files changed

+82
-82
lines changed

docs/data-sources/availability_zones.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ The following command allow you to retrieve a the AZs of a Region.
1818

1919
```hcl
2020
# Get info by Region key
21-
data scaleway_availability_zones main {
21+
data "scaleway_availability_zones" "main" {
2222
region = "nl-ams"
2323
}
2424
```

docs/data-sources/container.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,10 +18,10 @@ The following commands allow you to:
1818
- retrieve a container by its ID
1919

2020
```hcl
21-
resource scaleway_container_namespace main {
21+
resource "scaleway_container_namespace" "main" {
2222
}
2323
24-
resource scaleway_container main {
24+
resource "scaleway_container" "main" {
2525
name = "test-container-data"
2626
namespace_id = scaleway_container_namespace.main.id
2727
}

docs/data-sources/inference_model.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
subcategory: "inference"
2+
subcategory: "Inference"
33
page_title: "Scaleway: scaleway_inference_model"
44
---
55

docs/data-sources/lb_certificate.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -16,16 +16,16 @@ For more information, see the [main documentation](https://www.scaleway.com/en/d
1616
### Let's Encrypt
1717

1818
```hcl
19-
resource scaleway_lb_ip main {
19+
resource "scaleway_lb_ip" "main" {
2020
}
2121
22-
resource scaleway_lb main {
22+
resource "scaleway_lb" "main" {
2323
ip_id = scaleway_lb_ip.main.id
2424
name = "data-test-lb-cert"
2525
type = "LB-S"
2626
}
2727
28-
resource scaleway_lb_certificate main {
28+
resource "scaleway_lb_certificate" "main" {
2929
lb_id = scaleway_lb.main.id
3030
name = "data-test-lb-cert"
3131
letsencrypt {

docs/data-sources/rdb_database_backup.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10,16 +10,16 @@ Gets information about an RDB backup.
1010
## Example Usage
1111

1212
```hcl
13-
data scaleway_rdb_database_backup find_by_name {
13+
data "scaleway_rdb_database_backup" "find_by_name" {
1414
name = "mybackup"
1515
}
1616
17-
data scaleway_rdb_database_backup find_by_name_and_instance {
17+
data "scaleway_rdb_database_backup" "find_by_name_and_instance" {
1818
name = "mybackup"
1919
instance_id = "11111111-1111-1111-1111-111111111111"
2020
}
2121
22-
data scaleway_rdb_database_backup find_by_id {
22+
data "scaleway_rdb_database_backup" "find_by_id" {
2323
backup_id = "11111111-1111-1111-1111-111111111111"
2424
}
2525
```

docs/data-sources/vpc_gateway_network.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,11 +18,11 @@ resource "scaleway_vpc_gateway_network" "main" {
1818
enable_masquerade = true
1919
}
2020
21-
data scaleway_vpc_gateway_network by_id {
21+
data "scaleway_vpc_gateway_network" "by_id" {
2222
gateway_network_id = scaleway_vpc_gateway_network.main.id
2323
}
2424
25-
data scaleway_vpc_gateway_network by_gateway_and_pn {
25+
data "scaleway_vpc_gateway_network" "by_gateway_and_pn" {
2626
gateway_id = scaleway_vpc_public_gateway.pg01.id
2727
private_network_id = scaleway_vpc_private_network.pn01.id
2828
}

docs/data-sources/vpc_routes.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10,17 +10,17 @@ Gets information about multiple VPC routes.
1010
## Example Usage
1111

1212
```hcl
13-
resource scaleway_vpc vpc01 {
13+
resource "scaleway_vpc" "vpc01" {
1414
name = "tf-vpc-route"
1515
enable_routing = true
1616
}
1717
18-
resource scaleway_vpc_private_network pn01 {
18+
resource "scaleway_vpc_private_network" "pn01" {
1919
name = "tf-pn-route"
2020
vpc_id = scaleway_vpc.vpc01.id
2121
}
2222
23-
resource scaleway_vpc_private_network pn02 {
23+
resource "scaleway_vpc_private_network" "pn02" {
2424
name = "tf-pn_route-2"
2525
vpc_id = scaleway_vpc.vpc01.id
2626
}

docs/resources/apple_silicon_server.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ see the [API documentation](https://www.scaleway.com/en/developers/api/apple-sil
1313
### Basic
1414

1515
```terraform
16-
resource scaleway_apple_silicon_server server {
16+
resource "scaleway_apple_silicon_server" "server" {
1717
name = "test-m1"
1818
type = "M1-M"
1919
}

docs/resources/container.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -14,12 +14,12 @@ For more information on the limitations of Serverless Containers, refer to the [
1414
## Example Usage
1515

1616
```terraform
17-
resource scaleway_container_namespace main {
17+
resource "scaleway_container_namespace" "main" {
1818
name = "my-ns-test"
1919
description = "test container"
2020
}
2121
22-
resource scaleway_container main {
22+
resource "scaleway_container" "main" {
2323
name = "my-container-02"
2424
description = "environment variables test"
2525
namespace_id = scaleway_container_namespace.main.id
@@ -179,7 +179,7 @@ The period between health checks is also configurable.
179179
Example:
180180

181181
```terraform
182-
resource scaleway_container main {
182+
resource "scaleway_container" "main" {
183183
name = "my-container-02"
184184
namespace_id = scaleway_container_namespace.main.id
185185
@@ -206,7 +206,7 @@ It replaces current `max_concurrency` that has been deprecated.
206206
Example:
207207

208208
```terraform
209-
resource scaleway_container main {
209+
resource "scaleway_container" "main" {
210210
name = "my-container-02"
211211
namespace_id = scaleway_container_namespace.main.id
212212

docs/resources/container_cron.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -14,15 +14,15 @@ Refer to the Containers CRON triggers [documentation](https://www.scaleway.com/e
1414
The following command allows you to add a CRON trigger to a Serverless Container.
1515

1616
```terraform
17-
resource scaleway_container_namespace main {
17+
resource "scaleway_container_namespace" "main" {
1818
}
1919
20-
resource scaleway_container main {
20+
resource "scaleway_container" "main" {
2121
name = "my-container-with-cron-tf"
2222
namespace_id = scaleway_container_namespace.main.id
2323
}
2424
25-
resource scaleway_container_cron main {
25+
resource "scaleway_container_cron" "main" {
2626
container_id = scaleway_container.main.id
2727
name = "my-cron-name"
2828
schedule = "5 4 1 * *" #cron at 04:05 on day-of-month 1

docs/resources/container_domain.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ The commands below shows how to bind a custom domain name to a container.
1616
### Simple
1717

1818
```terraform
19-
resource scaleway_container app {}
19+
resource "scaleway_container" "app" {}
2020
2121
resource scaleway_container_domain "app" {
2222
container_id = scaleway_container.app.id
@@ -27,12 +27,12 @@ resource scaleway_container_domain "app" {
2727
### Complete example with domain
2828

2929
```terraform
30-
resource scaleway_container_namespace main {
30+
resource "scaleway_container_namespace" "main" {
3131
name = "my-ns-test"
3232
description = "test container"
3333
}
3434
35-
resource scaleway_container app {
35+
resource "scaleway_container" "app" {
3636
name = "app"
3737
namespace_id = scaleway_container_namespace.main.id
3838
registry_image = "${scaleway_container_namespace.main.registry_endpoint}/nginx:alpine"

docs/resources/container_token.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -12,22 +12,22 @@ Refer to the Containers tokens [documentation](https://www.scaleway.com/en/docs/
1212
## Example Usage
1313

1414
```terraform
15-
resource scaleway_container_namespace main {
15+
resource "scaleway_container_namespace" "main" {
1616
name = "test-container-token-ns"
1717
}
1818
19-
resource scaleway_container main {
19+
resource "scaleway_container" "main" {
2020
namespace_id = scaleway_container_namespace.main.id
2121
}
2222
2323
// Namespace Token
24-
resource scaleway_container_token namespace {
24+
resource "scaleway_container_token" "namespace" {
2525
namespace_id = scaleway_container_namespace.main.id
2626
expires_at = "2022-10-18T11:35:15+02:00"
2727
}
2828
2929
// Container Token
30-
resource scaleway_container_token container {
30+
resource "scaleway_container_token" "container" {
3131
container_id = scaleway_container.main.id
3232
}
3333
```

docs/resources/container_trigger.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ Refer to the Containers triggers [documentation](https://www.scaleway.com/en/doc
1414
### SQS
1515

1616
```terraform
17-
resource scaleway_container_trigger main {
17+
resource "scaleway_container_trigger" "main" {
1818
container_id = scaleway_container.main.id
1919
name = "my-trigger"
2020
sqs {
@@ -29,7 +29,7 @@ resource scaleway_container_trigger main {
2929
### NATS
3030

3131
```terraform
32-
resource scaleway_container_trigger main {
32+
resource "scaleway_container_trigger" "main" {
3333
container_id = scaleway_container.main.id
3434
name = "my-trigger"
3535
nats {

docs/resources/function.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ resource "scaleway_function_namespace" "main" {
2121
description = "Main function namespace"
2222
}
2323
24-
resource scaleway_function main {
24+
resource "scaleway_function" "main" {
2525
namespace_id = scaleway_function_namespace.main.id
2626
runtime = "go118"
2727
handler = "Handle"
@@ -39,7 +39,7 @@ resource "scaleway_function_namespace" "main" {
3939
description = "Main function namespace"
4040
}
4141
42-
resource scaleway_function main {
42+
resource "scaleway_function" "main" {
4343
namespace_id = scaleway_function_namespace.main.id
4444
runtime = "go118"
4545
handler = "Handle"

docs/resources/function_cron.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -14,26 +14,26 @@ Refer to the Functions CRON triggers [documentation](https://www.scaleway.com/en
1414
The following command allows you to add a CRON trigger to a Serverless Function.
1515

1616
```terraform
17-
resource scaleway_function_namespace main {
17+
resource "scaleway_function_namespace" "main" {
1818
name = "test-cron"
1919
}
2020
21-
resource scaleway_function main {
21+
resource "scaleway_function" "main" {
2222
name = "test-cron"
2323
namespace_id = scaleway_function_namespace.main.id
2424
runtime = "node14"
2525
privacy = "private"
2626
handler = "handler.handle"
2727
}
2828
29-
resource scaleway_function_cron main {
29+
resource "scaleway_function_cron" "main" {
3030
name = "test-cron"
3131
function_id = scaleway_function.main.id
3232
schedule = "0 0 * * *"
3333
args = jsonencode({ test = "scw" })
3434
}
3535
36-
resource scaleway_function_cron func {
36+
resource "scaleway_function_cron" "func" {
3737
function_id = scaleway_function.main.id
3838
schedule = "0 1 * * *"
3939
args = jsonencode({ my_var = "terraform" })

docs/resources/function_domain.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -23,9 +23,9 @@ resource "scaleway_function_domain" "main" {
2323
]
2424
}
2525
26-
resource scaleway_function_namespace main {}
26+
resource "scaleway_function_namespace" "main" {}
2727
28-
resource scaleway_function main {
28+
resource "scaleway_function" "main" {
2929
namespace_id = scaleway_function_namespace.main.id
3030
runtime = "go118"
3131
privacy = "private"

docs/resources/function_token.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -12,25 +12,25 @@ Refer to the Functions tokens [documentation](https://www.scaleway.com/en/docs/s
1212
## Example Usage
1313

1414
```terraform
15-
resource scaleway_function_namespace main {
15+
resource "scaleway_function_namespace" "main" {
1616
name = "test-function-token-ns"
1717
}
1818
19-
resource scaleway_function main {
19+
resource "scaleway_function" "main" {
2020
namespace_id = scaleway_function_namespace.main.id
2121
runtime = "go118"
2222
handler = "Handle"
2323
privacy = "private"
2424
}
2525
2626
// Namespace Token
27-
resource scaleway_function_token namespace {
27+
resource "scaleway_function_token" "namespace" {
2828
namespace_id = scaleway_function_namespace.main.id
2929
expires_at = "2022-10-18T11:35:15+02:00"
3030
}
3131
3232
// Function Token
33-
resource scaleway_function_token function {
33+
resource "scaleway_function_token" "function" {
3434
function_id = scaleway_function.main.id
3535
}
3636
```

docs/resources/function_trigger.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ Refer to the Functions triggers [documentation](https://www.scaleway.com/en/docs
1414
### SQS
1515

1616
```terraform
17-
resource scaleway_function_trigger main {
17+
resource "scaleway_function_trigger" "main" {
1818
function_id = scaleway_function.main.id
1919
name = "my-trigger"
2020
sqs {
@@ -29,7 +29,7 @@ resource scaleway_function_trigger main {
2929
### NATS
3030

3131
```terraform
32-
resource scaleway_function_trigger main {
32+
resource "scaleway_function_trigger" "main" {
3333
function_id = scaleway_function.main.id
3434
name = "my-trigger"
3535
nats {

docs/resources/instance_server.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -114,7 +114,7 @@ resource "scaleway_instance_server" "web" {
114114
### With private network
115115

116116
```terraform
117-
resource scaleway_vpc_private_network pn01 {
117+
resource "scaleway_vpc_private_network" "pn01" {
118118
name = "private_network_instance"
119119
}
120120

docs/resources/instance_user_data.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ resource "scaleway_instance_user_data" "main" {
4040
}
4141
4242
# User Data with many keys.
43-
resource scaleway_instance_user_data data {
43+
resource "scaleway_instance_user_data" "data" {
4444
server_id = scaleway_instance_server.main.id
4545
for_each = var.user_data
4646
key = each.key

docs/resources/job_definition.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ Creates and manages a Scaleway Serverless Job Definition. For more information,
1212
### Basic
1313

1414
```terraform
15-
resource scaleway_job_definition main {
15+
resource "scaleway_job_definition" "main" {
1616
name = "testjob"
1717
cpu_limit = 140
1818
memory_limit = 256
@@ -34,7 +34,7 @@ resource scaleway_job_definition main {
3434
### With Secret Reference
3535

3636
```terraform
37-
resource scaleway_job_definition main {
37+
resource "scaleway_job_definition" "main" {
3838
name = "testjob"
3939
cpu_limit = 140
4040
memory_limit = 256

0 commit comments

Comments
 (0)