Merge pull request #1982 from quixoticmonk/d-improve-awscc_rekognitio…

…n_project docs: added example for awscc_rekognition_project
hashicorp · Sep 3, 2024 · a582d8a · a582d8a
2 parents a2a1472 + f703afb
commit a582d8a
Show file tree

Hide file tree

Showing 3 changed files with 35 additions and 2 deletions.
diff --git a/docs/resources/rekognition_project.md b/docs/resources/rekognition_project.md
@@ -1,5 +1,4 @@
 ---
-# generated by https://github.com/hashicorp/terraform-plugin-docs
 page_title: "awscc_rekognition_project Resource - terraform-provider-awscc"
 subcategory: ""
 description: |-
@@ -10,7 +9,13 @@ description: |-
 
 The AWS::Rekognition::Project type creates an Amazon Rekognition CustomLabels Project. A project is a grouping of the resources needed to create and manage Dataset and ProjectVersions.
 
+## Example Usage
 
+```terraform
+resource "awscc_rekognition_project" "example" {
+  project_name = "example"
+}
+```
 
 <!-- schema generated by tfplugindocs -->
 ## Schema
@@ -30,4 +35,4 @@ Import is supported using the following syntax:
 
 ```shell
 $ terraform import awscc_rekognition_project.example "project_name"
-```
+```
diff --git a/examples/resources/awscc_rekognition_project/rekognition_project.tf b/examples/resources/awscc_rekognition_project/rekognition_project.tf
@@ -0,0 +1,3 @@
+resource "awscc_rekognition_project" "example" {
+  project_name = "example"
+}
diff --git a/templates/resources/rekognition_project.md.tmpl b/templates/resources/rekognition_project.md.tmpl
@@ -0,0 +1,25 @@
+---
+page_title: "{{.Name}} {{.Type}} - {{.ProviderName}}"
+subcategory: ""
+description: |-
+{{ .Description | plainmarkdown | trimspace | prefixlines "  " }}
+---
+
+# {{.Name}} ({{.Type}})
+
+{{ .Description | trimspace }}
+
+## Example Usage
+
+{{ tffile (printf "examples/resources/%s/rekognition_project.tf" .Name)}}
+
+{{ .SchemaMarkdown | trimspace }}
+{{- if .HasImport }}
+
+## Import
+
+Import is supported using the following syntax:
+
+{{ codefile "shell" .ImportFile }}
+
+{{- end }}