Merge pull request #10 from TerraformInDepth/doc_updates

More documentation improvements

Author: tedivm

docs/data-sources/account.md

@@ -3,12 +3,12 @@
 page_title: "mastodon_account Data Source - mastodon"
 subcategory: ""
 description: |-
-  Account data source
+  This data source can be used to look up accounts in the Fediverse.
 ---
 
 # mastodon_account (Data Source)
 
-Account data source
+This data source can be used to look up accounts in the Fediverse.
 
 ## Example Usage
 

docs/resources/post.md

@@ -3,14 +3,35 @@
 page_title: "mastodon_post Resource - mastodon"
 subcategory: ""
 description: |-
-  Post resource
+  This resource is used to manage posts on a Mastodon instance.
 ---
 
 # mastodon_post (Resource)
 
-Post resource
+This resource is used to manage posts on a Mastodon instance.
 
+## Example Usage
 
+```terraform
+resource "mastodon_post" "example" {
+  content = "I'm posting!"
+}
+```
+
+### Preserve on Destroy
+
+```terraform
+resource "mastodon_post" "example" {
+  content             = "A new EC2 instance has deployed! ID: ${aws_instance.example.id}"
+  preserve_on_destroy = true
+
+  lifecycle {
+    replace_triggered_by = [
+      aws_instance.example.id
+    ]
+  }
+}
+```
 
 <!-- schema generated by tfplugindocs -->
 ## Schema

examples/resources/mastodon_post/resource.tf

@@ -0,0 +1,3 @@
+resource "mastodon_post" "example" {
+  content = "I'm posting!"
+}

examples/resources/scaffolding_example/resource.tf

@@ -40,7 +40,7 @@ func (d *AccountDataSource) Metadata(ctx context.Context, req datasource.Metadat
 func (d *AccountDataSource) Schema(ctx context.Context, req datasource.SchemaRequest, resp *datasource.SchemaResponse) {
 	resp.Schema = schema.Schema{
 		// This description is used by the documentation generator and the language server.
-		MarkdownDescription: "Account data source",
+		MarkdownDescription: "This data source can be used to look up accounts in the Fediverse.",
 
 		Attributes: map[string]schema.Attribute{
 			"username": schema.StringAttribute{

internal/provider/account_data_source.go

@@ -48,7 +48,7 @@ func (r *PostResource) Metadata(ctx context.Context, req resource.MetadataReques
 func (r *PostResource) Schema(ctx context.Context, req resource.SchemaRequest, resp *resource.SchemaResponse) {
 	resp.Schema = schema.Schema{
 		// This description is used by the documentation generator and the language server.
-		MarkdownDescription: "Post resource",
+		MarkdownDescription: "This resource is used to manage posts on a Mastodon instance.",
 
 		Attributes: map[string]schema.Attribute{
 			"id": schema.StringAttribute{

internal/provider/post_resource.go

@@ -0,0 +1,42 @@
+---
+# generated by https://github.com/hashicorp/terraform-plugin-docs
+page_title: "{{.Name}} {{.Type}} - {{.ProviderName}}"
+subcategory: ""
+description: |-
+{{ .Description | plainmarkdown | trimspace | prefixlines "  " }}
+---
+
+# {{.Name}} ({{.Type}})
+
+{{ .Description | trimspace }}
+
+{{ if .HasExample -}}
+## Example Usage
+
+{{tffile .ExampleFile }}
+{{- end }}
+
+### Preserve on Destroy
+
+```terraform
+resource "mastodon_post" "example" {
+  content             = "A new EC2 instance has deployed! ID: ${aws_instance.example.id}"
+  preserve_on_destroy = true
+
+  lifecycle {
+    replace_triggered_by = [
+      aws_instance.example.id
+    ]
+  }
+}
+```
+
+{{ .SchemaMarkdown | trimspace }}
+{{- if .HasImport }}
+
+## Import
+
+Import is supported using the following syntax:
+
+{{codefile "shell" .ImportFile }}
+{{- end }}