Fix documentation issues

Add OBS subcategory for s3 resources Fix multiple CCE subcategories Other minor fixes
opentelekomcloud · Sep 1, 2020 · dae8186 · dae8186
1 parent 21c64ae
commit dae8186
Show file tree

Hide file tree

Showing 13 changed files with 35 additions and 20 deletions.
diff --git a/docs/data-sources/compute_availability_zones_v2.md b/docs/data-sources/compute_availability_zones_v2.md
@@ -1,3 +1,7 @@
+---
+subcategory: "Elastic Cloud Server (ECS)"
+---
+
 # opentelekomcloud_compute_availability_zones_v2
 
 Use this data source to get a list of availability zones from OpenTelekomCloud.

diff --git a/docs/resources/blockstorage_volume_v2.md b/docs/resources/blockstorage_volume_v2.md
@@ -1,5 +1,5 @@
 ---
-subcategory: "BlockStorage"
+subcategory: "Elastic Volume Service (EVS)"
 ---
 
 # opentelekomcloud_blockstorage_volume_v2

diff --git a/docs/resources/cce_cluster_v3.md b/docs/resources/cce_cluster_v3.md
@@ -1,5 +1,5 @@
 ---
-subcategory: "Container Cluster Engine (CCE)"
+subcategory: "Cloud Container Engine (CCE)"
 ---
 
 # opentelekomcloud_cce_cluster_v3
@@ -12,7 +12,7 @@ Provides a cluster resource (CCE).
 variable "flavor_id" { }
 variable "vpc_id" { }
 variable "subnet_id" { }
-	
+
 resource "opentelekomcloud_cce_cluster_v3" "cluster_1" {
   name        = "cluster"
   description = "Create cluster"
@@ -111,8 +111,8 @@ All above argument parameters can be exported as attribute parameters along with
 ## Import
 
 Cluster can be imported using the cluster id, e.g.
- 
+
 ```sh
-terraform import opentelekomcloud_cce_cluster_v3.cluster_1 4779ab1c-7c1a-44b1-a02e-93dfc361b32d  
+terraform import opentelekomcloud_cce_cluster_v3.cluster_1 4779ab1c-7c1a-44b1-a02e-93dfc361b32d
 ```
 
diff --git a/docs/resources/cce_node_v3.md b/docs/resources/cce_node_v3.md
@@ -1,6 +1,5 @@
 ---
-subcategory: "Container Cluster Engine (CCE)
-"
+subcategory: "Cloud Container Engine (CCE)"
 ---
 
 # opentelekomcloud_cce_node_v3
@@ -51,9 +50,9 @@ The following arguments are supported:
 * `tags` - (Optional) The field is alternative to `labels`, key/value pair format.
 
 * `annotations` - (Optional) Node annotation, key/value pair format. Changing this parameter will create a new resource.
-    
+
 * `flavor_id` - (Required) Specifies the flavor id. Changing this parameter will create a new resource.
-    
+
 * `availability_zone` - (Required) specify the name of the available partition (AZ). Changing this parameter will create a new resource.
 
 * `key_pair` - (Required) Key pair name when logging in to select the key pair mode. Changing this parameter will create a new resource.

diff --git a/docs/resources/ces_alarmrule.md b/docs/resources/ces_alarmrule.md
@@ -1,5 +1,5 @@
 ---
-subcategory: "Cloud Eye"
+subcategory: "Cloud Eye (CES)"
 ---
 
 # opentelekomcloud_ces_alarmrule

diff --git a/docs/resources/compute_floatingip_associate_v2.md b/docs/resources/compute_floatingip_associate_v2.md
@@ -1,5 +1,5 @@
 ---
-subcategory: "Elastic cloud Server (ECS)"
+subcategory: "Elastic Cloud Server (ECS)"
 ---
 
 # opentelekomcloud_compute_floatingip_associate_v2

diff --git a/docs/resources/compute_floatingip_v2.md b/docs/resources/compute_floatingip_v2.md
@@ -1,5 +1,5 @@
 ---
-subcategory: "Elastic cloud Server (ECS)"
+subcategory: "Elastic Cloud Server (ECS)"
 ---
 
 # opentelekomcloud_compute_floatingip_v2

diff --git a/docs/resources/nat_dnat_rule_v2.md b/docs/resources/nat_dnat_rule_v2.md
@@ -1,5 +1,5 @@
 ---
-subcategory: "NAT Gateway (NAT)"
+subcategory: "NAT"
 ---
 
 # opentelekomcloud_nat_dnat_rule_v2

diff --git a/docs/resources/nat_gateway_v2.md b/docs/resources/nat_gateway_v2.md
@@ -1,5 +1,5 @@
 ---
-subcategory: "NAT Gateway (NAT)"
+subcategory: "NAT"
 ---
 
 # opentelekomcloud_nat_gateway_v2

diff --git a/docs/resources/nat_snat_rule_v2.md b/docs/resources/nat_snat_rule_v2.md
@@ -1,5 +1,5 @@
 ---
-subcategory: "NAT Gateway (NAT)"
+subcategory: "NAT"
 ---
 
 # opentelekomcloud_nat_snat_rule_v2

diff --git a/docs/resources/s3_bucket.md b/docs/resources/s3_bucket.md
@@ -1,3 +1,7 @@
+---
+subcategory: "Object Storage Service (OBS)"
+---
+
 # opentelekomcloud_s3_bucket
 
 Provides a S3 bucket resource within OpenTelekomCloud.
@@ -146,7 +150,7 @@ The following arguments are supported:
 
 * `acl` - (Optional) The [canned ACL](https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#canned-acl) to apply. Defaults to "private".
 
-* `policy` - (Optional) A valid [bucket policy](https://docs.aws.amazon.com/AmazonS3/latest/dev/example-bucket-policies.html) JSON document. 
+* `policy` - (Optional) A valid [bucket policy](https://docs.aws.amazon.com/AmazonS3/latest/dev/example-bucket-policies.html) JSON document.
 
 -> **Note:** If the policy document is not specific enough (but still valid), Terraform may view
   the policy as constantly changing in a `terraform plan`. In this case, please make sure you use the verbose/specific version of the policy.
@@ -171,10 +175,10 @@ The following arguments are supported:
 
 * `error_document` - (Optional) An absolute path to the document to return in case of a 4XX error.
 
-* `redirect_all_requests_to` - (Optional) A hostname to redirect all website requests for this bucket to. Hostname can optionally 
+* `redirect_all_requests_to` - (Optional) A hostname to redirect all website requests for this bucket to. Hostname can optionally
   be prefixed with a protocol (`http://` or `https://`) to use when redirecting requests. The default is the protocol that is used in the original request.
 
-* `routing_rules` - (Optional) A json array containing 
+* `routing_rules` - (Optional) A json array containing
   [routing rules](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-websiteconfiguration-routingrules.html)
   describing redirect behavior and when redirects are applied.
 

diff --git a/docs/resources/s3_bucket_object.md b/docs/resources/s3_bucket_object.md
@@ -1,3 +1,7 @@
+---
+subcategory: "Object Storage Service (OBS)"
+---
+
 # opentelekomcloud_s3_bucket_object
 
 Provides a S3 bucket object resource within OpenTelekomCloud.

diff --git a/docs/resources/s3_bucket_policy.md b/docs/resources/s3_bucket_policy.md
@@ -1,3 +1,7 @@
+---
+subcategory: "Object Storage Service (OBS)"
+---
+
 # opentelekomcloud_s3_bucket_policy
 
 Attaches a policy to an S3 bucket resource within OpenTelekomCloud.
@@ -24,8 +28,8 @@ resource "opentelekomcloud_s3_bucket_policy" "b" {
       "Resource": "arn:aws:s3:::my_tf_test_bucket/*",
       "Condition": {
          "IpAddress": {"aws:SourceIp": "8.8.8.8/32"}
-      } 
-    } 
+      }
+    }
   ]}
 POLICY
 }