Merge pull request #564 from oliverpei/master

gailwang · web-flow · commit b70fe53a99b4 · 2020-12-09T14:17:39.000+08:00
optimize document
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,4 +1,9 @@
 ## 1.50.1 (Unreleased)
+
+ENHANCEMENTS:
+
+* Doc: optimize document.
+
 ## 1.50.0 (December 08, 2020)
 
 FEATURES:
diff --git a/tencentcloud/data_source_tc_cbs_storages.go b/tencentcloud/data_source_tc_cbs_storages.go
@@ -51,12 +51,12 @@ func dataSourceTencentCloudCbsStorages() *schema.Resource {
 				Type:         schema.TypeString,
 				Optional:     true,
 				ValidateFunc: validateAllowedStringValue(CBS_STORAGE_TYPE),
-				Description:  "Types of storage medium, and available values include CLOUD_BASIC, CLOUD_PREMIUM and CLOUD_SSD.",
+				Description:  "Filter by cloud disk media type (`CLOUD_BASIC`: HDD cloud disk | `CLOUD_PREMIUM`: Premium Cloud Storage | `CLOUD_SSD`: SSD cloud disk).",
 			},
 			"storage_usage": {
 				Type:        schema.TypeString,
 				Optional:    true,
-				Description: "Types of CBS, and available values include SYSTEM_DISK and DATA_DISK.",
+				Description: "Filter by cloud disk type (`SYSTEM_DISK`: system disk | `DATA_DISK`: data disk).",
 			},
 			"result_output_file": {
 				Type:        schema.TypeString,
diff --git a/tencentcloud/resource_tc_cbs_storage.go b/tencentcloud/resource_tc_cbs_storage.go
@@ -89,7 +89,7 @@ func resourceTencentCloudCbsStorage() *schema.Resource {
 				Optional:     true,
 				Computed:     true,
 				ValidateFunc: validateAllowedStringValue(CBS_PREPAID_RENEW_FLAG),
-				Description:  "When enabled, the CBS instance will be renew automatically when it reach the end of the prepaid tenancy. Valid values are `NOTIFY_AND_AUTO_RENEW`, `NOTIFY_AND_MANUAL_RENEW` and `DISABLE_NOTIFY_AND_MANUAL_RENEW`. NOTE: it only works when charge_type is set to `PREPAID`.",
+				Description:  "Auto Renewal flag. Value range: `NOTIFY_AND_AUTO_RENEW`: Notify expiry and renew automatically, `NOTIFY_AND_MANUAL_RENEW`: Notify expiry but do not renew automatically, `DISABLE_NOTIFY_AND_MANUAL_RENEW`: Neither notify expiry nor renew automatically. Default value range: `NOTIFY_AND_MANUAL_RENEW`: Notify expiry but do not renew automatically. NOTE: it only works when charge_type is set to `PREPAID`.",
 			},
 			"availability_zone": {
 				Type:        schema.TypeString,
diff --git a/tencentcloud/resource_tc_cdn_domain.go b/tencentcloud/resource_tc_cdn_domain.go
@@ -116,7 +116,7 @@ func resourceTencentCloudCdnDomain() *schema.Resource {
 				Required:     true,
 				ForceNew:     true,
 				ValidateFunc: validateAllowedStringValue(CDN_SERVICE_TYPE),
-				Description:  "Service type of Acceleration domain name. Valid values are `web`, `download` and `media`.",
+				Description:  "Acceleration domain name service type. `web`: static acceleration, `download`: download acceleration, `media`: streaming media VOD acceleration.",
 			},
 			"project_id": {
 				Type:        schema.TypeInt,
@@ -128,7 +128,7 @@ func resourceTencentCloudCdnDomain() *schema.Resource {
 				Type:         schema.TypeString,
 				Optional:     true,
 				ValidateFunc: validateAllowedStringValue(CDN_AREA),
-				Description:  "Domain name acceleration region.  Valid values are `mainland`, `overseas` and `global`.",
+				Description:  "Domain name acceleration region. `mainland`: acceleration inside mainland China, `overseas`: acceleration outside mainland China, `global`: global acceleration. Overseas acceleration service must be enabled to use overseas acceleration and global acceleration.",
 			},
 			"full_url_cache": {
 				Type:        schema.TypeBool,
@@ -147,7 +147,7 @@ func resourceTencentCloudCdnDomain() *schema.Resource {
 							Type:         schema.TypeString,
 							Required:     true,
 							ValidateFunc: validateAllowedStringValue(CDN_ORIGIN_TYPE),
-							Description:  "Master origin server type. Valid values are `domain`, `cos`, `ip`, `ipv6` and `ip_ipv6`.",
+							Description:  "Master origin server type. The following types are supported: `domain`: domain name type, `cos`: COS origin, `ip`: IP list used as origin server, `ipv6`: origin server list is a single IPv6 address, `ip_ipv6`: origin server list is multiple IPv4 addresses and an IPv6 address.",
 						},
 						"origin_list": {
 							Type:        schema.TypeList,
@@ -171,13 +171,13 @@ func resourceTencentCloudCdnDomain() *schema.Resource {
 							Optional:     true,
 							Default:      CDN_ORIGIN_PULL_PROTOCOL_HTTP,
 							ValidateFunc: validateAllowedStringValue(CDN_ORIGIN_PULL_PROTOCOL),
-							Description:  "Origin-pull protocol configuration. Valid values are `http`, `https` and `follow`. Default value is `http`.",
+							Description:  "Origin-pull protocol configuration. `http`: forced HTTP origin-pull, `follow`: protocol follow origin-pull, `https`: forced HTTPS origin-pull. This only supports origin server port 443 for origin-pull.",
 						},
 						"backup_origin_type": {
 							Type:         schema.TypeString,
 							Optional:     true,
 							ValidateFunc: validateAllowedStringValue(CDN_BACKUP_ORIGIN_TYPE),
-							Description:  "Backup origin server type. Valid values are `domain` and `ip`.",
+							Description:  "Backup origin server type, which supports the following types: `domain`: domain name type, `ip`: IP list used as origin server.",
 						},
 						"backup_origin_list": {
 							Type:        schema.TypeList,
diff --git a/tencentcloud/resource_tc_cos_bucket.go b/tencentcloud/resource_tc_cos_bucket.go
@@ -159,7 +159,7 @@ func resourceTencentCloudCosBucket() *schema.Resource {
 							Type:        schema.TypeList,
 							Required:    true,
 							Elem:        &schema.Schema{Type: schema.TypeString},
-							Description: "Specifies which methods are allowed. Can be GET, PUT, POST, DELETE or HEAD.",
+							Description: "Specifies which methods are allowed. Can be `GET`, `PUT`, `POST`, `DELETE` or `HEAD`.",
 						},
 						"allowed_headers": {
 							Type:        schema.TypeList,
@@ -215,7 +215,7 @@ func resourceTencentCloudCosBucket() *schema.Resource {
 										Type:         schema.TypeString,
 										Required:     true,
 										ValidateFunc: validateAllowedStringValue(availableCosStorageClass),
-										Description:  "Specifies the storage class to which you want the object to transition. Available values include STANDARD, STANDARD_IA and ARCHIVE.",
+										Description:  "Specifies the storage class to which you want the object to transition. Available values include `STANDARD`, `STANDARD_IA` and `ARCHIVE`.",
 									},
 								},
 							},
diff --git a/tencentcloud/resource_tc_instance.go b/tencentcloud/resource_tc_instance.go
@@ -173,7 +173,7 @@ func resourceTencentCloudInstance() *schema.Resource {
 				Optional:     true,
 				Computed:     true,
 				ValidateFunc: validateAllowedStringValue(CVM_PREPAID_RENEW_FLAG),
-				Description:  "When enabled, the CVM instance will be renew automatically when it reach the end of the prepaid tenancy. Valid values are `NOTIFY_AND_AUTO_RENEW`, `NOTIFY_AND_MANUAL_RENEW` and `DISABLE_NOTIFY_AND_MANUAL_RENEW`. NOTE: it only works when instance_charge_type is set to `PREPAID`.",
+				Description:  "Auto renewal flag. Valid values: `NOTIFY_AND_AUTO_RENEW`: notify upon expiration and renew automatically, `NOTIFY_AND_MANUAL_RENEW`: notify upon expiration but do not renew automatically, `DISABLE_NOTIFY_AND_MANUAL_RENEW`: neither notify upon expiration nor renew automatically. Default value: `NOTIFY_AND_MANUAL_RENEW`. If this parameter is specified as `NOTIFY_AND_AUTO_RENEW`, the instance will be automatically renewed on a monthly basis if the account balance is sufficient. NOTE: it only works when instance_charge_type is set to `PREPAID`.",
 			},
 			"spot_instance_type": {
 				Type:         schema.TypeString,
@@ -244,7 +244,7 @@ func resourceTencentCloudInstance() *schema.Resource {
 				Default:      CVM_DISK_TYPE_CLOUD_BASIC,
 				ForceNew:     true,
 				ValidateFunc: validateAllowedStringValue(CVM_DISK_TYPE),
-				Description:  "Type of the system disk. Valid values are `LOCAL_BASIC`, `LOCAL_SSD`, `CLOUD_BASIC`, `CLOUD_SSD` and `CLOUD_PREMIUM`. default value is `CLOUD_BASIC`. NOTE: `LOCAL_BASIC` and `LOCAL_SSD` are deprecated.",
+				Description:  "System disk type. For more information on limits of system disk types, see [Storage Overview](https://intl.cloud.tencent.com/document/product/213/4952). Valid values: `LOCAL_BASIC`: local disk, `LOCAL_SSD`: local SSD disk, `CLOUD_BASIC`: HDD cloud disk, `CLOUD_SSD`: SSD, `CLOUD_PREMIUM`: Premium Cloud Storage. NOTE: `LOCAL_BASIC` and `LOCAL_SSD` are deprecated.",
 			},
 			"system_disk_size": {
 				Type:         schema.TypeInt,
@@ -274,7 +274,7 @@ func resourceTencentCloudInstance() *schema.Resource {
 							Required:     true,
 							ForceNew:     true,
 							ValidateFunc: validateAllowedStringValue(CVM_DISK_TYPE),
-							Description:  "Type of the data disk. Valid values are `LOCAL_BASIC`, `LOCAL_SSD`, `CLOUD_BASIC`, `CLOUD_SSD` and `CLOUD_PREMIUM`. NOTE: `LOCAL_BASIC` and `LOCAL_SSD` are deprecated.",
+							Description:  "Data disk type. For more information about limits on different data disk types, see [Storage Overview](https://intl.cloud.tencent.com/document/product/213/4952). Valid values: `LOCAL_BASIC`: local disk, `LOCAL_SSD`: local SSD disk, `CLOUD_BASIC`: HDD cloud disk, `CLOUD_PREMIUM`: Premium Cloud Storage, `CLOUD_SSD`: SSD, `CLOUD_HSSD`: Enhanced SSD. NOTE: `LOCAL_BASIC` and `LOCAL_SSD` are deprecated.",
 						},
 						"data_disk_size": {
 							Type:         schema.TypeInt,
diff --git a/website/docs/d/cbs_storages.html.markdown b/website/docs/d/cbs_storages.html.markdown
@@ -29,8 +29,8 @@ The following arguments are supported:
 * `result_output_file` - (Optional) Used to save results.
 * `storage_id` - (Optional) ID of the CBS to be queried.
 * `storage_name` - (Optional) Name of the CBS to be queried.
-* `storage_type` - (Optional) Types of storage medium, and available values include CLOUD_BASIC, CLOUD_PREMIUM and CLOUD_SSD.
-* `storage_usage` - (Optional) Types of CBS, and available values include SYSTEM_DISK and DATA_DISK.
+* `storage_type` - (Optional) Filter by cloud disk media type (`CLOUD_BASIC`: HDD cloud disk | `CLOUD_PREMIUM`: Premium Cloud Storage | `CLOUD_SSD`: SSD cloud disk).
+* `storage_usage` - (Optional) Filter by cloud disk type (`SYSTEM_DISK`: system disk | `DATA_DISK`: data disk).
 
 ## Attributes Reference
 
diff --git a/website/docs/d/service_template_groups.html.markdown b/website/docs/d/service_template_groups.html.markdown
diff --git a/website/docs/d/service_templates.html.markdown b/website/docs/d/service_templates.html.markdown
diff --git a/website/docs/r/cbs_storage.html.markdown b/website/docs/r/cbs_storage.html.markdown
@@ -41,7 +41,7 @@ The following arguments are supported:
 * `force_delete` - (Optional) Indicate whether to delete CBS instance directly or not. Default is false. If set true, the instance will be deleted instead of staying recycle bin.
 * `period` - (Optional, **Deprecated**) It has been deprecated from version 1.33.0. Set `prepaid_period` instead. The purchased usage period of CBS. Valid values: [1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 24, 36].
 * `prepaid_period` - (Optional) The tenancy (time unit is month) of the prepaid instance, NOTE: it only works when charge_type is set to `PREPAID`. Valid values are 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 24, 36.
-* `prepaid_renew_flag` - (Optional) When enabled, the CBS instance will be renew automatically when it reach the end of the prepaid tenancy. Valid values are `NOTIFY_AND_AUTO_RENEW`, `NOTIFY_AND_MANUAL_RENEW` and `DISABLE_NOTIFY_AND_MANUAL_RENEW`. NOTE: it only works when charge_type is set to `PREPAID`.
+* `prepaid_renew_flag` - (Optional) Auto Renewal flag. Value range: `NOTIFY_AND_AUTO_RENEW`: Notify expiry and renew automatically, `NOTIFY_AND_MANUAL_RENEW`: Notify expiry but do not renew automatically, `DISABLE_NOTIFY_AND_MANUAL_RENEW`: Neither notify expiry nor renew automatically. Default value range: `NOTIFY_AND_MANUAL_RENEW`: Notify expiry but do not renew automatically. NOTE: it only works when charge_type is set to `PREPAID`.
 * `project_id` - (Optional) ID of the project to which the instance belongs.
 * `snapshot_id` - (Optional) ID of the snapshot. If specified, created the CBS by this snapshot.
 * `tags` - (Optional) The available tags within this CBS.
diff --git a/website/docs/r/cdn_domain.html.markdown b/website/docs/r/cdn_domain.html.markdown
@@ -86,8 +86,8 @@ The following arguments are supported:
 
 * `domain` - (Required, ForceNew) Name of the acceleration domain.
 * `origin` - (Required) Origin server configuration. It's a list and consist of at most one item.
-* `service_type` - (Required, ForceNew) Service type of Acceleration domain name. Valid values are `web`, `download` and `media`.
-* `area` - (Optional) Domain name acceleration region.  Valid values are `mainland`, `overseas` and `global`.
+* `service_type` - (Required, ForceNew) Acceleration domain name service type. `web`: static acceleration, `download`: download acceleration, `media`: streaming media VOD acceleration.
+* `area` - (Optional) Domain name acceleration region. `mainland`: acceleration inside mainland China, `overseas`: acceleration outside mainland China, `global`: global acceleration. Overseas acceleration service must be enabled to use overseas acceleration and global acceleration.
 * `full_url_cache` - (Optional) Whether to enable full-path cache. Default value is `true`.
 * `https_config` - (Optional) HTTPS acceleration configuration. It's a list and consist of at most one item.
 * `project_id` - (Optional) The project CDN belongs to, default to 0.
@@ -117,12 +117,12 @@ The `https_config` object supports the following:
 The `origin` object supports the following:
 
 * `origin_list` - (Required) Master origin server list. Valid values can be ip or domain name. When modifying the origin server, you need to enter the corresponding `origin_type`.
-* `origin_type` - (Required) Master origin server type. Valid values are `domain`, `cos`, `ip`, `ipv6` and `ip_ipv6`.
+* `origin_type` - (Required) Master origin server type. The following types are supported: `domain`: domain name type, `cos`: COS origin, `ip`: IP list used as origin server, `ipv6`: origin server list is a single IPv6 address, `ip_ipv6`: origin server list is multiple IPv4 addresses and an IPv6 address.
 * `backup_origin_list` - (Optional) Backup origin server list. Valid values can be ip or domain name. When modifying the backup origin server, you need to enter the corresponding `backup_origin_type`.
-* `backup_origin_type` - (Optional) Backup origin server type. Valid values are `domain` and `ip`.
+* `backup_origin_type` - (Optional) Backup origin server type, which supports the following types: `domain`: domain name type, `ip`: IP list used as origin server.
 * `backup_server_name` - (Optional) Host header used when accessing the backup origin server. If left empty, the ServerName of master origin server will be used by default.
 * `cos_private_access` - (Optional) When OriginType is COS, you can specify if access to private buckets is allowed. Valid values are `on` and `off`. and default value is `off`.
-* `origin_pull_protocol` - (Optional) Origin-pull protocol configuration. Valid values are `http`, `https` and `follow`. Default value is `http`.
+* `origin_pull_protocol` - (Optional) Origin-pull protocol configuration. `http`: forced HTTP origin-pull, `follow`: protocol follow origin-pull, `https`: forced HTTPS origin-pull. This only supports origin server port 443 for origin-pull.
 * `server_name` - (Optional) Host header used when accessing the master origin server. If left empty, the acceleration domain name will be used by default.
 
 The `server_certificate_config` object supports the following:
diff --git a/website/docs/r/cos_bucket.html.markdown b/website/docs/r/cos_bucket.html.markdown
@@ -90,7 +90,7 @@ The following arguments are supported:
 The `cors_rules` object supports the following:
 
 * `allowed_headers` - (Required) Specifies which headers are allowed.
-* `allowed_methods` - (Required) Specifies which methods are allowed. Can be GET, PUT, POST, DELETE or HEAD.
+* `allowed_methods` - (Required) Specifies which methods are allowed. Can be `GET`, `PUT`, `POST`, `DELETE` or `HEAD`.
 * `allowed_origins` - (Required) Specifies which origins are allowed.
 * `expose_headers` - (Optional) Specifies expose header in the response.
 * `max_age_seconds` - (Optional) Specifies time in seconds that browser can cache the response for a preflight request.
@@ -108,7 +108,7 @@ The `lifecycle_rules` object supports the following:
 
 The `transition` object supports the following:
 
-* `storage_class` - (Required) Specifies the storage class to which you want the object to transition. Available values include STANDARD, STANDARD_IA and ARCHIVE.
+* `storage_class` - (Required) Specifies the storage class to which you want the object to transition. Available values include `STANDARD`, `STANDARD_IA` and `ARCHIVE`.
 * `date` - (Optional) Specifies the date after which you want the corresponding action to take effect.
 * `days` - (Optional) Specifies the number of days after object creation when the specific rule action takes effect.
 
diff --git a/website/docs/r/instance.html.markdown b/website/docs/r/instance.html.markdown
diff --git a/website/docs/r/service_template.html.markdown b/website/docs/r/service_template.html.markdown
diff --git a/website/docs/r/service_template_group.html.markdown b/website/docs/r/service_template_group.html.markdown
