docs(lb): review lb doc (#2616)

* fix(lb): review lb doc * Apply suggestions from code review Co-authored-by: Yacine Fodil <[email protected]> * fix trailing spaces --------- Co-authored-by: Yacine Fodil <[email protected]> Co-authored-by: Rémy Léone <[email protected]> Co-authored-by: Yacine FODIL <[email protected]>
scaleway · Jun 17, 2024 · 5a13ed6 · 5a13ed6
1 parent cbc26ca
commit 5a13ed6
Show file tree

Hide file tree

Showing 19 changed files with 270 additions and 241 deletions.
diff --git a/docs/data-sources/lb.md b/docs/data-sources/lb.md
@@ -7,6 +7,8 @@ page_title: "Scaleway: scaleway_lb"
 
 Gets information about a Load Balancer.
 
+For more information, see the [main documentation](https://www.scaleway.com/en/docs/network/load-balancer/concepts/#load-balancers) or [API documentation](https://www.scaleway.com/en/developers/api/load-balancer/zoned-api/#path-load-balancer-list-load-balancers).
+
 ## Example Usage
 
 ```hcl
@@ -23,24 +25,24 @@ data "scaleway_lb" "by_id" {
 
 ## Argument Reference
 
-- `name` - (Optional) The load balancer name.
+- `name` - (Optional) The Load Balancer name.
 
-- `ip_id` - (Optional) The load balancer IP ID.
+- `ip_id` - (Optional) The Load Balancer IP ID.
 
-- `project_id` - (Optional) The ID of the project the LB is associated with.
+- `project_id` - (Optional) The ID of the Project the Load Balancer is associated with.
 
 ## Attributes Reference
 
 In addition to all arguments above, the following attributes are exported:
 
-- `id` - The ID of the load-balancer.
+- `id` - The ID of the Load Balancer.
 
-~> **Important:** Load-Balancers' 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:** Load Balancer 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`
 
-- `ip_address` - The load-balancer public IP Address.
+- `ip_address` - The Load Balancer public IP address.
 
-- `type` - The type of the load-balancer.
+- `type` - The Load Balancer type.
 
-- `tags` - The tags associated with the load-balancer.
+- `tags` - The tags associated with the Load Balancer.
 
-- `zone` -  (Defaults to [provider](../index.md#zone) `zone`) The [zone](../guides/regions_and_zones.md#zones) in which the LB exists.
+- `zone` -  (Defaults to [provider](../index.md#zone) `zone`) The [zone](../guides/regions_and_zones.md#zones) in which the Load Balancer exists.
diff --git a/docs/data-sources/lb_acls.md b/docs/data-sources/lb_acls.md
@@ -7,6 +7,8 @@ page_title: "Scaleway: scaleway_lb_acls"
 
 Gets information about multiple Load Balancer ACLs.
 
+For more information, see the [main documentation](https://www.scaleway.com/en/docs/network/load-balancer/reference-content/acls/) or [API reference](https://www.scaleway.com/en/developers/api/load-balancer/zoned-api/#path-acls-get-an-acl).
+
 ## Example Usage
 
 ```hcl
@@ -23,33 +25,33 @@ data "scaleway_lb_acls" "byFrontID_and_name" {
 
 ## Argument Reference
 
-- `frontend_id` - (Required) The frontend ID this ACL is attached to. ACLs with a frontend ID like it are listed.
-  ~> **Important:** LB Frontends' 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`
+- `frontend_id` - (Required) The frontend ID this ACL is attached to. ACLs with a matching frontend ID are listed.
+  ~> **Important:** LB frontend 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`
 
-- `name` - (Optional) The ACL name used as filter. ACLs with a name like it are listed.
+- `name` - (Optional) The ACL name to filter for. ACLs with a matching name are listed.
 
-- `zone` - (Defaults to [provider](../index.md#zone) `zone`) The [zone](../guides/regions_and_zones.md#zones) in which ACLs exist.
+- `zone` - (Defaults to [provider](../index.md#zone) `zone`) The [zone](../guides/regions_and_zones.md#zones) in which the ACLs exist.
 
 ## Attributes Reference
 
 In addition to all arguments above, the following attributes are exported:
 
-- `acls` - List of found ACLs
+- `acls` - List of retrieved ACLs
     - `id` - The associated ACL ID.
       ~> **Important:** LB ACLs' 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`
-    - `created_at` - The date at which the ACL was created (RFC 3339 format).
-    - `update_at` - The date at which the ACL was last updated (RFC 3339 format).
-    - `index` - The order between the ACLs.
+    - `created_at` - The date on which the ACL was created (RFC 3339 format).
+    - `update_at` - The date on which the ACL was last updated (RFC 3339 format).
+    - `index` - The priority of this ACL in the ordered list.
     - `description` - The description of the ACL resource.
-    - `action` - The action that has been undertaken when an ACL filter had matched.
+    - `action` - The action to be undertaken when an ACL filter matches.
         - `type` - The action type.
         - `redirect` - Redirect parameters when using an ACL with `redirect` action.
             - `type`  - The redirect type.
-            - `target`  - The URL used in case of a location redirect or the scheme name that replaces the request's original scheme.
-            - `code`  - The HTTP redirect code used.
+            - `target`  - The URL used in case of a location redirect, or the scheme name that replaces the request's original scheme.
+            - `code`  - The HTTP redirect code to use.
     - `match` - The ACL match rule.
-        - `ip_subnet` - A list of matched IPs or CIDR v4/v6 addresses of the client of the session.
-        - `http_filter` - The matched HTTP filter.
-        - `http_filter_value` - The possible values matched for a given HTTP filter.
+        - `ip_subnet` - A list of IPs, or CIDR v4/v6 addresses of the session client, to match.
+        - `http_filter` - The HTTP filter to match.
+        - `http_filter_value` - The possible values to match for a given HTTP filter.
         - `http_filter_option` - A list of possible values for the HTTP filter based on the HTTP header.
         - `invert` -  The condition will be of type "unless" if invert is set to `true`
diff --git a/docs/data-sources/lb_backend.md b/docs/data-sources/lb_backend.md
@@ -5,8 +5,9 @@ page_title: "Scaleway: scaleway_lb_backend"
 
 # scaleway_lb_backend
 
-Get information about Scaleway Load-Balancer Backends.
-For more information, see [the documentation](https://www.scaleway.com/en/developers/api/load-balancer/zoned-api/#path-backends).
+Get information about Scaleway Load Balancer backends.
+
+For more information, see the [main documentation](https://www.scaleway.com/en/docs/network/load-balancer/reference-content/configuring-backends/) or [API documentation](https://www.scaleway.com/en/developers/api/load-balancer/zoned-api/#path-backends).
 
 ## Example Usage
 
@@ -41,14 +42,14 @@ data "scaleway_lb_backend" "byName" {
 
 The following arguments are supported:
 
-- `backend_id` - (Optional) The backend id.
+- `backend_id` - (Optional) The backend ID.
     - Only one of `name` and `backend_id` should be specified.
 
 - `name` - (Optional) The name of the backend.
-    - When using the `name` you should specify the `lb-id`
+    - When using `name` you should specify the `lb-id`
 
-- `lb_id` - (Required) The load-balancer ID this backend is attached to.
+- `lb_id` - (Required) Load Balancer ID this backend is attached to.
 
 ## Attributes Reference
 
-See the [LB Backend Resource](../resources/lb_backend.md) for details on the returned attributes - they are identical.
+See the [Load Balancer backend resource](../resources/lb_backend.md) for details on the returned attributes - they are identical.
diff --git a/docs/data-sources/lb_backends.md b/docs/data-sources/lb_backends.md
@@ -7,6 +7,8 @@ page_title: "Scaleway: scaleway_lb_backends"
 
 Gets information about multiple Load Balancer Backends.
 
+For more information, see the [main documentation](https://www.scaleway.com/en/docs/network/load-balancer/reference-content/configuring-backends/) or [API documentation](https://www.scaleway.com/en/developers/api/load-balancer/zoned-api/#path-backends).
+
 ## Example Usage
 
 ```hcl
@@ -23,22 +25,22 @@ data "scaleway_lb_backends" "byLBID_and_name" {
 
 ## Argument Reference
 
-- `lb_id` - (Required) The load-balancer ID this backend is attached to. backends with a LB ID like it are listed.
+- `lb_id` - (Required) The Load Balancer ID this backend is attached to. Backends with a matching ID are listed.
 
-- `name` - (Optional) The backend name used as filter. Backends with a name like it are listed.
+- `name` - (Optional) The backend name to filter for. Backends with a matching name are listed.
 
 - `zone` - (Defaults to [provider](../index.md#zone) `zone`) The [zone](../guides/regions_and_zones.md#zones) in which backends exist.
 
 ## Attributes Reference
 
 In addition to all arguments above, the following attributes are exported:
 
-- `backends` - List of found backends
+- `backends` - List of retrieved backends
     - `id` - The associated backend ID.
     - `forward_protocol` - Backend protocol.
-    - `created_at` - The date at which the backend was created (RFC 3339 format).
-    - `update_at` - The date at which the backend was last updated (RFC 3339 format).
-    - `forward_port` - User sessions will be forwarded to this port of backend servers.
+    - `created_at` - The date on which the backend was created (RFC 3339 format).
+    - `update_at` - The date on which the backend was last updated (RFC 3339 format).
+    - `forward_port` - User sessions will be forwarded to this backend server port.
     - `forward_port_algorithm` - Load balancing algorithm.
     - `sticky_sessions` - Enables cookie-based session persistence.
     - `sticky_sessions_cookie_name` - Cookie name for sticky sessions.
@@ -47,23 +49,23 @@ In addition to all arguments above, the following attributes are exported:
     - `timeout_server` - Maximum server connection inactivity time.
     - `timeout_connect` - Maximum initial server connection establishment time.
     - `timeout_tunnel` - Maximum tunnel inactivity time.
-    - `failover_host` - Scaleway S3 bucket website to be served in case all backend servers are down.
-    - `ssl_bridging` - Enables SSL between load balancer and backend servers.
+    - `failover_host` - Scaleway S3 bucket website to be served if all backend servers are down.
+    - `ssl_bridging` - Enables SSL between Load Balancer and backend servers.
     - `ignore_ssl_server_verify` - Specifies whether the Load Balancer should check the backend server’s certificate before initiating a connection.
-    - `health_check_timeout` - Timeout before we consider a HC request failed.
-    - `health_check_delay` - Interval between two HC requests.
-    - `health_check_port` - Port the HC requests will be sent to.
-    - `health_check_max_retries` - Number of allowed failed HC requests before the backend server is marked down.
-    - `health_check_tcp` - This block enable TCP health check.
-    - `health_check_http` - This block enable HTTP health check.
-        - `uri` - The HTTP endpoint URL to call for HC requests.
-        - `method` - The HTTP method to use for HC requests.
+    - `health_check_timeout` - Timeout before a health check request is considered failed.
+    - `health_check_delay` - Interval between two health check requests.
+    - `health_check_port` - Port the health check requests will be sent to.
+    - `health_check_max_retries` - Number of allowed failed health check requests before the backend server is marked as down.
+    - `health_check_tcp` - This block enables TCP health checks.
+    - `health_check_http` - This block enables HTTP health checks.
+        - `uri` - The HTTP endpoint URL to call for health check requests.
+        - `method` - The HTTP method to use for health check requests.
         - `code` - The expected HTTP status code.
-        - `host_header` -  The HTTP host header to use for HC requests.
-    - `health_check_https` - This block enable HTTPS health check.
-        - `uri` - The HTTPS endpoint URL to call for HC requests.
-        - `method` - The HTTP method to use for HC requests.
+        - `host_header` -  The HTTP host header to use for health check requests.
+    - `health_check_https` - This block enables HTTPS health checks.
+        - `uri` - The HTTPS endpoint URL to call for health check requests.
+        - `method` - The HTTP method to use for health check requests.
         - `code` - The expected HTTP status code.
-        - `host_header` - The HTTP host header to use for HC requests.
+        - `host_header` - The HTTP host header to use for health check requests.
         - `sni` - The SNI to use for HC requests over SSL.
     - `on_marked_down_action` - Modify what occurs when a backend server is marked down.
diff --git a/docs/data-sources/lb_certificate.md b/docs/data-sources/lb_certificate.md
@@ -5,11 +5,11 @@ page_title: "Scaleway: scaleway_lb_certificate"
 
 # scaleway_lb_certificate
 
-Get information about Scaleway Load-Balancer Certificates.
+Get information about Scaleway Load Balancer certificates.
 
-This data source can prove useful when a module accepts an LB Certificate as an input variable and needs to, for example, determine the security of a certificate for your LB Frontend associated with your domain, etc.
+This data source can prove useful when a module accepts a Load Balancer certificate as an input variable and needs to, for example, determine the security of a certificate for the frontend associated with your domain.
 
-For more information, see [the documentation](https://www.scaleway.com/en/developers/api/load-balancer/zoned-api/#path-certificate).
+For more information, see the [main documentation](https://www.scaleway.com/en/docs/network/load-balancer/how-to/add-certificate/) or [API documentation](https://www.scaleway.com/en/developers/api/load-balancer/zoned-api/#path-certificate).
 
 ## Examples
 
@@ -47,14 +47,14 @@ data "scaleway_lb_certificate" "byName" {
 
 The following arguments are supported:
 
-- `certificate_id` - (Optional) The certificate id.
+- `certificate_id` - (Optional) The certificate ID.
     - Only one of `name` and `certificate_id` should be specified.
 
-- `name` - (Optional) The name of the certificate backend.
+- `name` - (Optional) The name of the Load Balancer certificate.
     - When using a certificate `name` you should specify the `lb-id`
 
-- `lb_id` - (Required) The load-balancer ID this certificate is attached to.
+- `lb_id` - (Required) The Load Balancer ID this certificate is attached to.
 
 ## Attributes Reference
 
-See the [LB Certificate Resource](../resources/lb_certificate.md) for details on the returned attributes - they are identical.
+See the [Load Balancer certificate resource](../resources/lb_certificate.md) for details on the returned attributes - they are identical.
diff --git a/docs/data-sources/lb_frontend.md b/docs/data-sources/lb_frontend.md
@@ -5,8 +5,9 @@ page_title: "Scaleway: scaleway_lb_frontend"
 
 # scaleway_lb_frontend
 
-Get information about Scaleway Load-Balancer Frontends.
-For more information, see [the documentation](https://www.scaleway.com/en/developers/api/load-balancer/zoned-api/#path-frontends).
+Get information about Scaleway Load Balancer frontends.
+
+For more information, see the [main documentation](https://www.scaleway.com/en/docs/network/load-balancer/reference-content/configuring-frontends/) or [API documentation](https://www.scaleway.com/en/developers/api/load-balancer/zoned-api/#path-frontends).
 
 ## Example Usage
 
@@ -43,14 +44,14 @@ data "scaleway_lb_frontend" "byName" {
 
 The following arguments are supported:
 
-- `frontend_id` - (Optional) The frontend id.
+- `frontend_id` - (Optional) The frontend ID.
     - Only one of `name` and `frontend_id` should be specified.
 
 - `name` - (Optional) The name of the frontend.
     - When using the `name` you should specify the `lb-id`
 
-- `lb_id` - (Required) The load-balancer ID this frontend is attached to.
+- `lb_id` - (Required) The Load Balancer ID this frontend is attached to.
 
 ## Attributes Reference
 
-See the [LB Frontend Resource](../resources/lb_frontend.md) for details on the returned attributes - they are identical.
+See the [Load Balancer frontend resource](../resources/lb_frontend.md) for details on the returned attributes - they are identical.
diff --git a/docs/data-sources/lb_frontends.md b/docs/data-sources/lb_frontends.md
@@ -5,7 +5,9 @@ page_title: "Scaleway: scaleway_lb_frontends"
 
 # scaleway_lb_frontends
 
-Gets information about multiple Load Balancer Frontends.
+Gets information about multiple Load Balancer frontends.
+
+For more information, see the [main documentation](https://www.scaleway.com/en/docs/network/load-balancer/reference-content/configuring-frontends/) or [API documentation](https://www.scaleway.com/en/developers/api/load-balancer/zoned-api/#path-frontends).
 
 ## Example Usage
 
@@ -23,24 +25,24 @@ data "scaleway_lb_frontends" "byLBID_and_name" {
 
 ## Argument Reference
 
-- `lb_id` - (Required) The load-balancer ID this frontend is attached to. frontends with a LB ID like it are listed.
+- `lb_id` - (Required) The Load Balancer ID this frontend is attached to. Frontends with a matching ID are listed.
 
-- `name` - (Optional) The frontend name used as filter. Frontends with a name like it are listed.
+- `name` - (Optional) The frontend name to filter for. Frontends with a matching name are listed.
 
-- `zone` - (Defaults to [provider](../index.md#zone) `zone`) The [zone](../guides/regions_and_zones.md#zones) in which frontends exist.
+- `zone` - (Defaults to [provider](../index.md#zone) `zone`) The [zone](../guides/regions_and_zones.md#zones) in which the frontends exist.
 
 ## Attributes Reference
 
 In addition to all arguments above, the following attributes are exported:
 
-- `frontends` - List of found frontends
-    - `id` - The associated frontend ID.
-        ~> **Important:** LB frontends' 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`
-    - `inbound_port` - TCP port the frontend listen to.
-    - `created_at` - The date at which the frontend was created (RFC 3339 format).
-    - `update_at` - The date at which the frontend was last updated (RFC 3339 format).
-    - `backend_id` - The load-balancer backend ID this frontend is attached to.
-         ~> **Important:** LB backends' 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`
+- `frontends` - List of retrieved frontends
+    - `id` - The ID of the associated frontend.
+        ~> **Important:** LB frontend 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`
+    - `inbound_port` - TCP port the frontend listens to.
+    - `created_at` - The date on which the frontend was created (RFC 3339 format).
+    - `update_at` - The date aont which the frontend was last updated (RFC 3339 format).
+    - `backend_id` - The Load Balancer backend ID this frontend is attached to.
+         ~> **Important:** Load Balancer backend 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`
     - `timeout_client` - Maximum inactivity time on the client side.
-    - `certificate_ids` - List of Certificate IDs that are used by the frontend.
-    - `enable_http3` - If HTTP/3 protocol is activated.
+    - `certificate_ids` - List of certificate IDs that are used by the frontend.
+    - `enable_http3` - Whether HTTP/3 protocol is activated.