feat(provider): [128090230] optmize resources doc and support to show timeouts content (#3563)

* add

* add

* add

* add

* add

* add

* add

* add

* add

* add

Author: SevenEarth

.changelog/3563.txt

@@ -0,0 +1,3 @@
+```release-note:enhancement
+provider: optmize resources doc and support to show `timeouts` content
+```

gendoc/main.go

@@ -130,6 +130,7 @@ func genDoc(product, dtype, fpath, name string, resource *schema.Resource) {
 		"example":           "",
 		"description":       "",
 		"description_short": "",
+		"timeouts":          "",
 		"import":            "",
 	}
 
@@ -164,6 +165,61 @@ func genDoc(product, dtype, fpath, name string, resource *schema.Resource) {
 		description = strings.TrimSpace(description[:importPos])
 	}
 
+	if resource.Timeouts != nil {
+		var timeoutMethods []string
+		if resource.Timeouts.Create != nil {
+			timeoutStr := resource.Timeouts.Create.String()
+			if strings.Contains(timeoutStr, "m") {
+				parts := strings.Split(timeoutStr, "m")
+				if len(parts) > 0 {
+					timeoutStr = parts[0] + "m"
+				}
+			}
+
+			timeoutMethods = append(timeoutMethods, fmt.Sprintf("* `create` - (Defaults to `%s`) Used when creating the resource.", timeoutStr))
+		}
+
+		if resource.Timeouts.Read != nil {
+			timeoutStr := resource.Timeouts.Read.String()
+			if strings.Contains(timeoutStr, "m") {
+				parts := strings.Split(timeoutStr, "m")
+				if len(parts) > 0 {
+					timeoutStr = parts[0] + "m"
+				}
+			}
+
+			timeoutMethods = append(timeoutMethods, fmt.Sprintf("* `read` - (Defaults to `%s`) Used when reading the resource.", timeoutStr))
+		}
+
+		if resource.Timeouts.Update != nil {
+			timeoutStr := resource.Timeouts.Update.String()
+			if strings.Contains(timeoutStr, "m") {
+				parts := strings.Split(timeoutStr, "m")
+				if len(parts) > 0 {
+					timeoutStr = parts[0] + "m"
+				}
+			}
+
+			timeoutMethods = append(timeoutMethods, fmt.Sprintf("* `update` - (Defaults to `%s`) Used when updating the resource.", timeoutStr))
+		}
+
+		if resource.Timeouts.Delete != nil {
+			timeoutStr := resource.Timeouts.Delete.String()
+			if strings.Contains(timeoutStr, "m") {
+				parts := strings.Split(timeoutStr, "m")
+				if len(parts) > 0 {
+					timeoutStr = parts[0] + "m"
+				}
+			}
+
+			timeoutMethods = append(timeoutMethods, fmt.Sprintf("* `delete` - (Defaults to `%s`) Used when deleting the resource.", timeoutStr))
+		}
+
+		if len(timeoutMethods) > 0 {
+			data["timeouts"] = strings.TrimSpace(fmt.Sprintf("The `timeouts` block allows you to specify [timeouts](https://developer.hashicorp.com/terraform/language/resources/syntax#operation-timeouts) for certain actions:\n\n%s", strings.Join(timeoutMethods, "\n")))
+		}
+	}
+
 	pos := strings.Index(description, "\nExample Usage\n")
 	if pos != -1 {
 		data["example"] = formatHCL(description[pos+15:])

gendoc/template.go

@@ -30,6 +30,11 @@ In addition to all arguments above, the following attributes are exported:
 
 {{.attributes}}
 {{end}}
+{{- if and .timeouts (ne .timeouts "")}}
+## Timeouts
+
+{{.timeouts}}
+{{- end}}
 {{if ne .import ""}}
 ## Import
 

website/docs/r/as_start_instance_refresh.html.markdown

@@ -62,4 +62,9 @@ In addition to all arguments above, the following attributes are exported:
 * `id` - ID of the resource.
 
 
+## Timeouts
+
+The `timeouts` block allows you to specify [timeouts](https://developer.hashicorp.com/terraform/language/resources/syntax#operation-timeouts) for certain actions:
+
+* `create` - (Defaults to `5m`) Used when creating the resource.
 

website/docs/r/cynosdb_cluster_slave_zone.html.markdown

@@ -131,6 +131,13 @@ In addition to all arguments above, the following attributes are exported:
 * `id` - ID of the resource.
 
 
+## Timeouts
+
+The `timeouts` block allows you to specify [timeouts](https://developer.hashicorp.com/terraform/language/resources/syntax#operation-timeouts) for certain actions:
+
+* `create` - (Defaults to `5m`) Used when creating the resource.
+* `update` - (Defaults to `5m`) Used when updating the resource.
+* `delete` - (Defaults to `5m`) Used when deleting the resource.
 
 ## Import
 

website/docs/r/instance.html.markdown

@@ -409,6 +409,11 @@ In addition to all arguments above, the following attributes are exported:
 * `public_ipv6_addresses` - The public IPv6 address to which the instance is bound.
 * `uuid` - Globally unique ID of the instance.
 
+## Timeouts
+
+The `timeouts` block allows you to specify [timeouts](https://developer.hashicorp.com/terraform/language/resources/syntax#operation-timeouts) for certain actions:
+
+* `create` - (Defaults to `15m`) Used when creating the resource.
 
 ## Import
 

website/docs/r/instance_set.html.markdown

@@ -118,4 +118,12 @@ In addition to all arguments above, the following attributes are exported:
 * `instance_status` - Current status of the instance.
 * `public_ip` - Public IP of the instance.
 
+## Timeouts
+
+The `timeouts` block allows you to specify [timeouts](https://developer.hashicorp.com/terraform/language/resources/syntax#operation-timeouts) for certain actions:
+
+* `create` - (Defaults to `10m`) Used when creating the resource.
+* `read` - (Defaults to `10m`) Used when reading the resource.
+* `update` - (Defaults to `10m`) Used when updating the resource.
+* `delete` - (Defaults to `10m`) Used when deleting the resource.
 

website/docs/r/kubernetes_addon.html.markdown

@@ -54,6 +54,13 @@ In addition to all arguments above, the following attributes are exported:
 * `phase` - Status of addon.
 * `reason` - Reason of addon failed.
 
+## Timeouts
+
+The `timeouts` block allows you to specify [timeouts](https://developer.hashicorp.com/terraform/language/resources/syntax#operation-timeouts) for certain actions:
+
+* `create` - (Defaults to `3m`) Used when creating the resource.
+* `update` - (Defaults to `3m`) Used when updating the resource.
+* `delete` - (Defaults to `3m`) Used when deleting the resource.
 
 ## Import
 

website/docs/r/kubernetes_node_pool.html.markdown

@@ -461,6 +461,12 @@ In addition to all arguments above, the following attributes are exported:
 * `node_count` - The total node count.
 * `status` - Status of the node pool.
 
+## Timeouts
+
+The `timeouts` block allows you to specify [timeouts](https://developer.hashicorp.com/terraform/language/resources/syntax#operation-timeouts) for certain actions:
+
+* `create` - (Defaults to `30m`) Used when creating the resource.
+* `update` - (Defaults to `30m`) Used when updating the resource.
 
 ## Import
 

website/docs/r/mongodb_instance_backup.html.markdown

@@ -36,4 +36,9 @@ In addition to all arguments above, the following attributes are exported:
 * `id` - ID of the resource.
 
 
+## Timeouts
+
+The `timeouts` block allows you to specify [timeouts](https://developer.hashicorp.com/terraform/language/resources/syntax#operation-timeouts) for certain actions:
+
+* `create` - (Defaults to `3m`) Used when creating the resource.