From 9b8db7c61636c7edef7b0282db0b33b723a08925 Mon Sep 17 00:00:00 2001 From: nickyinluo Date: Tue, 4 Jul 2023 21:06:27 +0800 Subject: [PATCH 1/2] adjust doc gen to support the usage title and usage description --- gendoc/README.md | 28 +++++++++++++++++-- gendoc/main.go | 25 ++++++++++++++--- website/docs/d/cbs_storages.html.markdown | 2 +- ...ynosdb_instance_slow_queries.html.markdown | 6 ++-- .../d/dbbrain_top_space_tables.html.markdown | 4 +-- website/docs/d/dnspod_records.html.markdown | 2 +- .../docs/r/api_gateway_service.html.markdown | 4 +-- .../docs/r/as_scaling_config.html.markdown | 2 +- website/docs/r/cam_role.html.markdown | 4 +-- website/docs/r/ccn.html.markdown | 6 ++-- .../docs/r/ccn_bandwidth_limit.html.markdown | 4 +-- website/docs/r/cdn_domain.html.markdown | 4 +-- website/docs/r/cdn_url_purge.html.markdown | 2 +- website/docs/r/cdn_url_push.html.markdown | 2 +- .../r/cfs_auto_snapshot_policy.html.markdown | 6 ++-- website/docs/r/ckafka_acl.html.markdown | 2 +- website/docs/r/ckafka_instance.html.markdown | 4 +-- website/docs/r/ckafka_user.html.markdown | 2 +- website/docs/r/clb_instance.html.markdown | 10 +++---- website/docs/r/clb_listener.html.markdown | 14 +++++----- website/docs/r/clb_redirection.html.markdown | 4 +-- .../r/clb_replace_cert_for_lbs.html.markdown | 3 ++ website/docs/r/cos_bucket.html.markdown | 20 ++++++------- .../docs/r/cos_bucket_object.html.markdown | 4 +-- ...icate_domain_owner_operation.html.markdown | 4 +-- .../cynosdb_cluster_slave_zone.html.markdown | 4 +-- .../r/cynosdb_proxy_end_point.html.markdown | 15 ++++++++-- ...y_diag_db_instance_operation.html.markdown | 3 ++ .../r/dts_migrate_job_config.html.markdown | 10 +++---- website/docs/r/eip_association.html.markdown | 2 +- website/docs/r/instance.html.markdown | 2 +- .../kubernetes_addon_attachment.html.markdown | 6 ++-- .../kubernetes_auth_attachment.html.markdown | 2 +- .../docs/r/kubernetes_cluster.html.markdown | 10 +++---- .../docs/r/kubernetes_node_pool.html.markdown | 2 +- .../r/kubernetes_scale_worker.html.markdown | 2 +- .../docs/r/monitor_alarm_policy.html.markdown | 6 ++-- ...tor_tmp_exporter_integration.html.markdown | 4 +-- ..._download_restriction_config.html.markdown | 6 ++-- .../docs/r/postgresql_instance.html.markdown | 6 ++-- ...gresql_security_group_config.html.markdown | 4 +-- website/docs/r/redis_instance.html.markdown | 2 +- .../docs/r/redis_param_template.html.markdown | 2 +- website/docs/r/scf_function.html.markdown | 2 +- .../docs/r/security_group_rule.html.markdown | 4 +-- ...erver_config_backup_strategy.html.markdown | 6 ++-- website/docs/r/tcr_instance.html.markdown | 4 +-- website/docs/r/tse_instance.html.markdown | 8 +++--- website/docs/r/vpc.html.markdown | 2 +- website/docs/r/vpn_gateway.html.markdown | 10 +++---- 50 files changed, 174 insertions(+), 118 deletions(-) diff --git a/gendoc/README.md b/gendoc/README.md index 1575b1c516..fcbe76a6db 100644 --- a/gendoc/README.md +++ b/gendoc/README.md @@ -38,7 +38,7 @@ DataSourcesMap: map[string]*schema.Resource{ description 包括一个用于表头的一句话描述,与一个用于正文的详细说明。 example usage 则是一个或几个使用示例。 -description & example usage 需要在对应 resource 及 data_source 定义的文件中出现,它是符合 golang 标准文档注释的写法。例如: +description & example usage & usage description 需要在对应 resource 及 data_source 定义的文件中出现,它是符合 golang 标准文档注释的写法。例如: /* Use this data source to get information about a MySQL instance. @@ -47,6 +47,21 @@ description & example usage 需要在对应 resource 及 data_source 定义的 \n Example Usage \n + Usage1 title + \n + Description of the Usage1 + \n + ```hcl + data "tencentcloud_mysql_instance" "database"{ + mysql_id = "my-test-database" + result_output_file = "mytestpath" + } + ``` + \n + Usage2 title + \n + Description of the Usage2 + \n ```hcl data "tencentcloud_mysql_instance" "database"{ mysql_id = "my-test-database" @@ -65,7 +80,16 @@ description & example usage 需要在对应 resource 及 data_source 定义的 \n Example Usage \n - Example Usage 是必须的,在 Example Usage 以下的内容都会当成 Example Usage 填充到文档中。 + Example Usage 是必须的,在 Example Usage 以下的内容都会填充到文档中。 + Example Usage 由一个到多个Usage构成。 + 每个Usage 由 Usage title 和 Usage description 构成。 + \n + Usage1 title + \n + Description of the Usage1 + \n + Usage title 是必须的。 + Usage description 是可选的,可以根据情况填写。 */ package tencentcloud diff --git a/gendoc/main.go b/gendoc/main.go index 36cfc6ff7a..82d4b0e3d5 100644 --- a/gendoc/main.go +++ b/gendoc/main.go @@ -28,8 +28,9 @@ const ( ) var ( - hclMatch = regexp.MustCompile("(?si)([^`]+)?```(hcl)?(.*?)```") - bigSymbol = regexp.MustCompile("([\u007F-\uffff])") + hclMatch = regexp.MustCompile("(?si)([^`]+)?```(hcl)?(.*?)```") + usageMatch = regexp.MustCompile(`(?s)(?m)^([^ \n].*?)(?:\n{2}|$)(.*)`) + bigSymbol = regexp.MustCompile("([\u007F-\uffff])") ) func main() { @@ -407,16 +408,32 @@ func formatHCL(s string) string { for _, v := range m { p := strings.TrimSpace(v[1]) if p != "" { - p = fmt.Sprintf("\n%s\n\n", p) + p = formatUsageDesc(p) } b := hclwrite.Format([]byte(strings.TrimSpace(v[3]))) - rr = append(rr, fmt.Sprintf("%s```hcl\n%s\n```", p, string(b))) + rr = append(rr, fmt.Sprintf("\n%s\n\n```hcl\n%s\n```", p, string(b))) } } return strings.TrimSpace(strings.Join(rr, "\n")) } +func formatUsageDesc(s string) string { + var rr []string + s = strings.TrimSpace(s) + m := usageMatch.FindAllStringSubmatch(s, -1) + + for _, v := range m { + title := strings.TrimSpace(v[1]) + descp := strings.TrimSpace(v[2]) + + rr = append(rr, fmt.Sprintf("### %s\n\n%s", title, descp)) + } + + ret := strings.TrimSpace(strings.Join(rr, "\n\n")) + return ret +} + // checkDescription check description format func checkDescription(k, s string) { if s == "" { diff --git a/website/docs/d/cbs_storages.html.markdown b/website/docs/d/cbs_storages.html.markdown index 677435cbcc..4928f59295 100644 --- a/website/docs/d/cbs_storages.html.markdown +++ b/website/docs/d/cbs_storages.html.markdown @@ -20,7 +20,7 @@ data "tencentcloud_cbs_storages" "storages" { } ``` -The following snippet shows the new supported query params +### The following snippet shows the new supported query params ```hcl data "tencentcloud_cbs_storages" "whats_new" { diff --git a/website/docs/d/cynosdb_instance_slow_queries.html.markdown b/website/docs/d/cynosdb_instance_slow_queries.html.markdown index a6c5e27725..bd6d5c5a7d 100644 --- a/website/docs/d/cynosdb_instance_slow_queries.html.markdown +++ b/website/docs/d/cynosdb_instance_slow_queries.html.markdown @@ -13,7 +13,7 @@ Use this data source to query detailed information of cynosdb instance_slow_quer ## Example Usage -Query slow queries of instance +### Query slow queries of instance ```hcl variable "cynosdb_cluster_id" { @@ -32,7 +32,7 @@ data "tencentcloud_cynosdb_instance_slow_queries" "instance_slow_queries" { } ``` -Query slow queries by time range +### Query slow queries by time range ```hcl variable "cynosdb_cluster_id" { @@ -48,7 +48,7 @@ data "tencentcloud_cynosdb_instance_slow_queries" "instance_slow_queries" { } ``` -Query slow queries by user and db name +### Query slow queries by user and db name ```hcl variable "cynosdb_cluster_id" { diff --git a/website/docs/d/dbbrain_top_space_tables.html.markdown b/website/docs/d/dbbrain_top_space_tables.html.markdown index 2fb726c139..79b70d49c4 100644 --- a/website/docs/d/dbbrain_top_space_tables.html.markdown +++ b/website/docs/d/dbbrain_top_space_tables.html.markdown @@ -13,7 +13,7 @@ Use this data source to query detailed information of dbbrain top_space_tables ## Example Usage -Sort by PhysicalFileSize +### Sort by PhysicalFileSize ```hcl data "tencentcloud_dbbrain_top_space_tables" "top_space_tables" { @@ -23,7 +23,7 @@ data "tencentcloud_dbbrain_top_space_tables" "top_space_tables" { } ``` -Sort by TotalLength +### Sort by TotalLength ```hcl data "tencentcloud_dbbrain_top_space_tables" "top_space_tables" { diff --git a/website/docs/d/dnspod_records.html.markdown b/website/docs/d/dnspod_records.html.markdown index 546463d3fe..a6cd63dc97 100644 --- a/website/docs/d/dnspod_records.html.markdown +++ b/website/docs/d/dnspod_records.html.markdown @@ -24,7 +24,7 @@ output "result" { } ``` -Use verbose filter +### Use verbose filter ```hcl data "tencentcloud_dnspod_records" "record" { diff --git a/website/docs/r/api_gateway_service.html.markdown b/website/docs/r/api_gateway_service.html.markdown index 549bfd8c55..321dd281a2 100644 --- a/website/docs/r/api_gateway_service.html.markdown +++ b/website/docs/r/api_gateway_service.html.markdown @@ -13,7 +13,7 @@ Use this resource to create API gateway service. ## Example Usage -Shared Service +### Shared Service ```hcl resource "tencentcloud_api_gateway_service" "service" { @@ -32,7 +32,7 @@ resource "tencentcloud_api_gateway_service" "service" { } ``` -Exclusive Service +### Exclusive Service ```hcl resource "tencentcloud_api_gateway_service" "service" { diff --git a/website/docs/r/as_scaling_config.html.markdown b/website/docs/r/as_scaling_config.html.markdown index 272bbb7ca9..4af500b319 100644 --- a/website/docs/r/as_scaling_config.html.markdown +++ b/website/docs/r/as_scaling_config.html.markdown @@ -43,7 +43,7 @@ resource "tencentcloud_as_scaling_config" "launch_configuration" { } ``` -Using SPOT charge type +### Using SPOT charge type ```hcl resource "tencentcloud_as_scaling_config" "launch_configuration" { diff --git a/website/docs/r/cam_role.html.markdown b/website/docs/r/cam_role.html.markdown index 819ab6f3b3..08d983f77b 100644 --- a/website/docs/r/cam_role.html.markdown +++ b/website/docs/r/cam_role.html.markdown @@ -13,7 +13,7 @@ Provides a resource to create a CAM role. ## Example Usage -Create normally +### Create normally ```hcl resource "tencentcloud_cam_role" "foo" { @@ -40,7 +40,7 @@ EOF } ``` -Create with SAML provider +### Create with SAML provider ```hcl resource "tencentcloud_cam_role" "boo" { diff --git a/website/docs/r/ccn.html.markdown b/website/docs/r/ccn.html.markdown index afdd2ef3e7..df7be53639 100644 --- a/website/docs/r/ccn.html.markdown +++ b/website/docs/r/ccn.html.markdown @@ -13,7 +13,7 @@ Provides a resource to create a CCN instance. ## Example Usage -Create a prepaid CCN +### Create a prepaid CCN ```hcl resource "tencentcloud_ccn" "main" { @@ -25,7 +25,7 @@ resource "tencentcloud_ccn" "main" { } ``` -Create a post-paid regional export speed limit type CCN +### Create a post-paid regional export speed limit type CCN ```hcl resource "tencentcloud_ccn" "main" { @@ -37,7 +37,7 @@ resource "tencentcloud_ccn" "main" { } ``` -Create a post-paid inter-regional rate limit type CNN +### Create a post-paid inter-regional rate limit type CNN ```hcl resource "tencentcloud_ccn" "main" { diff --git a/website/docs/r/ccn_bandwidth_limit.html.markdown b/website/docs/r/ccn_bandwidth_limit.html.markdown index f8356287f3..e4d16142c1 100644 --- a/website/docs/r/ccn_bandwidth_limit.html.markdown +++ b/website/docs/r/ccn_bandwidth_limit.html.markdown @@ -13,7 +13,7 @@ Provides a resource to limit CCN bandwidth. ## Example Usage -Set the upper limit of regional outbound bandwidth +### Set the upper limit of regional outbound bandwidth ```hcl variable "other_region1" { @@ -33,7 +33,7 @@ resource "tencentcloud_ccn_bandwidth_limit" "limit1" { } ``` -Set the upper limit between regions +### Set the upper limit between regions ```hcl variable "other_region1" { diff --git a/website/docs/r/cdn_domain.html.markdown b/website/docs/r/cdn_domain.html.markdown index e790c0d4df..6320c08807 100644 --- a/website/docs/r/cdn_domain.html.markdown +++ b/website/docs/r/cdn_domain.html.markdown @@ -48,7 +48,7 @@ resource "tencentcloud_cdn_domain" "foo" { } ``` -Example Usage of cdn uses cache and request headers +### Example Usage of cdn uses cache and request headers ```hcl resource "tencentcloud_cdn_domain" "foo" { @@ -105,7 +105,7 @@ resource "tencentcloud_cdn_domain" "foo" { } ``` -Example Usage of COS bucket url as origin +### Example Usage of COS bucket url as origin ```hcl resource "tencentcloud_cos_bucket" "bucket" { diff --git a/website/docs/r/cdn_url_purge.html.markdown b/website/docs/r/cdn_url_purge.html.markdown index 20b0520035..7ad33d6e61 100644 --- a/website/docs/r/cdn_url_purge.html.markdown +++ b/website/docs/r/cdn_url_purge.html.markdown @@ -21,7 +21,7 @@ resource "tencentcloud_cdn_url_purge" "foo" { } ``` -argument to request new purge task with same urls +### argument to request new purge task with same urls ```hcl resource "tencentcloud_cdn_url_purge" "foo" { diff --git a/website/docs/r/cdn_url_push.html.markdown b/website/docs/r/cdn_url_push.html.markdown index 3f659aa76e..cc537c0eb5 100644 --- a/website/docs/r/cdn_url_push.html.markdown +++ b/website/docs/r/cdn_url_push.html.markdown @@ -19,7 +19,7 @@ resource "tencentcloud_cdn_url_push" "foo" { } ``` -argument to request new push task with same urls +### argument to request new push task with same urls ```hcl resource "tencentcloud_cdn_url_push" "foo" { diff --git a/website/docs/r/cfs_auto_snapshot_policy.html.markdown b/website/docs/r/cfs_auto_snapshot_policy.html.markdown index a6df52a1ee..3713416278 100644 --- a/website/docs/r/cfs_auto_snapshot_policy.html.markdown +++ b/website/docs/r/cfs_auto_snapshot_policy.html.markdown @@ -13,7 +13,7 @@ Provides a resource to create a cfs auto_snapshot_policy ## Example Usage -use day of week +### use day of week ```hcl resource "tencentcloud_cfs_auto_snapshot_policy" "auto_snapshot_policy" { @@ -24,7 +24,7 @@ resource "tencentcloud_cfs_auto_snapshot_policy" "auto_snapshot_policy" { } ``` -use day of month +### use day of month ```hcl resource "tencentcloud_cfs_auto_snapshot_policy" "auto_snapshot_policy" { @@ -35,7 +35,7 @@ resource "tencentcloud_cfs_auto_snapshot_policy" "auto_snapshot_policy" { } ``` -use interval days +### use interval days ```hcl resource "tencentcloud_cfs_auto_snapshot_policy" "auto_snapshot_policy" { diff --git a/website/docs/r/ckafka_acl.html.markdown b/website/docs/r/ckafka_acl.html.markdown index d7866b56e2..630361f41e 100644 --- a/website/docs/r/ckafka_acl.html.markdown +++ b/website/docs/r/ckafka_acl.html.markdown @@ -13,7 +13,7 @@ Provides a resource to create a Ckafka Acl. ## Example Usage -Ckafka Acl +### Ckafka Acl ```hcl resource "tencentcloud_ckafka_acl" "foo" { diff --git a/website/docs/r/ckafka_instance.html.markdown b/website/docs/r/ckafka_instance.html.markdown index 87371108a6..dd447ac9d7 100644 --- a/website/docs/r/ckafka_instance.html.markdown +++ b/website/docs/r/ckafka_instance.html.markdown @@ -15,7 +15,7 @@ Use this resource to create ckafka instance. ## Example Usage -Basic Instance +### Basic Instance ```hcl variable "vpc_id" { @@ -58,7 +58,7 @@ resource "tencentcloud_ckafka_instance" "kafka_instance" { } ``` -Multi zone Instance +### Multi zone Instance ```hcl variable "vpc_id" { diff --git a/website/docs/r/ckafka_user.html.markdown b/website/docs/r/ckafka_user.html.markdown index 3dd462c7b3..9f074f814f 100644 --- a/website/docs/r/ckafka_user.html.markdown +++ b/website/docs/r/ckafka_user.html.markdown @@ -13,7 +13,7 @@ Provides a resource to create a Ckafka user. ## Example Usage -Ckafka User +### Ckafka User ```hcl resource "tencentcloud_ckafka_user" "foo" { diff --git a/website/docs/r/clb_instance.html.markdown b/website/docs/r/clb_instance.html.markdown index c218981518..a055b74257 100644 --- a/website/docs/r/clb_instance.html.markdown +++ b/website/docs/r/clb_instance.html.markdown @@ -13,7 +13,7 @@ Provides a resource to create a CLB instance. ## Example Usage -INTERNAL CLB +### INTERNAL CLB ```hcl resource "tencentcloud_clb_instance" "internal_clb" { @@ -29,7 +29,7 @@ resource "tencentcloud_clb_instance" "internal_clb" { } ``` -OPEN CLB +### OPEN CLB ```hcl resource "tencentcloud_clb_instance" "open_clb" { @@ -47,7 +47,7 @@ resource "tencentcloud_clb_instance" "open_clb" { } ``` -Default enable +### Default enable ```hcl resource "tencentcloud_subnet" "subnet" { @@ -90,7 +90,7 @@ resource "tencentcloud_clb_instance" "open_clb" { } ``` -CREATE multiple instance +### CREATE multiple instance ```hcl resource "tencentcloud_clb_instance" "open_clb1" { @@ -100,7 +100,7 @@ resource "tencentcloud_clb_instance" "open_clb1" { } ``` -CREATE instance with log +### CREATE instance with log ```hcl resource "tencentcloud_vpc" "vpc_test" { diff --git a/website/docs/r/clb_listener.html.markdown b/website/docs/r/clb_listener.html.markdown index fcc4881adf..01f6c7cd07 100644 --- a/website/docs/r/clb_listener.html.markdown +++ b/website/docs/r/clb_listener.html.markdown @@ -13,7 +13,7 @@ Provides a resource to create a CLB listener. ## Example Usage -HTTP Listener +### HTTP Listener ```hcl resource "tencentcloud_clb_listener" "HTTP_listener" { @@ -24,7 +24,7 @@ resource "tencentcloud_clb_listener" "HTTP_listener" { } ``` -TCP/UDP Listener +### TCP/UDP Listener ```hcl resource "tencentcloud_clb_listener" "TCP_listener" { @@ -47,7 +47,7 @@ resource "tencentcloud_clb_listener" "TCP_listener" { } ``` -TCP/UDP Listener with tcp health check +### TCP/UDP Listener with tcp health check ```hcl resource "tencentcloud_clb_listener" "listener_tcp" { @@ -67,7 +67,7 @@ resource "tencentcloud_clb_listener" "listener_tcp" { } ``` -TCP/UDP Listener with http health check +### TCP/UDP Listener with http health check ```hcl resource "tencentcloud_clb_listener" "listener_tcp" { @@ -91,7 +91,7 @@ resource "tencentcloud_clb_listener" "listener_tcp" { } ``` -TCP/UDP Listener with customer health check +### TCP/UDP Listener with customer health check ```hcl resource "tencentcloud_clb_listener" "listener_tcp" { @@ -114,7 +114,7 @@ resource "tencentcloud_clb_listener" "listener_tcp" { } ``` -HTTPS Listener +### HTTPS Listener ```hcl resource "tencentcloud_clb_listener" "HTTPS_listener" { @@ -129,7 +129,7 @@ resource "tencentcloud_clb_listener" "HTTPS_listener" { } ``` -TCP SSL Listener +### TCP SSL Listener ```hcl resource "tencentcloud_clb_listener" "TCPSSL_listener" { diff --git a/website/docs/r/clb_redirection.html.markdown b/website/docs/r/clb_redirection.html.markdown index 1564d5d11f..44ed0935b6 100644 --- a/website/docs/r/clb_redirection.html.markdown +++ b/website/docs/r/clb_redirection.html.markdown @@ -13,7 +13,7 @@ Provides a resource to create a CLB redirection. ## Example Usage -Manual Rewrite +### Manual Rewrite ```hcl resource "tencentcloud_clb_redirection" "foo" { @@ -25,7 +25,7 @@ resource "tencentcloud_clb_redirection" "foo" { } ``` -Auto Rewrite +### Auto Rewrite ```hcl resource "tencentcloud_clb_redirection" "foo" { diff --git a/website/docs/r/clb_replace_cert_for_lbs.html.markdown b/website/docs/r/clb_replace_cert_for_lbs.html.markdown index 3ce9479ab0..57b2a6e406 100644 --- a/website/docs/r/clb_replace_cert_for_lbs.html.markdown +++ b/website/docs/r/clb_replace_cert_for_lbs.html.markdown @@ -22,6 +22,9 @@ resource "tencentcloud_clb_replace_cert_for_lbs" "replace_cert_for_lbs" { } } ``` + + + ```hcl terraform import tencentcloud_clb_replace_cert_for_lbs.replace_cert_for_lbs replace_cert_for_lbs_id ``` diff --git a/website/docs/r/cos_bucket.html.markdown b/website/docs/r/cos_bucket.html.markdown index b51c0b6b8a..b5468801a7 100644 --- a/website/docs/r/cos_bucket.html.markdown +++ b/website/docs/r/cos_bucket.html.markdown @@ -13,7 +13,7 @@ Provides a COS resource to create a COS bucket and set its attributes. ## Example Usage -Private Bucket +### Private Bucket ```hcl resource "tencentcloud_cos_bucket" "mycos" { @@ -22,7 +22,7 @@ resource "tencentcloud_cos_bucket" "mycos" { } ``` -Creation of multiple available zone bucket +### Creation of multiple available zone bucket ```hcl resource "tencentcloud_cos_bucket" "mycos" { @@ -34,7 +34,7 @@ resource "tencentcloud_cos_bucket" "mycos" { } ``` -Using verbose acl +### Using verbose acl ```hcl resource "tencentcloud_cos_bucket" "with_acl_body" { @@ -105,7 +105,7 @@ EOF } ``` -Static Website +### Static Website ```hcl resource "tencentcloud_cos_bucket" "mycos" { @@ -122,7 +122,7 @@ output "endpoint_test" { } ``` -Using CORS +### Using CORS ```hcl resource "tencentcloud_cos_bucket" "mycos" { @@ -139,7 +139,7 @@ resource "tencentcloud_cos_bucket" "mycos" { } ``` -Using object lifecycle +### Using object lifecycle ```hcl resource "tencentcloud_cos_bucket" "mycos" { @@ -161,7 +161,7 @@ resource "tencentcloud_cos_bucket" "mycos" { } ``` -Using custom origin domain settings +### Using custom origin domain settings ```hcl resource "tencentcloud_cos_bucket" "with_origin" { @@ -175,7 +175,7 @@ resource "tencentcloud_cos_bucket" "with_origin" { } ``` -Using origin-pull settings +### Using origin-pull settings ```hcl resource "tencentcloud_cos_bucket" "with_origin" { @@ -197,7 +197,7 @@ resource "tencentcloud_cos_bucket" "with_origin" { } ``` -Using replication +### Using replication ```hcl resource "tencentcloud_cos_bucket" "replica1" { @@ -220,7 +220,7 @@ resource "tencentcloud_cos_bucket" "with_replication" { } ``` -Setting log status +### Setting log status ```hcl resource "tencentcloud_cam_role" "cosLogGrant" { diff --git a/website/docs/r/cos_bucket_object.html.markdown b/website/docs/r/cos_bucket_object.html.markdown index c2d5b01836..b698c6254c 100644 --- a/website/docs/r/cos_bucket_object.html.markdown +++ b/website/docs/r/cos_bucket_object.html.markdown @@ -13,7 +13,7 @@ Provides a COS object resource to put an object(content or file) to the bucket. ## Example Usage -Uploading a file to a bucket +### Uploading a file to a bucket ```hcl resource "tencentcloud_cos_bucket_object" "myobject" { @@ -23,7 +23,7 @@ resource "tencentcloud_cos_bucket_object" "myobject" { } ``` -Uploading a content to a bucket +### Uploading a content to a bucket ```hcl resource "tencentcloud_cos_bucket" "mycos" { diff --git a/website/docs/r/css_authenticate_domain_owner_operation.html.markdown b/website/docs/r/css_authenticate_domain_owner_operation.html.markdown index 2c836e4a42..107d4eca99 100644 --- a/website/docs/r/css_authenticate_domain_owner_operation.html.markdown +++ b/website/docs/r/css_authenticate_domain_owner_operation.html.markdown @@ -13,7 +13,7 @@ Provides a resource to verify the domain ownership by specified way when DomainN ## Example Usage -dnsCheck way: +### dnsCheck way: ```hcl resource "tencentcloud_css_authenticate_domain_owner_operation" "dnsCheck" { @@ -22,7 +22,7 @@ resource "tencentcloud_css_authenticate_domain_owner_operation" "dnsCheck" { } ``` -fileCheck way: +### fileCheck way: ```hcl resource "tencentcloud_css_authenticate_domain_owner_operation" "fileCheck" { diff --git a/website/docs/r/cynosdb_cluster_slave_zone.html.markdown b/website/docs/r/cynosdb_cluster_slave_zone.html.markdown index 7d190f35d6..e7ee472eab 100644 --- a/website/docs/r/cynosdb_cluster_slave_zone.html.markdown +++ b/website/docs/r/cynosdb_cluster_slave_zone.html.markdown @@ -13,7 +13,7 @@ Provides a resource to create a cynosdb cluster slave zone. ## Example Usage -Set a new slave zone for a cynosdb cluster. +### Set a new slave zone for a cynosdb cluster. ```hcl locals { @@ -104,7 +104,7 @@ resource "tencentcloud_cynosdb_cluster_slave_zone" "cluster_slave_zone" { } ``` -Update the slave zone with specified value. +### Update the slave zone with specified value. ```hcl resource "tencentcloud_cynosdb_cluster_slave_zone" "cluster_slave_zone" { diff --git a/website/docs/r/cynosdb_proxy_end_point.html.markdown b/website/docs/r/cynosdb_proxy_end_point.html.markdown index 94a628c28c..264bae949c 100644 --- a/website/docs/r/cynosdb_proxy_end_point.html.markdown +++ b/website/docs/r/cynosdb_proxy_end_point.html.markdown @@ -24,6 +24,9 @@ resource "tencentcloud_cynosdb_proxy_end_point" "proxy_end_point" { } } ``` + + + ```hcl resource "tencentcloud_cynosdb_proxy_end_point" "proxy_end_point" { cluster_id = "cynosdbmysql-bws8h88b" @@ -38,7 +41,7 @@ resource "tencentcloud_cynosdb_proxy_end_point" "proxy_end_point" { } ``` -Open connection pool +### Open connection pool ```hcl resource "tencentcloud_cynosdb_proxy_end_point" "proxy_end_point" { @@ -57,7 +60,7 @@ resource "tencentcloud_cynosdb_proxy_end_point" "proxy_end_point" { } ``` -Close connection pool +### Close connection pool ```hcl resource "tencentcloud_cynosdb_proxy_end_point" "proxy_end_point" { @@ -73,6 +76,9 @@ resource "tencentcloud_cynosdb_proxy_end_point" "proxy_end_point" { } } ``` + + + ```hcl resource "tencentcloud_cynosdb_proxy_end_point" "proxy_end_point" { cluster_id = "cynosdbmysql-bws8h88b" @@ -91,6 +97,9 @@ resource "tencentcloud_cynosdb_proxy_end_point" "proxy_end_point" { } } ``` + + + ```hcl resource "tencentcloud_cynosdb_proxy_end_point" "proxy_end_point" { cluster_id = "cynosdbmysql-bws8h88b" @@ -107,7 +116,7 @@ resource "tencentcloud_cynosdb_proxy_end_point" "proxy_end_point" { } ``` -Comprehensive parameter examples +### Comprehensive parameter examples ```hcl resource "tencentcloud_cynosdb_proxy_end_point" "proxy_end_point" { diff --git a/website/docs/r/dbbrain_modify_diag_db_instance_operation.html.markdown b/website/docs/r/dbbrain_modify_diag_db_instance_operation.html.markdown index 87a7b1248a..ece04f8d12 100644 --- a/website/docs/r/dbbrain_modify_diag_db_instance_operation.html.markdown +++ b/website/docs/r/dbbrain_modify_diag_db_instance_operation.html.markdown @@ -23,6 +23,9 @@ resource "tencentcloud_dbbrain_modify_diag_db_instance_operation" "on" { instance_ids = ["%s"] } ``` + + + ```hcl resource "tencentcloud_dbbrain_modify_diag_db_instance_operation" "off" { instance_confs { diff --git a/website/docs/r/dts_migrate_job_config.html.markdown b/website/docs/r/dts_migrate_job_config.html.markdown index b037bef894..9c9ba911a0 100644 --- a/website/docs/r/dts_migrate_job_config.html.markdown +++ b/website/docs/r/dts_migrate_job_config.html.markdown @@ -82,7 +82,7 @@ resource "tencentcloud_dts_migrate_job_config" "config" { } ``` -Continue the a migration job +### Continue the a migration job ```hcl resource "tencentcloud_dts_migrate_job_config" "config" { @@ -91,7 +91,7 @@ resource "tencentcloud_dts_migrate_job_config" "config" { } ``` -Complete a migration job when the status is readyComplete +### Complete a migration job when the status is readyComplete ```hcl resource "tencentcloud_dts_migrate_job_config" "config" { @@ -100,7 +100,7 @@ resource "tencentcloud_dts_migrate_job_config" "config" { } ``` -Stop a running migration job +### Stop a running migration job ```hcl resource "tencentcloud_dts_migrate_job_config" "config" { @@ -109,7 +109,7 @@ resource "tencentcloud_dts_migrate_job_config" "config" { } ``` -Isolate a stopped/canceled migration job +### Isolate a stopped/canceled migration job ```hcl resource "tencentcloud_dts_migrate_job_config" "config" { @@ -118,7 +118,7 @@ resource "tencentcloud_dts_migrate_job_config" "config" { } ``` -Recover a isolated migration job +### Recover a isolated migration job ```hcl resource "tencentcloud_dts_migrate_job_config" "config" { diff --git a/website/docs/r/eip_association.html.markdown b/website/docs/r/eip_association.html.markdown index c3b49dacdf..ee3f040299 100644 --- a/website/docs/r/eip_association.html.markdown +++ b/website/docs/r/eip_association.html.markdown @@ -22,7 +22,7 @@ resource "tencentcloud_eip_association" "foo" { } ``` -or +### or ```hcl resource "tencentcloud_eip_association" "bar" { diff --git a/website/docs/r/instance.html.markdown b/website/docs/r/instance.html.markdown index a1378387df..64a85d94af 100644 --- a/website/docs/r/instance.html.markdown +++ b/website/docs/r/instance.html.markdown @@ -75,7 +75,7 @@ resource "tencentcloud_instance" "my_awesome_app" { } ``` -Create CVM instance based on CDH +### Create CVM instance based on CDH ```hcl variable "availability_zone" { diff --git a/website/docs/r/kubernetes_addon_attachment.html.markdown b/website/docs/r/kubernetes_addon_attachment.html.markdown index 3619f2cd4e..0be2227882 100644 --- a/website/docs/r/kubernetes_addon_attachment.html.markdown +++ b/website/docs/r/kubernetes_addon_attachment.html.markdown @@ -15,7 +15,7 @@ Provide a resource to configure kubernetes cluster app addons. ## Example Usage -Install cbs addon by passing values +### Install cbs addon by passing values ```hcl resource "tencentcloud_kubernetes_addon_attachment" "addon_cbs" { @@ -28,7 +28,7 @@ resource "tencentcloud_kubernetes_addon_attachment" "addon_cbs" { } ``` -Install tcr addon by passing values +### Install tcr addon by passing values ```hcl resource "tencentcloud_kubernetes_addon_attachment" "addon_tcr" { @@ -104,7 +104,7 @@ resource "tencentcloud_tcr_namespace" "my_ns" { } ``` -Install new addon by passing spec json to req_body directly +### Install new addon by passing spec json to req_body directly ```hcl resource "tencentcloud_kubernetes_addon_attachment" "addon_cbs" { diff --git a/website/docs/r/kubernetes_auth_attachment.html.markdown b/website/docs/r/kubernetes_auth_attachment.html.markdown index 67efbe5a9e..34bf068ca7 100644 --- a/website/docs/r/kubernetes_auth_attachment.html.markdown +++ b/website/docs/r/kubernetes_auth_attachment.html.markdown @@ -80,7 +80,7 @@ resource "tencentcloud_kubernetes_auth_attachment" "test_auth_attach" { } ``` -Use the TKE default issuer and jwks_uri +### Use the TKE default issuer and jwks_uri ```hcl variable "availability_zone" { diff --git a/website/docs/r/kubernetes_cluster.html.markdown b/website/docs/r/kubernetes_cluster.html.markdown index a0b4af0186..c21dda7dc1 100644 --- a/website/docs/r/kubernetes_cluster.html.markdown +++ b/website/docs/r/kubernetes_cluster.html.markdown @@ -111,7 +111,7 @@ resource "tencentcloud_kubernetes_cluster" "managed_cluster" { } ``` -Use Kubelet +### Use Kubelet ```hcl variable "availability_zone_first" { @@ -209,7 +209,7 @@ resource "tencentcloud_kubernetes_cluster" "managed_cluster" { } ``` -Use extension addons +### Use extension addons ```hcl variable "availability_zone_first" { @@ -297,7 +297,7 @@ resource "tencentcloud_kubernetes_cluster" "cluster_with_addon" { } ``` -Use node pool global config +### Use node pool global config ```hcl variable "availability_zone" { @@ -369,7 +369,7 @@ resource "tencentcloud_kubernetes_cluster" "test_node_pool_global_config" { } ``` -Using VPC-CNI network type +### Using VPC-CNI network type ```hcl variable "availability_zone" { @@ -427,7 +427,7 @@ resource "tencentcloud_kubernetes_cluster" "managed_cluster" { } ``` -Using ops options +### Using ops options ```hcl resource "tencentcloud_kubernetes_cluster" "managed_cluster" { diff --git a/website/docs/r/kubernetes_node_pool.html.markdown b/website/docs/r/kubernetes_node_pool.html.markdown index 222279c993..02d81ed6dd 100644 --- a/website/docs/r/kubernetes_node_pool.html.markdown +++ b/website/docs/r/kubernetes_node_pool.html.markdown @@ -108,7 +108,7 @@ resource "tencentcloud_kubernetes_node_pool" "mynodepool" { } ``` -Using Spot CVM Instance +### Using Spot CVM Instance ```hcl resource "tencentcloud_kubernetes_node_pool" "mynodepool" { diff --git a/website/docs/r/kubernetes_scale_worker.html.markdown b/website/docs/r/kubernetes_scale_worker.html.markdown index cfe6041e15..93036d4833 100644 --- a/website/docs/r/kubernetes_scale_worker.html.markdown +++ b/website/docs/r/kubernetes_scale_worker.html.markdown @@ -59,7 +59,7 @@ resource tencentcloud_kubernetes_scale_worker test_scale { } ``` -Use Kubelet +### Use Kubelet ```hcl variable "availability_zone" { diff --git a/website/docs/r/monitor_alarm_policy.html.markdown b/website/docs/r/monitor_alarm_policy.html.markdown index f4ceea2269..c2050ca73e 100644 --- a/website/docs/r/monitor_alarm_policy.html.markdown +++ b/website/docs/r/monitor_alarm_policy.html.markdown @@ -13,7 +13,7 @@ Provides a alarm policy resource for monitor. ## Example Usage -cvm_device alarm policy +### cvm_device alarm policy ```hcl resource "tencentcloud_monitor_alarm_policy" "group" { @@ -49,7 +49,7 @@ resource "tencentcloud_monitor_alarm_policy" "group" { } ``` -k8s_cluster alarm policy +### k8s_cluster alarm policy ```hcl resource "tencentcloud_monitor_alarm_policy" "policy" { @@ -141,7 +141,7 @@ resource "tencentcloud_monitor_alarm_policy" "policy" { } ``` -cvm_device alarm policy binding cvm by tag +### cvm_device alarm policy binding cvm by tag ```hcl resource "tencentcloud_monitor_alarm_policy" "policy" { diff --git a/website/docs/r/monitor_tmp_exporter_integration.html.markdown b/website/docs/r/monitor_tmp_exporter_integration.html.markdown index a90d7b3899..d36296027e 100644 --- a/website/docs/r/monitor_tmp_exporter_integration.html.markdown +++ b/website/docs/r/monitor_tmp_exporter_integration.html.markdown @@ -15,7 +15,7 @@ Provides a resource to create a monitor tmpExporterIntegration ## Example Usage -Use blackbox-exporter +### Use blackbox-exporter ```hcl resource "tencentcloud_monitor_tmp_exporter_integration" "tmpExporterIntegration" { @@ -27,7 +27,7 @@ resource "tencentcloud_monitor_tmp_exporter_integration" "tmpExporterIntegration } ``` -Use es-exporter +### Use es-exporter ```hcl resource "tencentcloud_monitor_tmp_exporter_integration" "tmpExporterIntegrationEs" { diff --git a/website/docs/r/postgresql_backup_download_restriction_config.html.markdown b/website/docs/r/postgresql_backup_download_restriction_config.html.markdown index 7e6fd8a9be..efff8441d1 100644 --- a/website/docs/r/postgresql_backup_download_restriction_config.html.markdown +++ b/website/docs/r/postgresql_backup_download_restriction_config.html.markdown @@ -13,7 +13,7 @@ Provides a resource to create a postgresql backup_download_restriction_config ## Example Usage -Unlimit the restriction of the backup file download. +### Unlimit the restriction of the backup file download. ```hcl resource "tencentcloud_postgresql_backup_download_restriction_config" "backup_download_restriction_config" { @@ -21,7 +21,7 @@ resource "tencentcloud_postgresql_backup_download_restriction_config" "backup_do } ``` -Set the download only to allow the intranet downloads. +### Set the download only to allow the intranet downloads. ```hcl resource "tencentcloud_postgresql_backup_download_restriction_config" "backup_download_restriction_config" { @@ -29,7 +29,7 @@ resource "tencentcloud_postgresql_backup_download_restriction_config" "backup_do } ``` -Restrict the backup file download by customizing. +### Restrict the backup file download by customizing. ```hcl resource "tencentcloud_vpc" "pg_vpc" { diff --git a/website/docs/r/postgresql_instance.html.markdown b/website/docs/r/postgresql_instance.html.markdown index 658e6b8544..febc2eb9d1 100644 --- a/website/docs/r/postgresql_instance.html.markdown +++ b/website/docs/r/postgresql_instance.html.markdown @@ -56,7 +56,7 @@ resource "tencentcloud_postgresql_instance" "foo" { } ``` -Create a multi available zone bucket +### Create a multi available zone bucket ```hcl variable "availability_zone" { @@ -111,7 +111,7 @@ resource "tencentcloud_postgresql_instance" "foo" { } ``` -create pgsql with kms key +### create pgsql with kms key ```hcl resource "tencentcloud_postgresql_instance" "pg" { @@ -145,7 +145,7 @@ resource "tencentcloud_postgresql_instance" "pg" { } ``` -upgrade kernel version +### upgrade kernel version ```hcl resource "tencentcloud_postgresql_instance" "test" { diff --git a/website/docs/r/postgresql_security_group_config.html.markdown b/website/docs/r/postgresql_security_group_config.html.markdown index 15a30ffa74..f643b7d6fa 100644 --- a/website/docs/r/postgresql_security_group_config.html.markdown +++ b/website/docs/r/postgresql_security_group_config.html.markdown @@ -13,7 +13,7 @@ Provides a resource to create a postgresql security_group_config ## Example Usage -Set security group for the sepcified postgres instance +### Set security group for the sepcified postgres instance ```hcl resource "tencentcloud_postgresql_security_group_config" "security_group_config" { @@ -22,7 +22,7 @@ resource "tencentcloud_postgresql_security_group_config" "security_group_config" } ``` -Set security group for the specified readonly group +### Set security group for the specified readonly group ```hcl resource "tencentcloud_postgresql_readonly_group" "group" { diff --git a/website/docs/r/redis_instance.html.markdown b/website/docs/r/redis_instance.html.markdown index 6133ec082f..4826eb05bf 100644 --- a/website/docs/r/redis_instance.html.markdown +++ b/website/docs/r/redis_instance.html.markdown @@ -33,7 +33,7 @@ resource "tencentcloud_redis_instance" "redis_instance_test_2" { } ``` -Using multi replica zone set +### Using multi replica zone set ```hcl data "tencentcloud_availability_zones" "az" { diff --git a/website/docs/r/redis_param_template.html.markdown b/website/docs/r/redis_param_template.html.markdown index f7ce189edd..755ffa2cfc 100644 --- a/website/docs/r/redis_param_template.html.markdown +++ b/website/docs/r/redis_param_template.html.markdown @@ -25,7 +25,7 @@ resource "tencentcloud_redis_param_template" "param_template" { } ``` -Copy from another template +### Copy from another template ```hcl resource "tencentcloud_redis_param_template" "param_template" { diff --git a/website/docs/r/scf_function.html.markdown b/website/docs/r/scf_function.html.markdown index 5f336a44fb..acd8ea2c76 100644 --- a/website/docs/r/scf_function.html.markdown +++ b/website/docs/r/scf_function.html.markdown @@ -25,7 +25,7 @@ resource "tencentcloud_scf_function" "foo" { } ``` -Using CFS config +### Using CFS config ```hcl resource "tencentcloud_scf_function" "foo" { diff --git a/website/docs/r/security_group_rule.html.markdown b/website/docs/r/security_group_rule.html.markdown index a6ff44edb2..059257930b 100644 --- a/website/docs/r/security_group_rule.html.markdown +++ b/website/docs/r/security_group_rule.html.markdown @@ -15,7 +15,7 @@ Provides a resource to create security group rule. ## Example Usage -Source is CIDR ip +### Source is CIDR ip ```hcl resource "tencentcloud_security_group" "sglab_1" { @@ -35,7 +35,7 @@ resource "tencentcloud_security_group_rule" "sglab_1" { } ``` -Source is a security group id +### Source is a security group id ```hcl resource "tencentcloud_security_group" "sglab_2" { diff --git a/website/docs/r/sqlserver_config_backup_strategy.html.markdown b/website/docs/r/sqlserver_config_backup_strategy.html.markdown index ac848f7cd2..128949788e 100644 --- a/website/docs/r/sqlserver_config_backup_strategy.html.markdown +++ b/website/docs/r/sqlserver_config_backup_strategy.html.markdown @@ -13,7 +13,7 @@ Provides a resource to create a sqlserver config_backup_strategy ## Example Usage -Daily backup +### Daily backup ```hcl resource "tencentcloud_sqlserver_config_backup_strategy" "config" { @@ -31,7 +31,7 @@ resource "tencentcloud_sqlserver_config_backup_strategy" "config" { } ``` -Weekly backup +### Weekly backup ```hcl resource "tencentcloud_sqlserver_config_backup_strategy" "config" { @@ -48,7 +48,7 @@ resource "tencentcloud_sqlserver_config_backup_strategy" "config" { } ``` -Regular backup +### Regular backup ```hcl resource "tencentcloud_sqlserver_config_backup_strategy" "config" { diff --git a/website/docs/r/tcr_instance.html.markdown b/website/docs/r/tcr_instance.html.markdown index 9bf27dc281..4ec7d37eeb 100644 --- a/website/docs/r/tcr_instance.html.markdown +++ b/website/docs/r/tcr_instance.html.markdown @@ -24,7 +24,7 @@ resource "tencentcloud_tcr_instance" "foo" { } ``` -Using public network access whitelist +### Using public network access whitelist ```hcl resource "tencentcloud_tcr_instance" "foo" { @@ -40,7 +40,7 @@ resource "tencentcloud_tcr_instance" "foo" { } ``` -Create with Replications +### Create with Replications ```hcl resource "tencentcloud_tcr_instance" "foo" { diff --git a/website/docs/r/tse_instance.html.markdown b/website/docs/r/tse_instance.html.markdown index 1edd102b73..b4aa7609a5 100644 --- a/website/docs/r/tse_instance.html.markdown +++ b/website/docs/r/tse_instance.html.markdown @@ -13,7 +13,7 @@ Provides a resource to create a tse instance ## Example Usage -Create zookeeper standard version +### Create zookeeper standard version ```hcl resource "tencentcloud_tse_instance" "zookeeper_standard" { @@ -34,7 +34,7 @@ resource "tencentcloud_tse_instance" "zookeeper_standard" { } ``` -Create zookeeper professional version +### Create zookeeper professional version ```hcl resource "tencentcloud_tse_instance" "zookeeper_professional" { @@ -68,7 +68,7 @@ resource "tencentcloud_tse_instance" "zookeeper_professional" { } ``` -Create nacos standard version +### Create nacos standard version ```hcl resource "tencentcloud_tse_instance" "nacos" { @@ -90,7 +90,7 @@ resource "tencentcloud_tse_instance" "nacos" { } ``` -Create polaris base version +### Create polaris base version ```hcl resource "tencentcloud_tse_instance" "polaris" { diff --git a/website/docs/r/vpc.html.markdown b/website/docs/r/vpc.html.markdown index 9ce01d692c..05baf06c4d 100644 --- a/website/docs/r/vpc.html.markdown +++ b/website/docs/r/vpc.html.markdown @@ -26,7 +26,7 @@ resource "tencentcloud_vpc" "foo" { } ``` -Using Assistant CIDR +### Using Assistant CIDR ```hcl resource "tencentcloud_vpc" "foo" { diff --git a/website/docs/r/vpn_gateway.html.markdown b/website/docs/r/vpn_gateway.html.markdown index da003979f2..49f3d1c24a 100644 --- a/website/docs/r/vpn_gateway.html.markdown +++ b/website/docs/r/vpn_gateway.html.markdown @@ -15,7 +15,7 @@ Provides a resource to create a VPN gateway. ## Example Usage -VPC SSL VPN gateway +### VPC SSL VPN gateway ```hcl resource "tencentcloud_vpn_gateway" "my_cgw" { @@ -31,7 +31,7 @@ resource "tencentcloud_vpn_gateway" "my_cgw" { } ``` -CCN IPEC VPN gateway +### CCN IPEC VPN gateway ```hcl resource "tencentcloud_vpn_gateway" "my_cgw" { @@ -46,7 +46,7 @@ resource "tencentcloud_vpn_gateway" "my_cgw" { } ``` -CCN SSL VPN gateway +### CCN SSL VPN gateway ```hcl resource "tencentcloud_vpn_gateway" "my_cgw" { @@ -61,7 +61,7 @@ resource "tencentcloud_vpn_gateway" "my_cgw" { } ``` -POSTPAID_BY_HOUR VPN gateway +### POSTPAID_BY_HOUR VPN gateway ```hcl resource "tencentcloud_vpn_gateway" "my_cgw" { @@ -76,7 +76,7 @@ resource "tencentcloud_vpn_gateway" "my_cgw" { } ``` -PREPAID VPN gateway +### PREPAID VPN gateway ```hcl resource "tencentcloud_vpn_gateway" "my_cgw" { From a77b5db8467969323f51b125e1c61b3e3ff5c134 Mon Sep 17 00:00:00 2001 From: nickyinluo Date: Wed, 5 Jul 2023 16:58:31 +0800 Subject: [PATCH 2/2] adjust README.md --- gendoc/README.md | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/gendoc/README.md b/gendoc/README.md index fcbe76a6db..42a07a15b9 100644 --- a/gendoc/README.md +++ b/gendoc/README.md @@ -47,9 +47,9 @@ description & example usage & usage description 需要在对应 resource 及 dat \n Example Usage \n - Usage1 title + Scenario1 title \n - Description of the Usage1 + Description of the Scenario1 \n ```hcl data "tencentcloud_mysql_instance" "database"{ @@ -58,9 +58,9 @@ description & example usage & usage description 需要在对应 resource 及 dat } ``` \n - Usage2 title + Scenario2 title \n - Description of the Usage2 + Description of the Scenario2 \n ```hcl data "tencentcloud_mysql_instance" "database"{ @@ -81,15 +81,15 @@ description & example usage & usage description 需要在对应 resource 及 dat Example Usage \n Example Usage 是必须的,在 Example Usage 以下的内容都会填充到文档中。 - Example Usage 由一个到多个Usage构成。 - 每个Usage 由 Usage title 和 Usage description 构成。 + Example Usage 由一个到多个Scenario(场景)构成。 + 每个Scenario 由 Scenario title 和 Scenario description 构成。 \n Usage1 title \n Description of the Usage1 \n - Usage title 是必须的。 - Usage description 是可选的,可以根据情况填写。 + Scenario title 是必须的。 + Scenario description 是可选的,可以根据情况填写。 */ package tencentcloud