docs: remove description from frontmatter

According to https://developer.hashicorp.com/terraform/registry/providers/docs#yaml-frontmatter, the frontmatter does not support a description field. Regardless, we place the description as the first section each document.
Resourcely-Inc · Nov 25, 2024 · 9228a2a · 9228a2a
1 parent da5102b
commit 9228a2a
Show file tree

Hide file tree

Showing 18 changed files with 0 additions and 56 deletions.
diff --git a/docs/data-sources/blueprint.md b/docs/data-sources/blueprint.md
@@ -1,11 +1,6 @@
 ---
 page_title: "resourcely_blueprint Data Source - terraform-provider-resourcely"
 subcategory: ""
-description: |-
- A blueprint is a configuration template used to provision cloud infrastructure resources. Blueprints allow you to:
- Define which options are available for properties of your resource(s).Apply gaurdrails to your resource(s) to prevent misconfiguration.Define what information to collect from your developers before provisioning the resource.
- Once a blueprint is configured and published, it becomes available for use in your Resourcely service catalog.
- The template is specified using Resourcely's TFT templating language. See the Authoring Your Own Blueprints https://docs.resourcely.io/build/setting-up-blueprints/authoring-your-own-blueprints docs for details about TFT. The Resourcely Foundry https://portal.resourcely.io/foundry?mode=blueprint provides an IDE to assist with authoring the template.
 ---
 
 # resourcely_blueprint (Data Source)

diff --git a/docs/data-sources/context_question.md b/docs/data-sources/context_question.md
@@ -1,12 +1,6 @@
 ---
 page_title: "resourcely_context_question Data Source - terraform-provider-resourcely"
 subcategory: ""
-description: |-
- A context question https://docs.resourcely.io/concepts/other-features-and-settings/global-context-and-values is used to gather data from developers before provisioning a resource. They are designed to gather and store insightful data related to the resource.
- Some examples include:
- What type of data will be stored in this infrastructure?What application is this infrastructure associated with?What is the email address the person/team responsible for this infrastructure?
- Three types of context questions are supported:
- TextSingle ChoiceMultiple Choice
 ---
 
 # resourcely_context_question (Data Source)

diff --git a/docs/data-sources/global_value.md b/docs/data-sources/global_value.md
@@ -1,8 +1,6 @@
 ---
 page_title: "resourcely_global_value Data Source - terraform-provider-resourcely"
 subcategory: ""
-description: |-
- A global value https://docs.resourcely.io/concepts/other-features-and-settings/global-values allows admins to define custom drop-downs for customizing Terraform infrastructure resource properties before they are provisioned.  They are useful for providing access to lists of relatively static values like VPC IDs, allowed regions, department or team names, etc.
 ---
 
 # resourcely_global_value (Data Source)

diff --git a/docs/data-sources/guardrail.md b/docs/data-sources/guardrail.md
@@ -1,10 +1,6 @@
 ---
 page_title: "resourcely_guardrail Data Source - terraform-provider-resourcely"
 subcategory: ""
-description: |-
- A guardrail governs how cloud resources can be created and altered, preventing infrastructure misconfiguration. Before infrastructure is provisioned, Resourcely examines the changes being made and prevents a merge if any guardrail requirements are violated. Some examples of guardrails include:
- Require approval for making a public S3 bucketRestrict the allowed compute instance types or images
- Guardrails are specified using the Really policy language https://docs.resourcely.io/build/setting-up-guardrails/authoring-your-own-guardrails.
 ---
 
 # resourcely_guardrail (Data Source)

diff --git a/docs/index.md b/docs/index.md
@@ -1,7 +1,5 @@
 ---
 page_title: "Provider: resourcely"
-description: |-
-  Manage Resourcely blueprints, guardrails, global values, and more through Terraform.
 ---
 
 # RESOURCELY Provider

diff --git a/docs/resources/blueprint.md b/docs/resources/blueprint.md
@@ -1,11 +1,6 @@
 ---
 page_title: "resourcely_blueprint Resource - terraform-provider-resourcely"
 subcategory: ""
-description: |-
- A blueprint is a configuration template used to provision cloud infrastructure resources. Blueprints allow you to:
- Define which options are available for properties of your resource(s).Apply gaurdrails to your resource(s) to prevent misconfiguration.Define what information to collect from your developers before provisioning the resource.
- Once a blueprint is configured and published, it becomes available for use in your Resourcely service catalog.
- The template is specified using Resourcely's TFT templating language. See the Authoring Your Own Blueprints https://docs.resourcely.io/build/setting-up-blueprints/authoring-your-own-blueprints docs for details about TFT. The Resourcely Foundry https://portal.resourcely.io/foundry?mode=blueprint provides an IDE to assist with authoring the template.
 ---
 
 # resourcely_blueprint (Resource)

diff --git a/docs/resources/context_question.md b/docs/resources/context_question.md
@@ -1,12 +1,6 @@
 ---
 page_title: "resourcely_context_question Resource - terraform-provider-resourcely"
 subcategory: ""
-description: |-
- A context question https://docs.resourcely.io/concepts/other-features-and-settings/global-context-and-values is used to gather data from developers before provisioning a resource. They are designed to gather and store insightful data related to the resource.
- Some examples include:
- What type of data will be stored in this infrastructure?What application is this infrastructure associated with?What is the email address the person/team responsible for this infrastructure?
- Three types of context questions are supported:
- TextSingle ChoiceMultiple Choice
 ---
 
 # resourcely_context_question (Resource)

diff --git a/docs/resources/global_value.md b/docs/resources/global_value.md
@@ -1,9 +1,6 @@
 ---
 page_title: "resourcely_global_value Resource - terraform-provider-resourcely"
 subcategory: ""
-description: |-
- A global value https://docs.resourcely.io/concepts/other-features-and-settings/global-values allows admins to define custom drop-downs for customizing Terraform infrastructure resource properties before they are provisioned.  They are useful for providing access to lists of relatively static values like VPC IDs, allowed regions, department or team names, etc.
- This global value API does not support deletion. Deleting the Terraform resource will remove the resource from the Terraform state file, but will not actually delete the global value entity. Set is_deprecated = true to tell Resourcely that this global value should no longer be used by new blueprints or guardrails.
 ---
 
 # resourcely_global_value (Resource)

diff --git a/docs/resources/guardrail.md b/docs/resources/guardrail.md
@@ -1,11 +1,6 @@
 ---
 page_title: "resourcely_guardrail Resource - terraform-provider-resourcely"
 subcategory: ""
-description: |-
- A guardrail governs how cloud resources can be created and altered, preventing infrastructure misconfiguration. Before infrastructure is provisioned, Resourcely examines the changes being made and prevents a merge if any guardrail requirements are violated.
- Some examples of guardrails include:
- Require approval for making a public S3 bucketRestrict the allowed compute instance types or images
- Guardrails are specified using the Really policy language https://docs.resourcely.io/build/setting-up-guardrails/authoring-your-own-guardrails.
 ---
 
 # resourcely_guardrail (Resource)

diff --git a/templates/data-sources/blueprint.md.tmpl b/templates/data-sources/blueprint.md.tmpl
@@ -1,8 +1,6 @@
 ---
 page_title: "{{.Name}} {{.Type}} - {{.ProviderName}}"
 subcategory: ""
-description: |-
-{{ .Description | plainmarkdown | trimspace | prefixlines " " }}
 ---
 
 # {{.Name}} ({{.Type}})

diff --git a/templates/data-sources/context_question.md.tmpl b/templates/data-sources/context_question.md.tmpl
@@ -1,8 +1,6 @@
 ---
 page_title: "{{.Name}} {{.Type}} - {{.ProviderName}}"
 subcategory: ""
-description: |-
-{{ .Description | plainmarkdown | trimspace | prefixlines " " }}
 ---
 
 # {{.Name}} ({{.Type}})

diff --git a/templates/data-sources/global_value.md.tmpl b/templates/data-sources/global_value.md.tmpl
@@ -1,8 +1,6 @@
 ---
 page_title: "{{.Name}} {{.Type}} - {{.ProviderName}}"
 subcategory: ""
-description: |-
-{{ .Description | plainmarkdown | trimspace | prefixlines " " }}
 ---
 
 # {{.Name}} ({{.Type}})

diff --git a/templates/data-sources/guardrail.md.tmpl b/templates/data-sources/guardrail.md.tmpl
@@ -1,8 +1,6 @@
 ---
 page_title: "{{.Name}} {{.Type}} - {{.ProviderName}}"
 subcategory: ""
-description: |-
-{{ .Description | plainmarkdown | trimspace | prefixlines " " }}
 ---
 
 # {{.Name}} ({{.Type}})

diff --git a/templates/index.md.tmpl b/templates/index.md.tmpl
@@ -1,7 +1,5 @@
 ---
 page_title: "Provider: resourcely"
-description: |-
-  Manage Resourcely blueprints, guardrails, global values, and more through Terraform.
 ---
 
 # {{ .ProviderShortName | upper }} Provider

diff --git a/templates/resources/blueprint.md.tmpl b/templates/resources/blueprint.md.tmpl
@@ -1,8 +1,6 @@
 ---
 page_title: "{{.Name}} {{.Type}} - {{.ProviderName}}"
 subcategory: ""
-description: |-
-{{ .Description | plainmarkdown | trimspace | prefixlines " " }}
 ---
 
 # {{.Name}} ({{.Type}})

diff --git a/templates/resources/context_question.md.tmpl b/templates/resources/context_question.md.tmpl
@@ -1,8 +1,6 @@
 ---
 page_title: "{{.Name}} {{.Type}} - {{.ProviderName}}"
 subcategory: ""
-description: |-
-{{ .Description | plainmarkdown | trimspace | prefixlines " " }}
 ---
 
 # {{.Name}} ({{.Type}})

diff --git a/templates/resources/global_value.md.tmpl b/templates/resources/global_value.md.tmpl
@@ -1,8 +1,6 @@
 ---
 page_title: "{{.Name}} {{.Type}} - {{.ProviderName}}"
 subcategory: ""
-description: |-
-{{ .Description | plainmarkdown | trimspace | prefixlines " " }}
 ---
 
 # {{.Name}} ({{.Type}})

diff --git a/templates/resources/guardrail.md.tmpl b/templates/resources/guardrail.md.tmpl
@@ -1,8 +1,6 @@
 ---
 page_title: "{{.Name}} {{.Type}} - {{.ProviderName}}"
 subcategory: ""
-description: |-
-{{ .Description | plainmarkdown | trimspace | prefixlines " " }}
 ---
 
 # {{.Name}} ({{.Type}})