docs: generate documentation

aminueza · Jul 30, 2024 · 250a5c2 · 250a5c2
1 parent bf89782
commit 250a5c2
Show file tree

Hide file tree

Showing 15 changed files with 40 additions and 33 deletions.
diff --git a/docs/data-sources/s3_object.md b/docs/data-sources/s3_object.md
@@ -10,7 +10,14 @@ description: |-
 
 
 
-
+## Example Usage
+
+```terraform
+data "minio_s3_object" "document" {
+  object_name = "document.txt"
+  bucket_name = "documents-bucket"
+}
+```
 
 <!-- schema generated by tfplugindocs -->
 ## Schema

diff --git a/docs/resources/iam_group.md b/docs/resources/iam_group.md
@@ -27,7 +27,7 @@ output "minio_user_group" {
 
 ### Required
 
-- `name` (String)
+- `name` (String) Name of the group
 
 ### Optional
 
@@ -36,5 +36,5 @@ output "minio_user_group" {
 
 ### Read-Only
 
-- `group_name` (String)
+- `group_name` (String) The name of the group.
 - `id` (String) The ID of this resource.
diff --git a/docs/resources/iam_group_policy.md b/docs/resources/iam_group_policy.md
@@ -54,13 +54,13 @@ output "minio_group" {
 
 ### Required
 
-- `group` (String)
-- `policy` (String)
+- `group` (String) Name of group the policy belongs to.
+- `policy` (String) Policy JSON string
 
 ### Optional
 
-- `name` (String)
-- `name_prefix` (String)
+- `name` (String) Name of the policy. If omitted, Terraform will assign a random, unique name.
+- `name_prefix` (String) Prefix to the generated policy name. Do not use with `name`.
 
 ### Read-Only
 

diff --git a/docs/resources/iam_group_policy_attachment.md b/docs/resources/iam_group_policy_attachment.md
@@ -66,8 +66,8 @@ resource "minio_iam_group_policy_attachment" "developer" {
 
 ### Required
 
-- `group_name` (String)
-- `policy_name` (String)
+- `group_name` (String) Name of group to attach policy to
+- `policy_name` (String) Name of policy to attach to group
 
 ### Read-Only
 

diff --git a/docs/resources/iam_group_user_attachment.md b/docs/resources/iam_group_user_attachment.md
@@ -43,8 +43,8 @@ output "minio_group" {
 
 ### Required
 
-- `group_name` (String)
-- `user_name` (String)
+- `group_name` (String) Name of group to attach user to
+- `user_name` (String) Name of user
 
 ### Read-Only
 

diff --git a/docs/resources/iam_policy.md b/docs/resources/iam_policy.md
@@ -45,12 +45,12 @@ output "minio_policy" {
 
 ### Required
 
-- `policy` (String)
+- `policy` (String) Policy JSON string
 
 ### Optional
 
-- `name` (String)
-- `name_prefix` (String)
+- `name` (String) Name of the policy. Conflicts with `name_prefix`.
+- `name_prefix` (String) Prefix to the generated policy name. Do not use with `name`.
 
 ### Read-Only
 

diff --git a/docs/resources/iam_service_account.md b/docs/resources/iam_service_account.md
@@ -40,17 +40,17 @@ output "minio_password" {
 
 ### Required
 
-- `target_user` (String)
+- `target_user` (String) User the service account will be created for
 
 ### Optional
 
 - `disable_user` (Boolean) Disable service account
-- `policy` (String) policy of service account
+- `policy` (String) policy of service account as encoded JSON string
 - `update_secret` (Boolean) rotate secret key
 
 ### Read-Only
 
-- `access_key` (String)
+- `access_key` (String) access key of service account
 - `id` (String) The ID of this resource.
-- `secret_key` (String, Sensitive)
+- `secret_key` (String, Sensitive) secret key of service account
 - `status` (String)
diff --git a/docs/resources/iam_user.md b/docs/resources/iam_user.md
@@ -39,7 +39,7 @@ output "secret" {
 
 ### Required
 
-- `name` (String)
+- `name` (String) Name of the user
 
 ### Optional
 

diff --git a/docs/resources/iam_user_policy_attachment.md b/docs/resources/iam_user_policy_attachment.md
@@ -65,8 +65,8 @@ resource "minio_iam_user_policy_attachment" "developer" {
 
 ### Required
 
-- `policy_name` (String)
-- `user_name` (String)
+- `policy_name` (String) Name of policy to attach to user
+- `user_name` (String) Name of user
 
 ### Read-Only
 

diff --git a/docs/resources/kms_key.md b/docs/resources/kms_key.md
@@ -17,7 +17,7 @@ description: |-
 
 ### Required
 
-- `key_id` (String)
+- `key_id` (String) KMS key ID
 
 ### Read-Only
 

diff --git a/docs/resources/s3_bucket.md b/docs/resources/s3_bucket.md
@@ -37,10 +37,10 @@ output "minio_url" {
 - `bucket_prefix` (String) Prefix of the bucket
 - `force_destroy` (Boolean) Force destroy the bucket (default: false)
 - `object_locking` (Boolean) Enable object locking for the bucket (default: false)
-- `quota` (Number)
+- `quota` (Number) Quota of the bucket
 
 ### Read-Only
 
-- `arn` (String)
-- `bucket_domain_name` (String)
+- `arn` (String) ARN of the bucket
+- `bucket_domain_name` (String) The bucket domain name
 - `id` (String) The ID of this resource.
diff --git a/docs/resources/s3_bucket_policy.md b/docs/resources/s3_bucket_policy.md
@@ -17,8 +17,8 @@ description: |-
 
 ### Required
 
-- `bucket` (String)
-- `policy` (String)
+- `bucket` (String) Name of the bucket
+- `policy` (String) Policy JSON string
 
 ### Read-Only
 

diff --git a/docs/resources/s3_bucket_server_side_encryption.md b/docs/resources/s3_bucket_server_side_encryption.md
@@ -17,9 +17,9 @@ description: |-
 
 ### Required
 
-- `bucket` (String)
-- `encryption_type` (String)
-- `kms_key_id` (String)
+- `bucket` (String) Name of the bucket on which to setup server side encryption
+- `encryption_type` (String) Server side encryption type
+- `kms_key_id` (String) KMS key id to use for server side encryption
 
 ### Read-Only
 

diff --git a/docs/resources/s3_bucket_versioning.md b/docs/resources/s3_bucket_versioning.md
@@ -17,7 +17,7 @@ description: |-
 
 ### Required
 
-- `bucket` (String)
+- `bucket` (String) Name of the bucket
 - `versioning_configuration` (Block List, Min: 1, Max: 1) (see [below for nested schema](#nestedblock--versioning_configuration))
 
 ### Read-Only

diff --git a/docs/resources/s3_object.md b/docs/resources/s3_object.md
@@ -44,9 +44,9 @@ output "minio_id" {
 - `content` (String) Content of the object as a string. Use only one of content, content_base64, or source
 - `content_base64` (String) Base64-encoded content of the object. Use only one of content, content_base64, or source
 - `content_type` (String) Content type of the object, in the form of a MIME type
-- `etag` (String)
+- `etag` (String) ETag of the object
 - `source` (String) Path to the file that will be uploaded. Use only one of content, content_base64, or source
-- `version_id` (String)
+- `version_id` (String) Version ID of the object
 
 ### Read-Only