From c64dbc05ef54ac4e62935fba006c3c7639dc3395 Mon Sep 17 00:00:00 2001 From: brickzzhang Date: Wed, 9 Dec 2020 14:48:51 +0800 Subject: [PATCH 1/2] [optimize document] 1. optimize document for mongodb --- tencentcloud/extension_mongodb.go | 4 ++-- tencentcloud/resource_tc_mongodb_standby_instance.go | 10 +++++----- website/docs/r/mongodb_instance.html.markdown | 4 ++-- website/docs/r/mongodb_sharding_instance.html.markdown | 4 ++-- website/docs/r/mongodb_standby_instance.html.markdown | 8 ++++---- 5 files changed, 15 insertions(+), 15 deletions(-) diff --git a/tencentcloud/extension_mongodb.go b/tencentcloud/extension_mongodb.go index 31cbae9765..0d14099c5f 100644 --- a/tencentcloud/extension_mongodb.go +++ b/tencentcloud/extension_mongodb.go @@ -89,7 +89,7 @@ func TencentMongodbBasicInfo() map[string]*schema.Schema { Type: schema.TypeString, Required: true, ForceNew: true, - Description: "Version of the Mongodb, and available values include `MONGO_3_WT`, `MONGO_3_ROCKS`, `MONGO_36_WT` and `MONGO_40_WT`.", + Description: "Version of the Mongodb, and available values include `MONGO_3_WT` (represents MongoDB 3.2 WiredTiger Edition), `MONGO_3_ROCKS` (represents MongoDB 3.2 RocksDB Edition), `MONGO_36_WT` (represents MongoDB 3.6 WiredTiger Edition) and `MONGO_40_WT` (represents MongoDB 4.0 WiredTiger Edition).", }, "machine_type": { Type: schema.TypeString, @@ -105,7 +105,7 @@ func TencentMongodbBasicInfo() map[string]*schema.Schema { } return olds == news }, - Description: "Type of Mongodb instance, and available values include `HIO`(or `GIO` which will be deprecated) and `HIO10G`(or `TGIO` which will be deprecated).", + Description: "Type of Mongodb instance, and available values include `HIO`(or `GIO` which will be deprecated, represents high IO) and `HIO10G`(or `TGIO` which will be deprecated, represents 10-gigabit high IO).", }, "available_zone": { Type: schema.TypeString, diff --git a/tencentcloud/resource_tc_mongodb_standby_instance.go b/tencentcloud/resource_tc_mongodb_standby_instance.go index 7e861d202e..ec9c7e08aa 100644 --- a/tencentcloud/resource_tc_mongodb_standby_instance.go +++ b/tencentcloud/resource_tc_mongodb_standby_instance.go @@ -81,24 +81,24 @@ func resourceTencentCloudMongodbStandbyInstance() *schema.Resource { Type: schema.TypeString, ForceNew: true, Required: true, - Description: "Indicates the master instance ID of standby instances.", + Description: "Indicates the father instance ID of standby instances.", }, "available_zone": { Type: schema.TypeString, Required: true, ForceNew: true, - Description: "The available zone of the Mongodb standby instance. NOTE: must not same with father instance's.", + Description: "The available zone of the Mongodb standby instance. NOTE: must not be same with father instance's.", }, - // computed form master instance + // computed from father instance "engine_version": { Type: schema.TypeString, Computed: true, - Description: "Version of the Mongodb and must be same as the master's.", + Description: "Version of the standby Mongodb instance and must be same as the father's.", }, "machine_type": { Type: schema.TypeString, Computed: true, - Description: "Type of Mongodb instance and must be same as the master's.", + Description: "Type of standby Mongodb instance and must be same as the father's.", }, } basic := TencentMongodbBasicInfo() diff --git a/website/docs/r/mongodb_instance.html.markdown b/website/docs/r/mongodb_instance.html.markdown index 83f90d67b9..da26c70845 100644 --- a/website/docs/r/mongodb_instance.html.markdown +++ b/website/docs/r/mongodb_instance.html.markdown @@ -33,9 +33,9 @@ resource "tencentcloud_mongodb_instance" "mongodb" { The following arguments are supported: * `available_zone` - (Required, ForceNew) The available zone of the Mongodb. -* `engine_version` - (Required, ForceNew) Version of the Mongodb, and available values include `MONGO_3_WT`, `MONGO_3_ROCKS`, `MONGO_36_WT` and `MONGO_40_WT`. +* `engine_version` - (Required, ForceNew) Version of the Mongodb, and available values include `MONGO_3_WT` (represents MongoDB 3.2 WiredTiger Edition), `MONGO_3_ROCKS` (represents MongoDB 3.2 RocksDB Edition), `MONGO_36_WT` (represents MongoDB 3.6 WiredTiger Edition) and `MONGO_40_WT` (represents MongoDB 4.0 WiredTiger Edition). * `instance_name` - (Required) Name of the Mongodb instance. -* `machine_type` - (Required, ForceNew) Type of Mongodb instance, and available values include `HIO`(or `GIO` which will be deprecated) and `HIO10G`(or `TGIO` which will be deprecated). +* `machine_type` - (Required, ForceNew) Type of Mongodb instance, and available values include `HIO`(or `GIO` which will be deprecated, represents high IO) and `HIO10G`(or `TGIO` which will be deprecated, represents 10-gigabit high IO). * `memory` - (Required) Memory size. The minimum value is 2, and unit is GB. Memory and volume must be upgraded or degraded simultaneously. * `password` - (Required) Password of this Mongodb account. * `volume` - (Required) Disk size. The minimum value is 25, and unit is GB. Memory and volume must be upgraded or degraded simultaneously. diff --git a/website/docs/r/mongodb_sharding_instance.html.markdown b/website/docs/r/mongodb_sharding_instance.html.markdown index 67b075b8b9..9b5c25a35f 100644 --- a/website/docs/r/mongodb_sharding_instance.html.markdown +++ b/website/docs/r/mongodb_sharding_instance.html.markdown @@ -35,9 +35,9 @@ resource "tencentcloud_mongodb_sharding_instance" "mongodb" { The following arguments are supported: * `available_zone` - (Required, ForceNew) The available zone of the Mongodb. -* `engine_version` - (Required, ForceNew) Version of the Mongodb, and available values include `MONGO_3_WT`, `MONGO_3_ROCKS`, `MONGO_36_WT` and `MONGO_40_WT`. +* `engine_version` - (Required, ForceNew) Version of the Mongodb, and available values include `MONGO_3_WT` (represents MongoDB 3.2 WiredTiger Edition), `MONGO_3_ROCKS` (represents MongoDB 3.2 RocksDB Edition), `MONGO_36_WT` (represents MongoDB 3.6 WiredTiger Edition) and `MONGO_40_WT` (represents MongoDB 4.0 WiredTiger Edition). * `instance_name` - (Required) Name of the Mongodb instance. -* `machine_type` - (Required, ForceNew) Type of Mongodb instance, and available values include `HIO`(or `GIO` which will be deprecated) and `HIO10G`(or `TGIO` which will be deprecated). +* `machine_type` - (Required, ForceNew) Type of Mongodb instance, and available values include `HIO`(or `GIO` which will be deprecated, represents high IO) and `HIO10G`(or `TGIO` which will be deprecated, represents 10-gigabit high IO). * `memory` - (Required) Memory size. The minimum value is 2, and unit is GB. Memory and volume must be upgraded or degraded simultaneously. * `nodes_per_shard` - (Required, ForceNew) Number of nodes per shard, at least 3(one master and two slaves). * `password` - (Required) Password of this Mongodb account. diff --git a/website/docs/r/mongodb_standby_instance.html.markdown b/website/docs/r/mongodb_standby_instance.html.markdown index 6b4cd9b2a8..b646571aa2 100644 --- a/website/docs/r/mongodb_standby_instance.html.markdown +++ b/website/docs/r/mongodb_standby_instance.html.markdown @@ -58,8 +58,8 @@ resource "tencentcloud_mongodb_standby_instance" "mongodb" { The following arguments are supported: -* `available_zone` - (Required, ForceNew) The available zone of the Mongodb standby instance. NOTE: must not same with father instance's. -* `father_instance_id` - (Required, ForceNew) Indicates the master instance ID of standby instances. +* `available_zone` - (Required, ForceNew) The available zone of the Mongodb standby instance. NOTE: must not be same with father instance's. +* `father_instance_id` - (Required, ForceNew) Indicates the father instance ID of standby instances. * `father_instance_region` - (Required, ForceNew) Indicates the region of father instance. * `instance_name` - (Required) Name of the Mongodb instance. * `memory` - (Required) Memory size. The minimum value is 2, and unit is GB. Memory and volume must be upgraded or degraded simultaneously. @@ -79,8 +79,8 @@ In addition to all arguments above, the following attributes are exported: * `id` - ID of the resource. * `create_time` - Creation time of the Mongodb instance. -* `engine_version` - Version of the Mongodb and must be same as the master's. -* `machine_type` - Type of Mongodb instance and must be same as the master's. +* `engine_version` - Version of the standby Mongodb instance and must be same as the father's. +* `machine_type` - Type of standby Mongodb instance and must be same as the father's. * `status` - Status of the Mongodb instance, and available values include pending initialization(expressed with 0), processing(expressed with 1), running(expressed with 2) and expired(expressed with -2). * `vip` - IP of the Mongodb instance. * `vport` - IP port of the Mongodb instance. From 18911852ac41d6d612a15643f5a12669adff76c3 Mon Sep 17 00:00:00 2001 From: brickzzhang Date: Wed, 9 Dec 2020 15:11:13 +0800 Subject: [PATCH 2/2] [optimize document] 1. main not father --- tencentcloud/resource_tc_mongodb_standby_instance.go | 8 ++++---- website/docs/r/mongodb_standby_instance.html.markdown | 8 ++++---- 2 files changed, 8 insertions(+), 8 deletions(-) diff --git a/tencentcloud/resource_tc_mongodb_standby_instance.go b/tencentcloud/resource_tc_mongodb_standby_instance.go index ec9c7e08aa..1fc4af50bd 100644 --- a/tencentcloud/resource_tc_mongodb_standby_instance.go +++ b/tencentcloud/resource_tc_mongodb_standby_instance.go @@ -75,13 +75,13 @@ func resourceTencentCloudMongodbStandbyInstance() *schema.Resource { Type: schema.TypeString, ForceNew: true, Required: true, - Description: "Indicates the region of father instance.", + Description: "Indicates the region of main instance.", }, "father_instance_id": { Type: schema.TypeString, ForceNew: true, Required: true, - Description: "Indicates the father instance ID of standby instances.", + Description: "Indicates the main instance ID of standby instances.", }, "available_zone": { Type: schema.TypeString, @@ -93,12 +93,12 @@ func resourceTencentCloudMongodbStandbyInstance() *schema.Resource { "engine_version": { Type: schema.TypeString, Computed: true, - Description: "Version of the standby Mongodb instance and must be same as the father's.", + Description: "Version of the standby Mongodb instance and must be same as the version of main instance.", }, "machine_type": { Type: schema.TypeString, Computed: true, - Description: "Type of standby Mongodb instance and must be same as the father's.", + Description: "Type of standby Mongodb instance and must be same as the type of main instance.", }, } basic := TencentMongodbBasicInfo() diff --git a/website/docs/r/mongodb_standby_instance.html.markdown b/website/docs/r/mongodb_standby_instance.html.markdown index b646571aa2..78420180c5 100644 --- a/website/docs/r/mongodb_standby_instance.html.markdown +++ b/website/docs/r/mongodb_standby_instance.html.markdown @@ -59,8 +59,8 @@ resource "tencentcloud_mongodb_standby_instance" "mongodb" { The following arguments are supported: * `available_zone` - (Required, ForceNew) The available zone of the Mongodb standby instance. NOTE: must not be same with father instance's. -* `father_instance_id` - (Required, ForceNew) Indicates the father instance ID of standby instances. -* `father_instance_region` - (Required, ForceNew) Indicates the region of father instance. +* `father_instance_id` - (Required, ForceNew) Indicates the main instance ID of standby instances. +* `father_instance_region` - (Required, ForceNew) Indicates the region of main instance. * `instance_name` - (Required) Name of the Mongodb instance. * `memory` - (Required) Memory size. The minimum value is 2, and unit is GB. Memory and volume must be upgraded or degraded simultaneously. * `volume` - (Required) Disk size. The minimum value is 25, and unit is GB. Memory and volume must be upgraded or degraded simultaneously. @@ -79,8 +79,8 @@ In addition to all arguments above, the following attributes are exported: * `id` - ID of the resource. * `create_time` - Creation time of the Mongodb instance. -* `engine_version` - Version of the standby Mongodb instance and must be same as the father's. -* `machine_type` - Type of standby Mongodb instance and must be same as the father's. +* `engine_version` - Version of the standby Mongodb instance and must be same as the version of main instance. +* `machine_type` - Type of standby Mongodb instance and must be same as the type of main instance. * `status` - Status of the Mongodb instance, and available values include pending initialization(expressed with 0), processing(expressed with 1), running(expressed with 2) and expired(expressed with -2). * `vip` - IP of the Mongodb instance. * `vport` - IP port of the Mongodb instance.