docs: add resource descriptions (#6)

nitrado · Oct 17, 2023 · 28bee46 · 28bee46
1 parent 9377c57
commit 28bee46
Show file tree

Hide file tree

Showing 33 changed files with 95 additions and 39 deletions.
diff --git a/docs/data-sources/armada_armada.md b/docs/data-sources/armada_armada.md
@@ -3,12 +3,12 @@
 page_title: "ec_armada_armada Data Source - terraform-provider-ec"
 subcategory: ""
 description: |-
-  
+  Use this data source to access information about an existing Armada.
 ---
 
 # ec_armada_armada (Data Source)
 
-
+Use this data source to access information about an existing Armada.
 
 
 

diff --git a/docs/data-sources/armada_armada_v1.md b/docs/data-sources/armada_armada_v1.md
@@ -3,12 +3,12 @@
 page_title: "ec_armada_armada_v1 Data Source - terraform-provider-ec"
 subcategory: ""
 description: |-
-  
+  Use this data source to access information about an existing Armada.
 ---
 
 # ec_armada_armada_v1 (Data Source)
 
-
+Use this data source to access information about an existing Armada.
 
 
 

diff --git a/docs/data-sources/armada_armadaset.md b/docs/data-sources/armada_armadaset.md
@@ -3,12 +3,12 @@
 page_title: "ec_armada_armadaset Data Source - terraform-provider-ec"
 subcategory: ""
 description: |-
-  
+  Use this data source to access information about an existing ArmadaSet.
 ---
 
 # ec_armada_armadaset (Data Source)
 
-
+Use this data source to access information about an existing ArmadaSet.
 
 
 

diff --git a/docs/data-sources/armada_armadaset_v1.md b/docs/data-sources/armada_armadaset_v1.md
@@ -3,12 +3,12 @@
 page_title: "ec_armada_armadaset_v1 Data Source - terraform-provider-ec"
 subcategory: ""
 description: |-
-  
+  Use this data source to access information about an existing ArmadaSet.
 ---
 
 # ec_armada_armadaset_v1 (Data Source)
 
-
+Use this data source to access information about an existing ArmadaSet.
 
 
 

diff --git a/docs/data-sources/armada_branch.md b/docs/data-sources/armada_branch.md
@@ -3,12 +3,12 @@
 page_title: "ec_armada_branch Data Source - terraform-provider-ec"
 subcategory: ""
 description: |-
-  
+  Use this data source to access information about an existing Branch.
 ---
 
 # ec_armada_branch (Data Source)
 
-
+Use this data source to access information about an existing Branch.
 
 
 

diff --git a/docs/data-sources/armada_branch_v1.md b/docs/data-sources/armada_branch_v1.md
@@ -3,12 +3,12 @@
 page_title: "ec_armada_branch_v1 Data Source - terraform-provider-ec"
 subcategory: ""
 description: |-
-  
+  Use this data source to access information about an existing Branch.
 ---
 
 # ec_armada_branch_v1 (Data Source)
 
-
+Use this data source to access information about an existing Branch.
 
 
 

diff --git a/docs/data-sources/armada_region.md b/docs/data-sources/armada_region.md
@@ -3,12 +3,12 @@
 page_title: "ec_armada_region Data Source - terraform-provider-ec"
 subcategory: ""
 description: |-
-  
+  Use this data source to access information about an existing Region.
 ---
 
 # ec_armada_region (Data Source)
 
-
+Use this data source to access information about an existing Region.
 
 
 

diff --git a/docs/data-sources/armada_region_v1.md b/docs/data-sources/armada_region_v1.md
@@ -3,12 +3,12 @@
 page_title: "ec_armada_region_v1 Data Source - terraform-provider-ec"
 subcategory: ""
 description: |-
-  
+  Use this data source to access information about an existing Region.
 ---
 
 # ec_armada_region_v1 (Data Source)
 
-
+Use this data source to access information about an existing Region.
 
 
 

diff --git a/docs/data-sources/armada_site.md b/docs/data-sources/armada_site.md
@@ -3,12 +3,12 @@
 page_title: "ec_armada_site Data Source - terraform-provider-ec"
 subcategory: ""
 description: |-
-  
+  Use this data source to access information about an existing Site.
 ---
 
 # ec_armada_site (Data Source)
 
-
+Use this data source to access information about an existing Site.
 
 
 

diff --git a/docs/data-sources/armada_site_v1.md b/docs/data-sources/armada_site_v1.md
@@ -3,12 +3,12 @@
 page_title: "ec_armada_site_v1 Data Source - terraform-provider-ec"
 subcategory: ""
 description: |-
-  
+  Use this data source to access information about an existing Site.
 ---
 
 # ec_armada_site_v1 (Data Source)
 
-
+Use this data source to access information about an existing Site.
 
 
 

diff --git a/docs/index.md b/docs/index.md
@@ -53,4 +53,4 @@ resource "ec_armada_site" "test" {
 - `host` (String) The hostname (in form of URI) of Armada API.
 - `password` (String) The password to authenticate with.
 - `token_endpoint` (String) The URI to the token authentication endpoint.
-- `username` (String) The user to authenticate with.
+- `username` (String) The user to authenticate with.
diff --git a/docs/resources/armada_armada.md b/docs/resources/armada_armada.md
@@ -3,12 +3,12 @@
 page_title: "ec_armada_armada Resource - terraform-provider-ec"
 subcategory: ""
 description: |-
-  
+  An Armada distributes a specified number of Game Servers across a Region.
 ---
 
 # ec_armada_armada (Resource)
 
-
+An Armada distributes a specified number of Game Servers across a Region.
 
 
 

diff --git a/docs/resources/armada_armada_v1.md b/docs/resources/armada_armada_v1.md
@@ -3,12 +3,12 @@
 page_title: "ec_armada_armada_v1 Resource - terraform-provider-ec"
 subcategory: ""
 description: |-
-  
+  An Armada distributes a specified number of Game Servers across a Region.
 ---
 
 # ec_armada_armada_v1 (Resource)
 
-
+An Armada distributes a specified number of Game Servers across a Region.
 
 
 

diff --git a/docs/resources/armada_armadaset.md b/docs/resources/armada_armadaset.md
@@ -3,12 +3,12 @@
 page_title: "ec_armada_armadaset Resource - terraform-provider-ec"
 subcategory: ""
 description: |-
-  
+  An ArmadaSet manages Armadas across multiple Regions, while sharing a common specification.
 ---
 
 # ec_armada_armadaset (Resource)
 
-
+An ArmadaSet manages Armadas across multiple Regions, while sharing a common specification.
 
 
 

diff --git a/docs/resources/armada_armadaset_v1.md b/docs/resources/armada_armadaset_v1.md
@@ -3,12 +3,12 @@
 page_title: "ec_armada_armadaset_v1 Resource - terraform-provider-ec"
 subcategory: ""
 description: |-
-  
+  An ArmadaSet manages Armadas across multiple Regions, while sharing a common specification.
 ---
 
 # ec_armada_armadaset_v1 (Resource)
 
-
+An ArmadaSet manages Armadas across multiple Regions, while sharing a common specification.
 
 
 

diff --git a/docs/resources/armada_branch.md b/docs/resources/armada_branch.md
@@ -3,14 +3,27 @@
 page_title: "ec_armada_branch Resource - terraform-provider-ec"
 subcategory: ""
 description: |-
-  
+  A Branch groups container Images.
 ---
 
 # ec_armada_branch (Resource)
 
+A Branch groups container Images.
 
+## Example Usage
 
+```terraform
+resource "ec_armada_branch" "test" {
+  metadata {
+    name = "test"
+  }
 
+  spec {
+    description = "My branch"
+    display_name = "Test"
+  }
+}
+```
 
 <!-- schema generated by tfplugindocs -->
 ## Schema

diff --git a/docs/resources/armada_branch_v1.md b/docs/resources/armada_branch_v1.md
@@ -3,14 +3,27 @@
 page_title: "ec_armada_branch_v1 Resource - terraform-provider-ec"
 subcategory: ""
 description: |-
-  
+  A Branch groups container Images.
 ---
 
 # ec_armada_branch_v1 (Resource)
 
+A Branch groups container Images.
 
+## Example Usage
 
+```terraform
+resource "ec_armada_branch_v1" "test" {
+  metadata {
+    name = "test"
+  }
 
+  spec {
+    description = "My branch"
+    display_name = "Test"
+  }
+}
+```
 
 <!-- schema generated by tfplugindocs -->
 ## Schema

diff --git a/docs/resources/armada_region.md b/docs/resources/armada_region.md
@@ -3,12 +3,12 @@
 page_title: "ec_armada_region Resource - terraform-provider-ec"
 subcategory: ""
 description: |-
-  
+  A Region determines how Armadas are distributed across Sites.
 ---
 
 # ec_armada_region (Resource)
 
-
+A Region determines how Armadas are distributed across Sites.
 
 
 

diff --git a/docs/resources/armada_region_v1.md b/docs/resources/armada_region_v1.md
@@ -3,12 +3,12 @@
 page_title: "ec_armada_region_v1 Resource - terraform-provider-ec"
 subcategory: ""
 description: |-
-  
+  A Region determines how Armadas are distributed across Sites.
 ---
 
 # ec_armada_region_v1 (Resource)
 
-
+A Region determines how Armadas are distributed across Sites.
 
 
 

diff --git a/docs/resources/armada_site.md b/docs/resources/armada_site.md
@@ -3,12 +3,12 @@
 page_title: "ec_armada_site Resource - terraform-provider-ec"
 subcategory: ""
 description: |-
-  
+  A Site provides a connection to deployment capacity.
 ---
 
 # ec_armada_site (Resource)
 
-
+A Site provides a connection to deployment capacity.
 
 ## Example Usage
 

diff --git a/docs/resources/armada_site_v1.md b/docs/resources/armada_site_v1.md
@@ -3,12 +3,12 @@
 page_title: "ec_armada_site_v1 Resource - terraform-provider-ec"
 subcategory: ""
 description: |-
-  
+  A Site provides a connection to deployment capacity.
 ---
 
 # ec_armada_site_v1 (Resource)
 
-
+A Site provides a connection to deployment capacity.
 
 ## Example Usage
 

diff --git a/ec/armada/data_source_armada_armada.go b/ec/armada/data_source_armada_armada.go
@@ -10,6 +10,7 @@ import (
 // DataSourceArmadaArmada returns the data source resource for an Armada.
 func DataSourceArmadaArmada() *schema.Resource {
 	return &schema.Resource{
+		Description: "Use this data source to access information about an existing Armada.",
 		ReadContext: dataSourceArmadaArmadaRead,
 		Schema:      armadaSchema(),
 	}

diff --git a/ec/armada/data_source_armada_armadaset.go b/ec/armada/data_source_armada_armadaset.go
@@ -10,6 +10,7 @@ import (
 // DataSourceArmadaArmadaSet returns the data source resource for an ArmadaSet.
 func DataSourceArmadaArmadaSet() *schema.Resource {
 	return &schema.Resource{
+		Description: "Use this data source to access information about an existing ArmadaSet.",
 		ReadContext: dataSourceArmadaArmadaSetRead,
 		Schema:      armadaSetSchema(),
 	}

diff --git a/ec/armada/data_source_armada_branch.go b/ec/armada/data_source_armada_branch.go
@@ -10,6 +10,7 @@ import (
 // DataSourceArmadaBranch returns the data source resource for a Branch.
 func DataSourceArmadaBranch() *schema.Resource {
 	return &schema.Resource{
+		Description: "Use this data source to access information about an existing Branch.",
 		ReadContext: dataSourceArmadaBranchRead,
 		Schema:      branchSchema(),
 	}

diff --git a/ec/armada/data_source_armada_region.go b/ec/armada/data_source_armada_region.go
@@ -10,6 +10,7 @@ import (
 // DataSourceArmadaRegion returns the data source resource for a Region.
 func DataSourceArmadaRegion() *schema.Resource {
 	return &schema.Resource{
+		Description: "Use this data source to access information about an existing Region.",
 		ReadContext: dataSourceArmadaRegionRead,
 		Schema:      regionSchema(),
 	}

diff --git a/ec/armada/data_source_armada_site.go b/ec/armada/data_source_armada_site.go
@@ -10,6 +10,7 @@ import (
 // DataSourceArmadaSite returns the data source resource for a Site.
 func DataSourceArmadaSite() *schema.Resource {
 	return &schema.Resource{
+		Description: "Use this data source to access information about an existing Site.",
 		ReadContext: dataSourceArmadaSiteRead,
 		Schema:      siteSchema(),
 	}

diff --git a/ec/armada/resource_armada_armada.go b/ec/armada/resource_armada_armada.go
@@ -14,6 +14,7 @@ import (
 // ResourceArmadaArmada returns the resource for an Armada.
 func ResourceArmadaArmada() *schema.Resource {
 	return &schema.Resource{
+		Description:   "An Armada distributes a specified number of Game Servers across a Region.",
 		ReadContext:   resourceArmadaArmadaRead,
 		CreateContext: resourceArmadaArmadaCreate,
 		UpdateContext: resourceArmadaArmadaUpdate,

diff --git a/ec/armada/resource_armada_armadaset.go b/ec/armada/resource_armada_armadaset.go
@@ -14,6 +14,7 @@ import (
 // ResourceArmadaArmadaSet returns the resource for an ArmadaSet.
 func ResourceArmadaArmadaSet() *schema.Resource {
 	return &schema.Resource{
+		Description:   "An ArmadaSet manages Armadas across multiple Regions, while sharing a common specification.",
 		ReadContext:   resourceArmadaArmadaSetRead,
 		CreateContext: resourceArmadaArmadaSetCreate,
 		UpdateContext: resourceArmadaArmadaSetUpdate,

diff --git a/ec/armada/resource_armada_branch.go b/ec/armada/resource_armada_branch.go
@@ -14,6 +14,7 @@ import (
 // ResourceArmadaBranch returns the resource for a Branch.
 func ResourceArmadaBranch() *schema.Resource {
 	return &schema.Resource{
+		Description:   "A Branch groups container Images.",
 		ReadContext:   resourceArmadaBranchRead,
 		CreateContext: resourceArmadaBranchCreate,
 		UpdateContext: resourceArmadaBranchUpdate,