Skip to content

Commit

Permalink
docs(ter): review luiza products
Browse files Browse the repository at this point in the history
  • Loading branch information
ldecarvalho-doc committed Jun 5, 2024
1 parent 4b9ba52 commit bfd470d
Show file tree
Hide file tree
Showing 32 changed files with 263 additions and 256 deletions.
7 changes: 5 additions & 2 deletions docs/data-sources/account_ssh_key.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,8 +23,11 @@ data "scaleway_account_ssh_key" "my_key" {

## Argument Reference

- `name` - The SSH key name. Only one of `name` and `ssh_key_id` should be specified.
- `ssh_key_id` - The SSH key id. Only one of `name` and `ssh_key_id` should be specified.
- `name` - The SSH key name.
- `ssh_key_id` - The SSH key id.

-> **Note** You must specify at least one: `name` and/or `ssh_key_id`.

- `project_id` - (Defaults to [provider](../index.md#project_id) `project_id`) The ID of the project the SSH key is associated with.

## Attributes Reference
Expand Down
34 changes: 17 additions & 17 deletions docs/data-sources/billing_invoices.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ page_title: "Scaleway: scaleway_billing_invoices"

# scaleway_billing_invoices

Gets information about your Invoices.
Gets information about your Scaleway invoices.

## Example Usage

Expand Down Expand Up @@ -36,19 +36,19 @@ data "scaleway_billing_invoices" "my-invoices" {
In addition to all arguments above, the following attributes are exported:

- `invoices` - List of found invoices
- `id` - The associated invoice ID.
- `organization_name` - The organization name.
- `start_date` - The start date of the billing period (RFC 3339 format).
- `stop_date` - The end date of the billing period (RFC 3339 format).
- `billing_period` - The billing period of the invoice in the YYYY-MM format.
- `issued_date` - The date when the invoice was sent to the customer (RFC 3339 format).
- `due_date` - The payment time limit, set according to the Organization's payment conditions (RFC 3339 format).
- `total_untaxed` - The total amount, untaxed.
- `total_taxed` - The total amount, taxed.
- `total_tax` - The total tax amount of the invoice.
- `total_discount` - The total discount amount of the invoice.
- `total_undiscount` - The total amount of the invoice before applying the discount.
- `invoice_type` - The type of invoice.
- `state` - The state of the invoice.
- `number` - The invoice number.
- `seller_name` - The name of the seller (Scaleway).
- `id` - The associated invoice ID.
- `organization_name` - The organization name.
- `start_date` - The start date of the billing period (RFC 3339 format).
- `stop_date` - The end date of the billing period (RFC 3339 format).
- `billing_period` - The billing period of the invoice in the YYYY-MM format.
- `issued_date` - The date when the invoice was sent to the customer (RFC 3339 format).
- `due_date` - The payment time limit, set according to the Organization's payment conditions (RFC 3339 format).
- `total_untaxed` - The total amount, untaxed.
- `total_taxed` - The total amount, taxed.
- `total_tax` - The total tax amount of the invoice.
- `total_discount` - The total discount amount of the invoice.
- `total_undiscount` - The total amount of the invoice before applying the discount.
- `invoice_type` - The type of invoice.
- `state` - The state of the invoice.
- `number` - The invoice number.
- `seller_name` - The name of the seller (Scaleway).
6 changes: 3 additions & 3 deletions docs/data-sources/iam_application.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,13 +23,13 @@ data "scaleway_iam_application" "find_by_id" {
## Argument Reference

- `name` - (Optional) The name of the IAM application.
Only one of the `name` and `application_id` should be specified.

- `application_id` - (Optional) The ID of the IAM application.
Only one of the `name` and `application_id` should be specified.

-> **Note** You must specify at least one: `name` and/or `application_id`.

- `organization_id` - (Optional. Defaults to [provider](../index.md#organization_d) `organization_id`) The ID of the
organization the application is associated with.
Organization the application is associated with.

## Attribute Reference

Expand Down
9 changes: 5 additions & 4 deletions docs/data-sources/iam_group.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,9 @@ page_title: "Scaleway: scaleway_iam_group"

# scaleway_iam_group

Gets information about an existing IAM group. For more information, please
check [the documentation](https://developers.scaleway.com/en/products/iam/api/v1alpha1/#applications-83ce5e)
Gets information about an existing IAM group.

For more information, refer to the [IAM API documentation](https://developers.scaleway.com/en/products/iam/api/v1alpha1/#applications-83ce5e)

## Example Usage

Expand All @@ -25,10 +26,10 @@ data "scaleway_iam_group" "find_by_id" {
## Argument Reference

- `name` - (Optional) The name of the IAM group.
Only one of the `name` and `group_id` should be specified.

- `group_id` - (Optional) The ID of the IAM group.
Only one of the `name` and `group_id` should be specified.

-> **Note** You must specify at least one: `name` and/or `group_id`.

- `organization_id` - (Optional. Defaults to [provider](../index.md#organization_d) `organization_id`) The ID of the
organization the group is associated with.
Expand Down
7 changes: 5 additions & 2 deletions docs/data-sources/iam_ssh_key.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,8 +23,11 @@ data "scaleway_iam_ssh_key" "my_key" {

## Argument Reference

- `name` - The SSH key name. Only one of `name` and `ssh_key_id` should be specified.
- `ssh_key_id` - The SSH key id. Only one of `name` and `ssh_key_id` should be specified.
- `name` - The SSH key name.
- `ssh_key_id` - The SSH key id.

-> **Note** You must specify at least one: `name` and/or `ssh_key_id`.

- `project_id` (Optional. Defaults to [provider](../index.md#project_id) `project_id`) The ID of the project the SSH
key is associated with.

Expand Down
10 changes: 6 additions & 4 deletions docs/data-sources/iam_user.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,7 @@ page_title: "Scaleway: scaleway_iam_user"
# scaleway_iam_user

Use this data source to get information on an existing IAM user based on its ID or email address.
For more information,
see [the documentation](https://developers.scaleway.com/en/products/iam/api/v1alpha1/#users-06bdcf).
For more information refer to the [IAM API documentation](https://developers.scaleway.com/en/products/iam/api/v1alpha1/#users-06bdcf).

## Example Usage

Expand All @@ -24,8 +23,11 @@ data "scaleway_iam_user" "find_by_email" {

## Argument Reference

- `email` - (Optional) The email address of the IAM user. Only one of the `email` and `user_id` should be specified.
- `user_id` - (Optional) The ID of the IAM user. Only one of the `email` and `user_id` should be specified.
- `email` - (Optional) The email address of the IAM user.
- `user_id` - (Optional) The ID of the IAM user.

-> **Note** You must specify at least one: `name` and/or `user_id`.

- `organization_id` - (Optional. Defaults to [provider](../index.md#organization_d) `organization_id`) The ID of the
organization the user is associated with.

Expand Down
2 changes: 1 addition & 1 deletion docs/data-sources/rdb_acl.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ page_title: "Scaleway: scaleway_rdb_acl"

# scaleway_rdb_acl

Gets information about the RDB instance network Access Control List.
Gets information about the Database Instance network Access Control List.

## Example Usage

Expand Down
2 changes: 1 addition & 1 deletion docs/data-sources/rdb_database.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ page_title: "Scaleway: scaleway_rdb_database"

# scaleway_rdb_database

Gets information about a RDB database.
Gets information about a database.

## Example Usage

Expand Down
8 changes: 4 additions & 4 deletions docs/data-sources/rdb_database_backup.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,13 +26,13 @@ data scaleway_rdb_database_backup find_by_id {

## Argument Reference

- `backup_id` - (Optional) The RDB backup ID.
Only one of the `name` and `backup_id` should be specified.
- `instance_id` - (Optional) The Database Instance ID.

- `instance_id` - (Optional) The RDB instance ID.
- `backup_id` - (Optional) The backup ID.

- `name` - (Optional) The name of the RDB instance.
Only one of the `name` and `backup_id` should be specified.

-> **Note** You must specify at least one: `name` and/or `backup_id`.

- `region` - (Defaults to [provider](../index.md#region) `region`) The [region](../guides/regions_and_zones.md#regions) in which the Database Backup is associated with.

Expand Down
16 changes: 9 additions & 7 deletions docs/data-sources/rdb_instance.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,9 @@ page_title: "Scaleway: scaleway_rdb_instance"

# scaleway_rdb_instance

Gets information about an RDB instance. For further information see our [developers website](https://developers.scaleway.com/en/products/rdb/api/#database-instance)
Gets information about an Database Instance.

For further information refer the Managed Databases for PostgreSQL and MySQL [API documentation](https://developers.scaleway.com/en/products/rdb/api/#database-instance)

## Example Usage

Expand All @@ -30,23 +32,23 @@ output "load_balancer_ip_addr" {
## Argument Reference

- `name` - (Optional) The name of the RDB instance.
Only one of `name` and `instance_id` should be specified.

- `instance_id` - (Optional) The RDB instance ID.
Only one of `name` and `instance_id` should be specified.

- `project_id` - (Optional) The ID of the project the RDB instance is in. Can be used to filter instances when using `name`.
-> **Note** You must specify at least one: `name` and/or `instance_id`.

- `project_id` - (Optional) The ID of the project the Database Instance is in. Can be used to filter instances when using `name`.

- `region` - (Defaults to [provider](../index.md#region) `region`) The [region](../guides/regions_and_zones.md#zones) in which the RDB instance exists.
- `region` - (Defaults to [provider](../index.md#region) `region`) The [region](../guides/regions_and_zones.md#zones) in which the Database Instance exists.

- `organization_id` - (Defaults to [provider](../index.md#organization_id) `organization_id`) The ID of the organization the RDB instance is in.

## Attributes Reference

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

- `id` - The ID of the RDB instance.
- `id` - The ID of the Database Instance.

~> **Important:** RDB instances' IDs are [regional](../guides/regions_and_zones.md#resource-ids), which means they are of the form `{region}/{id}`, e.g. `fr-par/11111111-1111-1111-1111-111111111111`
~> **Important:** Database Instance IDs are [regional](../guides/regions_and_zones.md#resource-ids), which means they are of the form `{region}/{id}`, e.g. `fr-par/11111111-1111-1111-1111-111111111111`

Exported attributes are the ones from `scaleway_rdb_instance` [resource](../resources/rdb_instance.md)
6 changes: 3 additions & 3 deletions docs/data-sources/rdb_privilege.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ page_title: "Scaleway: scaleway_rdb_privilege"

# scaleway_rdb_privilege

Gets information about the privilege on RDB database.
Gets information about the privileges in a database.

## Example Usage

Expand All @@ -20,7 +20,7 @@ data "scaleway_rdb_privilege" "main" {

## Argument Reference

- `instance_id` - (Required) The RDB instance ID.
- `instance_id` - (Required) The Database Instance ID.

- `user_name` - (Required) The user name.

Expand All @@ -34,7 +34,7 @@ In addition to all above arguments, the following attributes are exported:

- `id` - The ID of the user privileges.

~> **Important:** RDB databases user privileges' IDs are [regional](../guides/regions_and_zones.md#resource-ids), which means they are of the form `{region}/{instance-id}/{database}/{user-name}`, e.g. `fr-par/11111111-1111-1111-1111-111111111111/database/user`
~> **Important:** Database user privilege IDs are [regional](../guides/regions_and_zones.md#resource-ids), which means they are of the form `{region}/{instance-id}/{database}/{user-name}`, e.g. `fr-par/11111111-1111-1111-1111-111111111111/database/user`

- `permission` - The permission for this user on the database. Possible values are `readonly`, `readwrite`, `all`
, `custom` and `none`.
12 changes: 7 additions & 5 deletions docs/data-sources/redis_cluster.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,9 @@ page_title: "Scaleway: scaleway_redis_instance"

# scaleway_redis_cluster

Gets information about a Redis cluster. For further information check our [api documentation](https://developers.scaleway.com/en/products/redis/api/v1alpha1/#clusters-a85816)
Gets information about a Redis™ cluster.

For further information refer to the Managed Database for Redis™ [API documentation](https://developers.scaleway.com/en/products/redis/api/v1alpha1/#clusters-a85816).

## Example Usage

Expand All @@ -24,10 +26,10 @@ data "scaleway_redis_cluster" "my_cluster" {
## Argument Reference

- `name` - (Optional) The name of the Redis cluster.
Only one of the `name` and `cluster_id` should be specified.

- `cluster_id` - (Optional) The Redis cluster ID.
Only one of the `name` and `cluster_id` should be specified.

-> **Note** You must specify at least one: `name` and/or `cluster_id`.

- `zone` - (Default to [provider](../index.md) `region`) The [zone](../guides/regions_and_zones.md#zones) in which the server exists.

Expand All @@ -37,6 +39,6 @@ data "scaleway_redis_cluster" "my_cluster" {

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

- `id` - The ID of the Redis cluster.
- `id` - The ID of the Redis cluster.

~> **Important:** Redis clusters' 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`
~> **Important:** Redis™ cluster 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`
6 changes: 3 additions & 3 deletions docs/data-sources/registry_image.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ page_title: "Scaleway: scaleway_registry_image"

# scaleway_registry_image

Gets information about a registry image.
Gets information about a Container Registry image.

## Example Usage

Expand All @@ -25,10 +25,10 @@ data "scaleway_registry_image" "my_image" {
## Argument Reference

- `name` - (Optional) The image name.
Only one of `name` and `image_id` should be specified.

- `image_id` - (Optional) The image ID.
Only one of `name` and `image_id` should be specified.

-> **Note** You must specify at least one: `name` and/or `image_id`.

- `namespace_id` - (Optional) The namespace ID in which the image is.

Expand Down
4 changes: 2 additions & 2 deletions docs/data-sources/registry_namespace.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,10 +24,10 @@ data "scaleway_registry_namespace" "my_namespace" {
## Argument Reference

- `name` - (Optional) The namespace name.
Only one of `name` and `namespace_id` should be specified.

- `namespace_id` - (Optional) The namespace id.
Only one of `name` and `namespace_id` should be specified.

-> **Note** You must specify at least one: `name` and/or `image_id`.

- `region` - (Defaults to [provider](../index.md#region) `region`) The [region](../guides/regions_and_zones.md#regions) in which the namespace exists.

Expand Down
26 changes: 12 additions & 14 deletions docs/resources/iam_api_key.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,7 @@ page_title: "Scaleway: scaleway_iam_api_key"

# Resource: scaleway_iam_api_key

Creates and manages Scaleway IAM API Keys. For more information, please
check [the documentation](https://www.scaleway.com/en/developers/api/iam/#api-keys-3665ae)
Creates and manages Scaleway API Keys. For more information, refer to the [IAM API documentation](https://www.scaleway.com/en/developers/api/iam/#api-keys-3665ae).

## Example Usage

Expand All @@ -25,25 +24,24 @@ resource "scaleway_iam_api_key" "main" {

The following arguments are supported:

- `description`: (Optional) The description of the iam api key.
- `application_id`: (Optional) ID of the application attached to the api key.
Only one of the `application_id` and `user_id` should be specified.
- `user_id` - (Optional) ID of the user attached to the api key.
Only one of the `application_id` and `user_id` should be specified.
- `expires_at` - (Optional) The date and time of the expiration of the iam api key. Please note that in case of change,
- `description`: (Optional) The description of the API key.
- `application_id`: (Optional) ID of the application attached to the API key.
- `user_id` - (Optional) ID of the user attached to the API key.
-> **Note** You must specify at least one: `application_id` and/or `user_id`.
- `expires_at` - (Optional) The date and time of the expiration of the IAM API key. Please note that in case of any changes,
the resource will be recreated.
- `default_project_id` - (Optional) The default project ID to use with object storage.
- `default_project_id` - (Optional) The default Project ID to use with Object Storage.

## Attributes Reference

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

- `id` - The ID of the API key, which is the access key.
- `created_at` - The date and time of the creation of the iam api key.
- `updated_at` - The date and time of the last update of the iam api key.
- `editable` - Whether the iam api key is editable.
- `access_key` - The access key of the iam api key.
- `secret_key`: The secret Key of the iam api key.
- `created_at` - The date and time of the creation of the IAM API key.
- `updated_at` - The date and time of the last update of the IAM API key.
- `editable` - Whether the IAM API key is editable.
- `access_key` - The access key of the IAM API key.
- `secret_key`: The secret Key of the IAM API key.
- `creation_ip` - The IP Address of the device which created the API key.

## Import
Expand Down
2 changes: 1 addition & 1 deletion docs/resources/iam_application.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ page_title: "Scaleway: scaleway_iam_application"

# Resource: scaleway_iam_application

Creates and manages Scaleway IAM Applications. For more information, see [the documentation](https://www.scaleway.com/en/developers/api/iam/#applications-83ce5e).
Creates and manages Scaleway IAM Applications. For more information refer to the [IAM API documentation](https://www.scaleway.com/en/developers/api/iam/#applications-83ce5e).

## Example Usage

Expand Down
2 changes: 1 addition & 1 deletion docs/resources/iam_group.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ page_title: "Scaleway: scaleway_iam_group"
# Resource: scaleway_iam_group

Creates and manages Scaleway IAM Groups.
For more information, see [the documentation](https://www.scaleway.com/en/developers/api/iam/#groups-f592eb).
For more information refer to the [IAM API documentation](https://www.scaleway.com/en/developers/api/iam/#groups-f592eb).

## Example Usage

Expand Down
4 changes: 2 additions & 2 deletions docs/resources/iam_group_membership.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ page_title: "Scaleway: scaleway_iam_group_membership"
# Resource: scaleway_iam_group_membership

Add members to an IAM group.
For more information, see [the documentation](https://www.scaleway.com/en/developers/api/iam/#groups-f592eb).
For more information refer to the [IAM API documentation](https://www.scaleway.com/en/developers/api/iam/#groups-f592eb).

## Example Usage

Expand Down Expand Up @@ -63,7 +63,7 @@ resource "scaleway_iam_group_membership" "members" {

- `user_id` - (Optional) The ID of the user that will be added to the group

- ~> Only one of `application_id` or `user_id` must be specified
-> **Note** You must specify at least one: `application_id` and/or `user_id`.

## Attributes Reference

Expand Down

0 comments on commit bfd470d

Please sign in to comment.