* fix doc by using templates (#1105)

Co-authored-by: Austin Gebauer <34121980+austingebauer@users.noreply.github.com>
hashicorp · Sep 27, 2024 · 30cf454 · 30cf454
1 parent 4ed1822
commit 30cf454
Show file tree

Hide file tree

Showing 12 changed files with 132 additions and 18 deletions.
diff --git a/docs/resources/vault_secrets_dynamic_secret.md b/docs/resources/vault_secrets_dynamic_secret.md
@@ -1,7 +1,6 @@
 ---
-# generated by https://github.com/hashicorp/terraform-plugin-docs
-page_title: "hcp_vault_secrets_dynamic_secret Resource - terraform-provider-hcp"
-subcategory: ""
+page_title: "Resource hcp_vault_secrets_dynamic_secret - terraform-provider-hcp"
+subcategory: "HCP Vault Secrets"
 description: |-
   The Vault Secrets dynamic secret resource manages a dynamic secret configuration.
 ---

diff --git a/docs/resources/vault_secrets_integration_aws.md b/docs/resources/vault_secrets_integration_aws.md
@@ -1,7 +1,6 @@
 ---
-# generated by https://github.com/hashicorp/terraform-plugin-docs
-page_title: "hcp_vault_secrets_integration_aws Resource - terraform-provider-hcp"
-subcategory: ""
+page_title: "Resource hcp_vault_secrets_integration_aws - terraform-provider-hcp"
+subcategory: "HCP Vault Secrets"
 description: |-
   The Vault Secrets AWS integration resource manages an AWS integration.
 ---

diff --git a/docs/resources/vault_secrets_integration_gcp.md b/docs/resources/vault_secrets_integration_gcp.md
@@ -1,7 +1,6 @@
 ---
-# generated by https://github.com/hashicorp/terraform-plugin-docs
-page_title: "hcp_vault_secrets_integration_gcp Resource - terraform-provider-hcp"
-subcategory: ""
+page_title: "Resource hcp_vault_secrets_integration_gcp - terraform-provider-hcp"
+subcategory: "HCP Vault Secrets"
 description: |-
   The Vault Secrets GCP integration resource manages an GCP integration.
 ---

diff --git a/docs/resources/vault_secrets_integration_mongodbatlas.md b/docs/resources/vault_secrets_integration_mongodbatlas.md
@@ -1,7 +1,6 @@
 ---
-# generated by https://github.com/hashicorp/terraform-plugin-docs
-page_title: "hcp_vault_secrets_integration_mongodbatlas Resource - terraform-provider-hcp"
-subcategory: ""
+page_title: "Resource hcp_vault_secrets_integration_mongodbatlas - terraform-provider-hcp"
+subcategory: "HCP Vault Secrets"
 description: |-
   The Vault Secrets MongoDB Atlas integration resource manages an MongoDB Atlas integration.
 ---

diff --git a/docs/resources/vault_secrets_integration_twilio.md b/docs/resources/vault_secrets_integration_twilio.md
@@ -1,7 +1,6 @@
 ---
-# generated by https://github.com/hashicorp/terraform-plugin-docs
-page_title: "hcp_vault_secrets_integration_twilio Resource - terraform-provider-hcp"
-subcategory: ""
+page_title: "Resource hcp_vault_secrets_integration_twilio - terraform-provider-hcp"
+subcategory: "HCP Vault Secrets"
 description: |-
   The Vault Secrets Twilio integration resource manages a Twilio integration.
 ---

diff --git a/docs/resources/vault_secrets_rotating_secret.md b/docs/resources/vault_secrets_rotating_secret.md
@@ -1,7 +1,6 @@
 ---
-# generated by https://github.com/hashicorp/terraform-plugin-docs
-page_title: "hcp_vault_secrets_rotating_secret Resource - terraform-provider-hcp"
-subcategory: ""
+page_title: "Resource hcp_vault_secrets_rotating_secret - terraform-provider-hcp"
+subcategory: "HCP Vault Secrets"
 description: |-
   The Vault Secrets rotating secret resource manages a rotating secret configuration.
 ---

diff --git a/templates/resources/vault_secrets_dynamic_secret.md.tmpl b/templates/resources/vault_secrets_dynamic_secret.md.tmpl
@@ -0,0 +1,16 @@
+---
+page_title: "{{.Type}} {{.Name}} - {{.ProviderName}}"
+subcategory: "HCP Vault Secrets"
+description: |-
+{{ .Description | plainmarkdown | trimspace | prefixlines "  " }}
+---
+
+# {{.Name}} ({{.Type}})
+
+{{ .Description | trimspace }}
+
+## Example Usage
+
+{{ tffile "examples/resources/hcp_vault_secrets_dynamic_secret/resource.tf" }}
+
+{{ .SchemaMarkdown | trimspace }}
diff --git a/templates/resources/vault_secrets_integration_aws.md.tmpl b/templates/resources/vault_secrets_integration_aws.md.tmpl
@@ -0,0 +1,22 @@
+---
+page_title: "{{.Type}} {{.Name}} - {{.ProviderName}}"
+subcategory: "HCP Vault Secrets"
+description: |-
+{{ .Description | plainmarkdown | trimspace | prefixlines "  " }}
+---
+
+# {{.Name}} ({{.Type}})
+
+{{ .Description | trimspace }}
+
+## Example Usage
+
+{{ tffile "examples/resources/hcp_vault_secrets_integration_aws/resource.tf" }}
+
+{{ .SchemaMarkdown | trimspace }}
+
+## Import
+
+Import is supported using the following syntax:
+
+{{ codefile "shell" "examples/resources/hcp_vault_secrets_integration_aws/import.sh" }}
diff --git a/templates/resources/vault_secrets_integration_gcp.md.tmpl b/templates/resources/vault_secrets_integration_gcp.md.tmpl
@@ -0,0 +1,22 @@
+---
+page_title: "{{.Type}} {{.Name}} - {{.ProviderName}}"
+subcategory: "HCP Vault Secrets"
+description: |-
+{{ .Description | plainmarkdown | trimspace | prefixlines "  " }}
+---
+
+# {{.Name}} ({{.Type}})
+
+{{ .Description | trimspace }}
+
+## Example Usage
+
+{{ tffile "examples/resources/hcp_vault_secrets_integration_gcp/resource.tf" }}
+
+{{ .SchemaMarkdown | trimspace }}
+
+## Import
+
+Import is supported using the following syntax:
+
+{{ codefile "shell" "examples/resources/hcp_vault_secrets_integration_gcp/import.sh" }}
diff --git a/templates/resources/vault_secrets_integration_mongodbatlas.md.tmpl b/templates/resources/vault_secrets_integration_mongodbatlas.md.tmpl
@@ -0,0 +1,22 @@
+---
+page_title: "{{.Type}} {{.Name}} - {{.ProviderName}}"
+subcategory: "HCP Vault Secrets"
+description: |-
+{{ .Description | plainmarkdown | trimspace | prefixlines "  " }}
+---
+
+# {{.Name}} ({{.Type}})
+
+{{ .Description | trimspace }}
+
+## Example Usage
+
+{{ tffile "examples/resources/hcp_vault_secrets_integration_mongodbatlas/resource.tf" }}
+
+{{ .SchemaMarkdown | trimspace }}
+
+## Import
+
+Import is supported using the following syntax:
+
+{{ codefile "shell" "examples/resources/hcp_vault_secrets_integration_mongodbatlas/import.sh" }}
diff --git a/templates/resources/vault_secrets_integration_twilio.md.tmpl b/templates/resources/vault_secrets_integration_twilio.md.tmpl
@@ -0,0 +1,22 @@
+---
+page_title: "{{.Type}} {{.Name}} - {{.ProviderName}}"
+subcategory: "HCP Vault Secrets"
+description: |-
+{{ .Description | plainmarkdown | trimspace | prefixlines "  " }}
+---
+
+# {{.Name}} ({{.Type}})
+
+{{ .Description | trimspace }}
+
+## Example Usage
+
+{{ tffile "examples/resources/hcp_vault_secrets_integration_twilio/resource.tf" }}
+
+{{ .SchemaMarkdown | trimspace }}
+
+## Import
+
+Import is supported using the following syntax:
+
+{{ codefile "shell" "examples/resources/hcp_vault_secrets_integration_twilio/import.sh" }}
diff --git a/templates/resources/vault_secrets_rotating_secret.md.tmpl b/templates/resources/vault_secrets_rotating_secret.md.tmpl
@@ -0,0 +1,16 @@
+---
+page_title: "{{.Type}} {{.Name}} - {{.ProviderName}}"
+subcategory: "HCP Vault Secrets"
+description: |-
+{{ .Description | plainmarkdown | trimspace | prefixlines "  " }}
+---
+
+# {{.Name}} ({{.Type}})
+
+{{ .Description | trimspace }}
+
+## Example Usage
+
+{{ tffile "examples/resources/hcp_vault_secrets_rotating_secret/resource.tf" }}
+
+{{ .SchemaMarkdown | trimspace }}