Skip to content

Commit 10347c0

Browse files
author
Arthur Amstutz
committed
chore: enforce style guidelines in docs + add a contributing rule
1 parent ac0dca5 commit 10347c0

File tree

71 files changed

+165
-162
lines changed

Some content is hidden

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

71 files changed

+165
-162
lines changed

CONTRIBUTING.md

+1
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@ This project accepts contributions. In order to contribute, you should pay atten
1313

1414
- Code must be formatted with `make fmt` command
1515
- Name your resources and datasources according to the API endpoint
16+
- The examples of resources and datasources in the documentation must follow the [Terraform style guidelines](https://developer.hashicorp.com/terraform/language/style)
1617
- Check your documentation through [Terraform Doc Preview Tool](https://registry.terraform.io/tools/doc-preview)
1718
- When adding a documentation page, use the `subcategory:` tag in the [YAML Frontmatter](https://developer.hashicorp.com/terraform/registry/providers/docs#yaml-frontmatter) with a value equals to the product name defined in the OVHcloud [product map](https://www.product-map.ovh/)
1819

website/docs/d/cloud_project_containerregistry.html.markdown

+1-1
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ Use this data source to get information about a container registry associated wi
99
## Example Usage
1010

1111
```hcl
12-
data "ovh_cloud_project_containerregistry" "my-registry" {
12+
data "ovh_cloud_project_containerregistry" "my_registry" {
1313
service_name = "XXXXXX"
1414
registry_id = "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxx"
1515
}

website/docs/d/cloud_project_containerregistry_ip_restrictions_management.html.markdown

+2-2
Original file line numberDiff line numberDiff line change
@@ -9,13 +9,13 @@ Use this data source to get the list of Management IP Restrictions of a containe
99
## Example Usage
1010

1111
```hcl
12-
data data "ovh_cloud_project_containerregistry_ip_restrictions_management" "mgt-iprestrictions-data" {
12+
data data "ovh_cloud_project_containerregistry_ip_restrictions_management" "mgt_iprestrictions_data" {
1313
service_name = "XXXXXX"
1414
registry_id = "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxx"
1515
}
1616
1717
output "my_ip_restrictions" {
18-
value = data.ovh_cloud_project_containerregistry_ip_restrictions_management.mgt-iprestrictions-data.ip_restrictions
18+
value = data.ovh_cloud_project_containerregistry_ip_restrictions_management.mgt_iprestrictions_data.ip_restrictions
1919
}
2020
```
2121

website/docs/d/cloud_project_containerregistry_ip_restrictions_registry.html.markdown

+3-2
Original file line numberDiff line numberDiff line change
@@ -9,12 +9,13 @@ Use this data source to get the list of Registry IP Restrictions of a container
99
## Example Usage
1010

1111
```hcl
12-
data data "ovh_cloud_project_containerregistry_ip_restrictions_registry" "my-iprestrictions-data" {
12+
data data "ovh_cloud_project_containerregistry_ip_restrictions_registry" "my_iprestrictions_data" {
1313
service_name = "XXXXXX"
1414
registry_id = "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxx"
1515
}
16+
1617
output "my_ip_restrictions" {
17-
value = data.ovh_cloud_project_containerregistry_ip_restrictions_registry.my-iprestrictions-data.ip_restrictions
18+
value = data.ovh_cloud_project_containerregistry_ip_restrictions_registry.my_iprestrictions_data.ip_restrictions
1819
}
1920
```
2021

website/docs/d/cloud_project_containerregistry_oidc.html.markdown

+2-2
Original file line numberDiff line numberDiff line change
@@ -9,13 +9,13 @@ Use this data source to get a OVHcloud Managed Private Registry OIDC.
99
## Example Usage
1010

1111
```hcl
12-
data "ovh_cloud_project_containerregistry_oidc" "my-oidc" {
12+
data "ovh_cloud_project_containerregistry_oidc" "my_oidc" {
1313
service_name = "XXXXXX"
1414
registry_id = "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxx"
1515
}
1616
1717
output "oidc-client-id" {
18-
value = data.ovh_cloud_project_containerregistry_oidc.my-oidc.oidc_client_id
18+
value = data.ovh_cloud_project_containerregistry_oidc.my_oidc.oidc_client_id
1919
}
2020
```
2121

website/docs/d/cloud_project_containerregistry_users.html.markdown

+3-3
Original file line numberDiff line numberDiff line change
@@ -9,14 +9,14 @@ Use this data source to get the list of users of a container registry associated
99
## Example Usage
1010

1111
```hcl
12-
data "ovh_cloud_project_containerregistry" "my-registry" {
12+
data "ovh_cloud_project_containerregistry" "my_registry" {
1313
service_name = "XXXXXX"
1414
registry_id = "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxx"
1515
}
1616
1717
data "ovh_cloud_project_containerregistry_users" "users" {
18-
service_name = ovh_cloud_project_containerregistry.registry.service_name
19-
registry_id = ovh_cloud_project_containerregistry.registry.id
18+
service_name = ovh_cloud_project_containerregistry.my_registry.service_name
19+
registry_id = ovh_cloud_project_containerregistry.my_registry.id
2020
}
2121
```
2222

website/docs/d/cloud_project_database_ip_restrictions.html.markdown

+2-2
Original file line numberDiff line numberDiff line change
@@ -13,14 +13,14 @@ Use this data source to get the list of IP restrictions associated with a public
1313
To get the list of IP restriction on a database cluster service:
1414

1515
```hcl
16-
data "ovh_cloud_project_database_ip_restrictions" "iprestrictions" {
16+
data "ovh_cloud_project_database_ip_restrictions" "ip_restrictions" {
1717
service_name = "XXXXXX"
1818
engine = "YYYY"
1919
cluster_id = "ZZZZ"
2020
}
2121
2222
output "ips" {
23-
value = data.ovh_cloud_project_database_ip_restrictions.iprestrictions.ips
23+
value = data.ovh_cloud_project_database_ip_restrictions.ip_restrictions.ips
2424
}
2525
```
2626

website/docs/d/cloud_project_database_kafka_schemaregistryacl.html.markdown

+2-2
Original file line numberDiff line numberDiff line change
@@ -9,14 +9,14 @@ Use this data source to get information about a schema registry ACL of a kafka c
99
## Example Usage
1010

1111
```hcl
12-
data "ovh_cloud_project_database_kafka_schemaregistryacl" "schemaRegistryAcl" {
12+
data "ovh_cloud_project_database_kafka_schemaregistryacl" "schema_registry_acl" {
1313
service_name = "XXX"
1414
cluster_id = "YYY"
1515
id = "ZZZ"
1616
}
1717
1818
output "acl_permission" {
19-
value = data.ovh_cloud_project_database_kafka_schemaregistryacl.schemaRegistryAcl.permission
19+
value = data.ovh_cloud_project_database_kafka_schemaregistryacl.schema_registry_acl.permission
2020
}
2121
```
2222

website/docs/d/cloud_project_database_kafka_schemaregistryacls.html.markdown

+2-2
Original file line numberDiff line numberDiff line change
@@ -9,13 +9,13 @@ Use this data source to get the list of ACLs of a kafka cluster associated with
99
## Example Usage
1010

1111
```hcl
12-
data "ovh_cloud_project_database_kafka_schemaregistryacls" "schemaRegistryAcls" {
12+
data "ovh_cloud_project_database_kafka_schemaregistryacls" "schema_registry_acls" {
1313
service_name = "XXX"
1414
cluster_id = "YYY"
1515
}
1616
1717
output "acl_ids" {
18-
value = data.ovh_cloud_project_database_kafka_schemaregistryacls.schemaRegistryAcls.acl_ids
18+
value = data.ovh_cloud_project_database_kafka_schemaregistryacls.schema_registry_acls.acl_ids
1919
}
2020
```
2121

website/docs/d/cloud_project_database_m3db_namespace.html.markdown

+2-2
Original file line numberDiff line numberDiff line change
@@ -9,14 +9,14 @@ Use this data source to get information about a namespace of a M3DB cluster asso
99
## Example Usage
1010

1111
```hcl
12-
data "ovh_cloud_project_database_m3db_namespace" "m3dbnamespace" {
12+
data "ovh_cloud_project_database_m3db_namespace" "m3db_namespace" {
1313
service_name = "XXX"
1414
cluster_id = "YYY"
1515
name = "ZZZ"
1616
}
1717
1818
output "m3dbnamespace_type" {
19-
value = data.ovh_cloud_project_database_m3db_namespace.m3dbnamespace.type
19+
value = data.ovh_cloud_project_database_m3db_namespace.m3db_namespace.type
2020
}
2121
```
2222

website/docs/d/cloud_project_database_m3db_user.html.markdown

+3-3
Original file line numberDiff line numberDiff line change
@@ -9,14 +9,14 @@ Use this data source to get information about a user of a M3DB cluster associate
99
## Example Usage
1010

1111
```hcl
12-
data "ovh_cloud_project_database_m3db_user" "m3dbuser" {
12+
data "ovh_cloud_project_database_m3db_user" "m3db_user" {
1313
service_name = "XXX"
1414
cluster_id = "YYY"
1515
name = "ZZZ"
1616
}
1717
18-
output "m3dbuser_group" {
19-
value = data.ovh_cloud_project_database_m3db_user.m3dbuser.group
18+
output "m3db_user_group" {
19+
value = data.ovh_cloud_project_database_m3db_user.m3db_user.group
2020
}
2121
```
2222

website/docs/d/cloud_project_database_mongodb_user.html.markdown

+3-3
Original file line numberDiff line numberDiff line change
@@ -9,14 +9,14 @@ Use this data source to get information about a user of a mongodb cluster associ
99
## Example Usage
1010

1111
```hcl
12-
data "ovh_cloud_project_database_mongodb_user" "mongouser" {
12+
data "ovh_cloud_project_database_mongodb_user" "mongo_user" {
1313
service_name = "XXX"
1414
cluster_id = "YYY"
1515
name = "ZZZ@admin"
1616
}
1717
18-
output "mongouser_roles" {
19-
value = data.ovh_cloud_project_database_mongodb_user.mongouser.roles
18+
output "mongo_user_roles" {
19+
value = data.ovh_cloud_project_database_mongodb_user.mongo_user.roles
2020
}
2121
```
2222

website/docs/d/cloud_project_database_opensearch_user.html.markdown

+3-3
Original file line numberDiff line numberDiff line change
@@ -9,14 +9,14 @@ Use this data source to get information about a user of a opensearch cluster ass
99
## Example Usage
1010

1111
```hcl
12-
data "ovh_cloud_project_database_opensearch_user" "osuser" {
12+
data "ovh_cloud_project_database_opensearch_user" "os_user" {
1313
service_name = "XXX"
1414
cluster_id = "YYY"
1515
name = "ZZZ"
1616
}
1717
18-
output "osuser_acls" {
19-
value = data.ovh_cloud_project_database_opensearch_user.osuser.acls
18+
output "os_user_acls" {
19+
value = data.ovh_cloud_project_database_opensearch_user.os_user.acls
2020
}
2121
```
2222

website/docs/d/cloud_project_database_postgresql_user.html.markdown

+3-3
Original file line numberDiff line numberDiff line change
@@ -9,14 +9,14 @@ Use this data source to get information about a user of a postgresql cluster ass
99
## Example Usage
1010

1111
```hcl
12-
data "ovh_cloud_project_database_postgresql_user" "pguser" {
12+
data "ovh_cloud_project_database_postgresql_user" "pg_user" {
1313
service_name = "XXX"
1414
cluster_id = "YYY"
1515
name = "ZZZ"
1616
}
1717
18-
output "pguser_roles" {
19-
value = data.ovh_cloud_project_database_postgresql_user.pguser.roles
18+
output "pg_user_roles" {
19+
value = data.ovh_cloud_project_database_postgresql_user.pg_user.roles
2020
}
2121
```
2222

website/docs/d/cloud_project_database_redis_user.html.markdown

+3-3
Original file line numberDiff line numberDiff line change
@@ -9,14 +9,14 @@ Use this data source to get information about a user of a redis cluster associat
99
## Example Usage
1010

1111
```hcl
12-
data "ovh_cloud_project_database_redis_user" "redisuser" {
12+
data "ovh_cloud_project_database_redis_user" "redis_user" {
1313
service_name = "XXX"
1414
cluster_id = "YYY"
1515
name = "ZZZ"
1616
}
1717
18-
output "redisuser_commands" {
19-
value = data.ovh_cloud_project_database_redis_user.redisuser.commands
18+
output "redis_user_commands" {
19+
value = data.ovh_cloud_project_database_redis_user.redis_user.commands
2020
}
2121
```
2222

website/docs/d/cloud_project_failover_ip_attach.html.markdown

+1-1
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ Use this data source to get the details of a failover IP address of a service in
99
## Example Usage
1010

1111
```hcl
12-
data "ovh_cloud_project_failover_ip_attach" "myfailoverip" {
12+
data "ovh_cloud_project_failover_ip_attach" "my_failover_ip" {
1313
service_name = "XXXXXX"
1414
ip = "XXXXXX"
1515
}

website/docs/d/cloud_project_kube_iprestrictions.html.markdown

+2-2
Original file line numberDiff line numberDiff line change
@@ -9,13 +9,13 @@ Use this data source to get a OVHcloud Managed Kubernetes Service cluster IP res
99
## Example Usage
1010

1111
```hcl
12-
data "ovh_cloud_project_kube_iprestrictions" "iprestrictions" {
12+
data "ovh_cloud_project_kube_iprestrictions" "ip_restrictions" {
1313
service_name = "XXXXXX"
1414
kube_id = "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxx"
1515
}
1616
1717
output "ips" {
18-
value = data.ovh_cloud_project_kube_iprestrictions.iprestrictions.ips
18+
value = data.ovh_cloud_project_kube_iprestrictions.ip_restrictions.ips
1919
}
2020
```
2121

website/docs/d/cloud_project_network_privates.html.markdown

+1
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,7 @@ List public cloud project private networks.
1212
data "ovh_cloud_project_network_privates" "private" {
1313
service_name = "XXXXXX"
1414
}
15+
1516
output "private" {
1617
value = data.ovh_cloud_project_network_privates.private
1718
}

website/docs/d/dedicated_ceph.html.markdown

+1-1
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ Use this data source to retrieve information about a dedicated CEPH.
99
## Example Usage
1010

1111
```hcl
12-
data "ovh_dedicated_ceph" "my-ceph" {
12+
data "ovh_dedicated_ceph" "my_ceph" {
1313
service_name = "XXXXXX"
1414
}
1515
```

website/docs/d/dedicated_installation_template.html.markdown

+2-2
Original file line numberDiff line numberDiff line change
@@ -9,12 +9,12 @@ Use this data source to retrieve information about a specific OVH dedicated serv
99
## Example Usage
1010

1111
```hcl
12-
data "ovh_dedicated_installation_template" "ovhtemplate" {
12+
data "ovh_dedicated_installation_template" "ovh_template" {
1313
template_name = "debian12_64"
1414
}
1515
1616
output "template" {
17-
value = data.ovh_dedicated_installation_template.ovhtemplate
17+
value = data.ovh_dedicated_installation_template.ovh_template
1818
}
1919
```
2020

website/docs/d/dedicated_nasha.html.markdown

+1-1
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ Use this data source to retrieve information about a dedicated HA-NAS.
99
## Example Usage
1010

1111
```hcl
12-
data "ovh_dedicated_nasha" "my-nas-ha" {
12+
data "ovh_dedicated_nasha" "my_nas_ha" {
1313
service_name = "zpool-12345"
1414
}
1515
```

website/docs/d/domain_zone.html.markdown

+1-1
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ Use this data source to retrieve information about a domain zone.
99
## Example Usage
1010

1111
```hcl
12-
data "ovh_domain_zone" "rootzone" {
12+
data "ovh_domain_zone" "root_zone" {
1313
name = "mysite.ovh"
1414
}
1515
```

website/docs/d/hosting_privatedatabase_database.html.markdown

+1-1
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ Use this data source to retrieve information about an hosting privatedatabase.
1010
## Example Usage
1111

1212
```hcl
13-
data "ovh_hosting_privatedatabase_database" "mydatabase" {
13+
data "ovh_hosting_privatedatabase_database" "my_database" {
1414
service_name = "XXXXXX"
1515
database_name = "XXXXXX"
1616
}

website/docs/d/ip_firewall.html.markdown

+1-1
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ Use this data source to retrieve information about an IP firewall.
99
## Example Usage
1010

1111
```hcl
12-
data "ovh_ip_firewall" "myfirewall" {
12+
data "ovh_ip_firewall" "my_firewall" {
1313
ip = "XXXXXX"
1414
ip_on_firewall = "XXXXXX"
1515
}

website/docs/d/ip_firewall_rule.html.markdown

+1-1
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ Use this data source to retrieve information about a rule on an IP firewall.
99
## Example Usage
1010

1111
```hcl
12-
data "ovh_ip_firewall_rule" "myfirewallrule" {
12+
data "ovh_ip_firewall_rule" "my_firewall_rule" {
1313
ip = "XXXXXX"
1414
ip_on_firewall = "XXXXXX"
1515
sequence = 0

website/docs/d/ip_service.html.markdown

+1-1
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ Use this data source to retrieve information about an IP service.
99
## Example Usage
1010

1111
```hcl
12-
data "ovh_ip_service" "myip" {
12+
data "ovh_ip_service" "my_ip" {
1313
service_name = "XXXXXX"
1414
}
1515
```

website/docs/d/me.html.markdown

+1-1
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ Use this data source to get information about the current OVHcloud account.
99
## Example Usage
1010

1111
```hcl
12-
data "ovh_me" "myaccount" {}
12+
data "ovh_me" "my_account" {}
1313
```
1414

1515
## Argument Reference

website/docs/d/me_installation_template.html.markdown

+1-1
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ Use this data source to get a custom installation template available for dedicat
99
## Example Usage
1010

1111
```hcl
12-
data "ovh_me_installation_template" "mytemplate" {
12+
data "ovh_me_installation_template" "my_template" {
1313
template_name = "mytemplate"
1414
}
1515
```

website/docs/d/order_cart.html.markdown

+3-3
Original file line numberDiff line numberDiff line change
@@ -9,10 +9,10 @@ Use this data source to create a temporary order cart to retrieve information or
99
## Example Usage
1010

1111
```hcl
12-
data "ovh_me" "myaccount" {}
12+
data "ovh_me" "my_account" {}
1313
14-
data "ovh_order_cart" "mycart" {
15-
ovh_subsidiary = data.ovh_me.myaccount.ovh_subsidiary
14+
data "ovh_order_cart" "my_cart" {
15+
ovh_subsidiary = data.ovh_me.my_account.ovh_subsidiary
1616
}
1717
```
1818

0 commit comments

Comments
 (0)