Regenerate documentation

We also now use https://github.com/hashicorp/terraform-plugin-docs as
suggested by the Terraform documentation.

.pre-commit-config.yaml

@@ -5,7 +5,13 @@ repos:
     hooks:
       - id: check-toml
       - id: end-of-file-fixer
+        # Files in this directory are generated by
+        # https://github.com/hashicorp/terraform-plugin-docs
+        exclude: ^docs/
       - id: trailing-whitespace
+        # Files in this directory are generated by
+        # https://github.com/hashicorp/terraform-plugin-docs
+        exclude: ^docs/
       - id: check-merge-conflict
 
   - repo: https://github.com/dnephin/pre-commit-golang
@@ -25,6 +31,9 @@ repos:
     hooks:
       - id: prettier
         types_or: [yaml, toml, markdown]
+        # Files in this directory are generated by
+        # https://github.com/hashicorp/terraform-plugin-docs
+        exclude: ^docs/
         additional_dependencies:
           - [email protected]
           - [email protected]

README.md

@@ -142,6 +142,14 @@ Then in the repo root dir
 pre-commit install
 ```
 
+### Generating documentation
+
+As suggested by the [Terraform
+documentation](https://www.terraform.io/docs/registry/providers/docs.html#generating-documentation),
+we use the
+[tfplugindocs](https://github.com/hashicorp/terraform-plugin-docs)
+project to generate the provider documentation.
+
 ## Adding Dependencies
 
 This provider uses [Go modules](https://github.com/golang/go/wiki/Modules).

docs/data-sources/domain.md

@@ -1,20 +1,30 @@
-# Data Source: domain
+---
+# generated by https://github.com/hashicorp/terraform-plugin-docs
+page_title: "gandi_domain Data Source - terraform-provider-gandi"
+subcategory: ""
+description: |-
+  
+---
 
-Use this data source to get the ID of a domain for other resources.
+# gandi_domain (Data Source)
 
-## Example Usage
 
-```terraform
-data "gandi_domain" "my_domain" {
-    name = "my.domain"
-}
-```
 
-## Argument Reference
 
-- `name` - (Required) The FQDN of the domain.
 
-## Attribute Reference
+<!-- schema generated by tfplugindocs -->
+## Schema
+
+### Required
+
+- **name** (String) The FQDN of the domain
+
+### Optional
+
+- **id** (String) The ID of this resource.
+
+### Read-Only
+
+- **nameservers** (List of String) A list of nameservers for the domain
+
 
-- `id` - The ID of the domain.
-- `nameservers` - A list of nameservers for the domain.

docs/data-sources/livedns_domain.md

@@ -1,19 +1,26 @@
-# Data Source: livedns_domain
+---
+# generated by https://github.com/hashicorp/terraform-plugin-docs
+page_title: "gandi_livedns_domain Data Source - terraform-provider-gandi"
+subcategory: ""
+description: |-
+  
+---
 
-Use this data source to get the ID of a domain for other resources.
+# gandi_livedns_domain (Data Source)
 
-## Example Usage
 
-```terraform
-data "gandi_livedns_domain" "my_domain" {
-    name = "my.domain"
-}
-```
 
-## Argument Reference
 
-- `name` - (Required) The FQDN of the domain.
 
-## Attribute Reference
+<!-- schema generated by tfplugindocs -->
+## Schema
+
+### Required
+
+- **name** (String) The FQDN of the domain
+
+### Optional
+
+- **id** (String) The ID of this resource.
+
 
-- `id` - The ID of the domain.

docs/data-sources/livedns_domain_ns.md

@@ -0,0 +1,30 @@
+---
+# generated by https://github.com/hashicorp/terraform-plugin-docs
+page_title: "gandi_livedns_domain_ns Data Source - terraform-provider-gandi"
+subcategory: ""
+description: |-
+  
+---
+
+# gandi_livedns_domain_ns (Data Source)
+
+
+
+
+
+<!-- schema generated by tfplugindocs -->
+## Schema
+
+### Required
+
+- **name** (String) The FQDN of the domain
+
+### Optional
+
+- **id** (String) The ID of this resource.
+
+### Read-Only
+
+- **nameservers** (List of String) A list of nameservers for the domain
+
+

docs/data-sources/mailbox.md

@@ -0,0 +1,27 @@
+---
+# generated by https://github.com/hashicorp/terraform-plugin-docs
+page_title: "gandi_mailbox Data Source - terraform-provider-gandi"
+subcategory: ""
+description: |-
+  
+---
+
+# gandi_mailbox (Data Source)
+
+
+
+
+
+<!-- schema generated by tfplugindocs -->
+## Schema
+
+### Required
+
+- **domain** (String) Domain name
+- **mailbox_id** (String) Mailbox ID
+
+### Optional
+
+- **id** (String) The ID of this resource.
+
+

docs/index.md

@@ -1,6 +1,11 @@
 # Gandi Provider
 
-The Gandi provider enables the purchasing and management of domain names through the [Gandi domain registrar](https://gandi.net). It also supports management of DNS hosting through the LiveDNS service.
+The Gandi provider enables the purchasing and management of the
+following Gandi resources:
+- [DNS zones](https://api.gandi.net/docs/domains/)
+- [LiveDNS service](https://api.gandi.net/docs/livedns/)
+- [Email](https://api.gandi.net/docs/email/)
+- [SimpleHosting](https://api.gandi.net/docs/simplehosting/)
 
 The provider needs to be configured with the proper credentials before it can be used.
 

docs/resources/dnssec_key.md

@@ -1,33 +1,29 @@
-# Resource: dnssec_key
+---
+# generated by https://github.com/hashicorp/terraform-plugin-docs
+page_title: "gandi_dnssec_key Resource - terraform-provider-gandi"
+subcategory: ""
+description: |-
+  
+---
 
-The `dnssec_key` resource creates a DNSSEC key to a domain.
+# gandi_dnssec_key (Resource)
 
-## Example Usage
 
-```terraform
-resource "gandi_dnssec_key" "my_key" {
-    domain = "example.com"
-    algorithm = 15
-    type = "ksk"
-    public_key = "Z6eCbfmpYPYmOJ0PYKq8fKzxcP3K/xEBlF5omvO+UwY="
-}
-```
 
-## Argument Reference
 
-- `domain` - (Required) The domain to add the key to.
-- `name` - (Required) The algorithm used for the key.
-- `type` - (Required) "ksk" or "zsk".
-- `public_key` - (Required) The public key to use.
 
-## Attribute Reference
+<!-- schema generated by tfplugindocs -->
+## Schema
 
-- `digest` - Digest of the added key.
-- `digest_type` - Type of digest.
-- `keytag` - The keytag assigned by the server.
+### Required
 
-## Import
+- **algorithm** (Number) DNSSEC algorithm type
+- **domain** (String) Domain name
+- **public_key** (String) DNSSEC public key
+- **type** (String) DNSSEC key type
+
+### Optional
+
+- **id** (String) The ID of this resource.
 
-Existing keys can be imported by running:
 
-`terraform import gandi_dnssec_key.my_key example.com/<id>`, where the key ID is a UUID that can be found through querying the [Gandi API](https://api.gandi.net/docs/domains/#get-v5-domain-domains-domain-dnskeys)