Merge pull request #14 from vmware-tanzu/vasundharas/templating

Refining the documentation

Author: shobha2626

Makefile

@@ -25,6 +25,13 @@ vet:
 lint: gofmt
 	golangci-lint run -c ./.golangci.yml ./internal/... .
 
+set-tf-acc:
+	@echo Setting Acceptance test env variable
+	export TF_ACC=true;\
+	echo $$TF_ACC
+
+acc-test: set-tf-acc test
+
 website-lint:
 	@echo "==> Checking website against linters..."
 	@misspell -error -source=text website/ || (echo; \

README.md

@@ -1,7 +1,7 @@
-# Terraform Tanzu TMC Provider
+# Terraform VMware Tanzu Mission Control Provider
 
-This is the repository for the Terraform Tanzu TMC Provider, which one can use with
-Terraform to work with [VMware Tanzu TMC][vmware-tanzu-tmc].
+This is the repository for the Terraform Tanzu Mission Control Provider, which one can use with Terraform to work with
+[VMware Tanzu Mission Control][vmware-tanzu-tmc].
 
 [vmware-tanzu-tmc]: https://tanzu.vmware.com/mission-control
 
@@ -27,8 +27,8 @@ provider "tmc" {
 }
 ```
 
-Version locking uses a pessimistic operator, so this version lock would mean
-anything within the 1.x namespace, including or after 1.0.0. [Read more][provider-vc] on provider version control.
+Version locking uses a pessimistic operator, so this version lock would mean anything within the 1.x namespace, including or after 1.0.0.
+[Read more][provider-vc] on provider version control.
 
 [provider-vc]: https://docs.vmware.com/en/VMware-Tanzu-Mission-Control/index.html
 
@@ -86,34 +86,34 @@ provider.
 **Flattening and Helper Tests:** These can be run by `make test` directly.
 
 **Acceptance Tests:** Set the environment variables in your IDE configurations or Terminal.
-Environment variables that are required to be set universally are `TMC_ENDPOINT`, `TMC_CSP_ENDPOINT`, `TMC_CSP_TOKEN` and `TF_ACC`. `TF_ACC` has to be set as `true`. 
+Environment variables that are required to be set universally are `TMC_ENDPOINT`, `TMC_CSP_ENDPOINT` and `TMC_CSP_TOKEN`.
 
 Environment variables specific to particular resources:
 
 - **Attach Cluster with Kubeconfig and Namespace Resource** - `KUBECONFIG`  
 - **TKGs workload cluster** - `MANAGEMENT_CLUSTER`, `PROVISIONER_NAME`, `VERSION` and `STORAGE_CLASS`.
 - **TKGm Vsphere workload cluster** - `MANAGEMENT_CLUSTER` and `CONTROL_PLANE_ENDPOINT`.
 
-After the environment variables are set, run the respective tests.
+After the environment variables are set, run `make acc-test`.
 
 ## Provider Documentation
 
-TMC Terraform provider documentation is autogenerated using [tfplugindocs][tfplugindocs-link].
+Tanzu Mission Control Terraform provider documentation is autogenerated using [tfplugindocs][tfplugindocs-link].
 
-Use the tfplugindocs tool to automatically generate documentation for your provider in the format required by the Terraform Registry.
+Use the tfplugindocs tool to generate documentation for your provider in the format required by the Terraform Registry.
 The plugin will read the descriptions and schema of each resource and data source in your provider and generate the relevant Markdown files for you.
 
 [tfplugindocs-link]: https://github.com/hashicorp/terraform-plugin-docs
-## Utilising TMC provider
+## Using Tanzu Mission Control Provider
 
-Please refer to `examples` folder to perform CRUD operations with TMC provider for various resources
+Please refer to `examples` folder to perform CRUD operations with Tanzu Mission Control provider for various resources
 
 # Support
 
-The TMC Terraform provider is now VMware supported as well as community supported. For bugs and feature requests please open a Github Issue and label it appropriately or contact VMware support.
+The Tanzu Mission Control Terraform provider is now VMware supported as well as community supported. For bugs and feature requests please open a Github Issue and label it appropriately or contact VMware support.
 
 # License
 
 Copyright © 2015-2021 VMware, Inc. All Rights Reserved.
 
-The TMC Terraform provider is available under [MPL2.0 license](https://github.com/vmware-tanzu/terraform-provider-tanzu-mission-control/blob/main/LICENSE).
+The Tanzu Mission Control Terraform provider is available under [MPL2.0 license](https://github.com/vmware-tanzu/terraform-provider-tanzu-mission-control/blob/main/LICENSE).

docs/data-sources/tmc_cluster.md

@@ -1,14 +1,12 @@
 ---
-# generated by https://github.com/hashicorp/terraform-plugin-docs
-page_title: "tmc_cluster Data Source - terraform-provider-tanzu-mission-control"
-subcategory: ""
-description: |-
-  
+Title: "Cluster Resource"
+Description: |-
+    Reading the cluster resource.
 ---
 
-# tmc_cluster (Data Source)
-
+# Cluster
 
+Different flavours such as attach cluster, TKG service workload and TKG Vsphere workload clusters can be fetched.
 
 ## Example Usage
 
@@ -360,6 +358,4 @@ Optional:
 
 - **cpu** (String)
 - **disk_size** (String)
-- **memory** (String)
-
-
+- **memory** (String)

docs/data-sources/tmc_cluster_group.md

@@ -1,14 +1,12 @@
 ---
-# generated by https://github.com/hashicorp/terraform-plugin-docs
-page_title: "tmc_cluster_group Data Source - terraform-provider-tanzu-mission-control"
-subcategory: ""
-description: |-
-  
+Title: "Cluster Group Resource"
+Description: |-
+    Fetching the cluster group resource to a cluster.
 ---
 
-# tmc_cluster_group (Data Source)
-
+# Cluster Group
 
+A cluster group is needed for a cluster
 
 ## Example Usage
 
@@ -43,6 +41,4 @@ Read-Only:
 
 - **annotations** (Map of String) Annotations for the resource
 - **resource_version** (String) Resource version of the resource
-- **uid** (String) UID of the resource
-
-
+- **uid** (String) UID of the resource

docs/data-sources/tmc_cluster_node_pool.md

@@ -1,16 +1,24 @@
 ---
-# generated by https://github.com/hashicorp/terraform-plugin-docs
-page_title: "tmc_cluster_node_pool Data Source - terraform-provider-tanzu-mission-control"
-subcategory: ""
-description: |-
-  
+Title: "Nodepool Resource"
+Description: |-
+    Fetching the details of nodepool resource.
 ---
 
-# tmc_cluster_node_pool (Data Source)
-
+# Nodepool
 
+A nodepool can be read.
 
+## Example Usage
 
+```terraform
+# Read TMC cluster nodepool : fetch cluster nodepool details
+data "tmc_cluster_node_pool" "read_node_pool" {
+  management_cluster_name = "tkgs-terraform"
+  provisioner_name = "test-gc-e2e-demo-ns"
+  cluster_name = "tkgs-test"
+  name = "default-nodepool"
+}
+```
 
 <!-- schema generated by tfplugindocs -->
 ## Schema
@@ -63,6 +71,4 @@ Optional:
 Optional:
 
 - **class** (String) Nodepool instance type
-- **storage_class** (String) Storage Class to be used for storage of the disks which store the root filesystem of the nodes
-
-
+- **storage_class** (String) Storage Class to be used for storage of the disks which store the root filesystem of the nodes

docs/data-sources/tmc_namespace.md

@@ -1,14 +1,12 @@
 ---
-# generated by https://github.com/hashicorp/terraform-plugin-docs
-page_title: "tmc_namespace Data Source - terraform-provider-tanzu-mission-control"
-subcategory: ""
-description: |-
-  
+Title: "Namespace Resource"
+Description: |-
+    Fetching the details of namespace resource.
 ---
 
-# tmc_namespace (Data Source)
-
+# Namespace
 
+A namespace can be read.
 
 ## Example Usage
 
@@ -63,6 +61,4 @@ Read-Only:
 Optional:
 
 - **attach** (Boolean)
-- **workspace_name** (String)
-
-
+- **workspace_name** (String)

docs/data-sources/tmc_workspace.md

@@ -1,14 +1,12 @@
 ---
-# generated by https://github.com/hashicorp/terraform-plugin-docs
-page_title: "tmc_workspace Data Source - terraform-provider-tanzu-mission-control"
-subcategory: ""
-description: |-
-  
+Title: "Workspace Resource"
+Description: |-
+    fetching the details of workspace resource.
 ---
 
-# tmc_workspace (Data Source)
-
+# Workspace
 
+A workspace can be read.
 
 ## Example Usage
 
@@ -43,6 +41,4 @@ Read-Only:
 
 - **annotations** (Map of String) Annotations for the resource
 - **resource_version** (String) Resource version of the resource
-- **uid** (String) UID of the resource
-
-
+- **uid** (String) UID of the resource