Add back lost information in docs after generating them

OctopusDeployLabs · Mar 27, 2024 · e4d2a47 · e4d2a47
1 parent ce03830
commit e4d2a47
Show file tree

Hide file tree

Showing 8 changed files with 94 additions and 12 deletions.
diff --git a/docs/resources/external_feed_create_release_trigger.md b/docs/resources/external_feed_create_release_trigger.md
@@ -1,17 +1,32 @@
 ---
-# generated by https://github.com/hashicorp/terraform-plugin-docs
 page_title: "octopusdeploy_external_feed_create_release_trigger Resource - terraform-provider-octopusdeploy"
-subcategory: ""
+subcategory: "Triggers"
 description: |-
-  
+  This resource manages External feed triggers (release creation type) in Octopus Deploy.
 ---
 
 # octopusdeploy_external_feed_create_release_trigger (Resource)
 
-
-
-
-
+This resource manages External feed triggers (release creation type) in Octopus Deploy.
+
+## Example Usage
+
+```terraform
+resource "octopusdeploy_external_feed_create_release_trigger" "my_trigger" {
+  name        = "My feed trigger"
+  space_id    = "Spaces-1"
+  project_id  = "Projects-2"
+  package {
+    deployment_action = "My Helm step"
+    package_reference = "nginx"
+  }
+  package {
+    deployment_action = "My container step"
+    package_reference = "busybox"
+  }
+  channel_id = "Channels-21"
+}
+```
 <!-- schema generated by tfplugindocs -->
 ## Schema
 
@@ -39,4 +54,10 @@ Optional:
 - `deployment_action` (String)
 - `package_reference` (String)
 
+## Import
+
+Import is supported using the following syntax:
 
+```shell
+terraform import [options] octopusdeploy_external_feed_create_release_trigger.<name> <trigger-id>
+```
diff --git a/docs/resources/project_scheduled_trigger.md b/docs/resources/project_scheduled_trigger.md
@@ -1,14 +1,13 @@
 ---
-# generated by https://github.com/hashicorp/terraform-plugin-docs
 page_title: "octopusdeploy_project_scheduled_trigger Resource - terraform-provider-octopusdeploy"
-subcategory: ""
+subcategory: "Triggers"
 description: |-
-  
+  This resource manages a scheduled trigger for a project or runbook in Octopus Deploy.
 ---
 
 # octopusdeploy_project_scheduled_trigger (Resource)
 
-
+This resource manages a scheduled trigger for a project or runbook in Octopus Deploy.
 
 ## Example Usage
 
@@ -84,7 +83,6 @@ resource "octopusdeploy_project_scheduled_trigger" "runbook_example" {
   }
 }
 ```
-
 <!-- schema generated by tfplugindocs -->
 ## Schema
 

diff --git a/examples/resources/octopusdeploy_external_feed_create_release_trigger/import.sh b/examples/resources/octopusdeploy_external_feed_create_release_trigger/import.sh
@@ -0,0 +1 @@
+terraform import [options] octopusdeploy_external_feed_create_release_trigger.<name> <trigger-id>
diff --git a/examples/resources/octopusdeploy_external_feed_create_release_trigger/resource.tf b/examples/resources/octopusdeploy_external_feed_create_release_trigger/resource.tf
@@ -0,0 +1,14 @@
+resource "octopusdeploy_external_feed_create_release_trigger" "my_trigger" {
+  name        = "My feed trigger"
+  space_id    = "Spaces-1"
+  project_id  = "Projects-2"
+  package {
+    deployment_action = "My Helm step"
+    package_reference = "nginx"
+  }
+  package {
+    deployment_action = "My container step"
+    package_reference = "busybox"
+  }
+  channel_id = "Channels-21"
+}
diff --git a/octopusdeploy/resource_external_feed_create_release_trigger.go b/octopusdeploy/resource_external_feed_create_release_trigger.go
@@ -17,6 +17,7 @@ func resourceExternalFeedCreateReleaseTrigger() *schema.Resource {
 	return &schema.Resource{
 		CreateContext: resourceExternalFeedCreateReleaseTriggerCreate,
 		DeleteContext: resourceExternalFeedCreateReleaseTriggerDelete,
+		Description:   "This resource manages External feed triggers (release creation type) in Octopus Deploy.",
 		Importer:      getImporter(),
 		ReadContext:   resourceExternalFeedCreateReleaseTriggerRead,
 		Schema:        getExternalFeedCreateReleaseTriggerSchema(),

diff --git a/octopusdeploy/resource_project_scheduled_trigger.go b/octopusdeploy/resource_project_scheduled_trigger.go
@@ -12,6 +12,7 @@ func resourceProjectScheduledTrigger() *schema.Resource {
 	return &schema.Resource{
 		CreateContext: resourceProjectScheduledTriggerCreate,
 		DeleteContext: resourceProjectScheduledTriggerDelete,
+		Description:   "This resource manages a scheduled trigger for a project or runbook in Octopus Deploy.",
 		Importer:      getImporter(),
 		ReadContext:   resourceProjectScheduledTriggerRead,
 		Schema:        getProjectScheduledTriggerSchema(),

diff --git a/templates/resources/external_feed_create_release_trigger.md.tmpl b/templates/resources/external_feed_create_release_trigger.md.tmpl
@@ -0,0 +1,23 @@
+---
+page_title: "{{.Name}} {{.Type}} - {{.ProviderName}}"
+subcategory: "Triggers"
+description: |-
+{{ .Description | plainmarkdown | trimspace | prefixlines "  " }}
+---
+
+# {{.Name}} ({{.Type}})
+
+{{ .Description | trimspace }}
+
+## Example Usage
+
+{{ tffile (printf "%s%s%s" "examples/resources/" .Name "/resource.tf") }}
+{{ .SchemaMarkdown | trimspace }}
+
+{{ if .HasImport -}}
+## Import
+
+Import is supported using the following syntax:
+
+{{ codefile "shell" (printf "%s%s%s" "examples/resources/" .Name "/import.sh") }}
+{{- end }}
diff --git a/templates/resources/project_scheduled_trigger.md.tmpl b/templates/resources/project_scheduled_trigger.md.tmpl
@@ -0,0 +1,23 @@
+---
+page_title: "{{.Name}} {{.Type}} - {{.ProviderName}}"
+subcategory: "Triggers"
+description: |-
+{{ .Description | plainmarkdown | trimspace | prefixlines "  " }}
+---
+
+# {{.Name}} ({{.Type}})
+
+{{ .Description | trimspace }}
+
+## Example Usage
+
+{{ tffile (printf "%s%s%s" "examples/resources/" .Name "/resource.tf") }}
+{{ .SchemaMarkdown | trimspace }}
+
+{{ if .HasImport -}}
+## Import
+
+Import is supported using the following syntax:
+
+{{ codefile "shell" (printf "%s%s%s" "examples/resources/" .Name "/import.sh") }}
+{{- end }}
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1 @@
		terraform import [options] octopusdeploy_external_feed_create_release_trigger.<name> <trigger-id>