From 7d8dc2c83732237427bb0836c20111146c70bb84 Mon Sep 17 00:00:00 2001 From: Ryan Johnson Date: Wed, 4 Dec 2024 08:53:29 -0800 Subject: [PATCH] chore: update grammar (#286) Updates grammar errors in documentation. Signed-off-by: Ryan Johnson --- .goreleaser.yml | 2 +- CHANGELOG.md | 2 +- README.md | 4 ++-- docs/install.md | 2 +- docs/test.md | 4 ++-- examples/README.md | 2 +- website/docs/d/customer_subnets.html.markdown | 2 +- website/docs/d/sddc.html.markdown | 4 ++-- website/docs/index.html.markdown | 2 +- website/docs/r/sddc.html.markdown | 8 ++++---- website/docs/r/site_recovery.html.markdown | 2 +- website/docs/r/srm_node.html.markdown | 2 +- 12 files changed, 18 insertions(+), 18 deletions(-) diff --git a/.goreleaser.yml b/.goreleaser.yml index ccbfcef4..f25589e8 100644 --- a/.goreleaser.yml +++ b/.goreleaser.yml @@ -39,7 +39,7 @@ signs: - artifacts: checksum args: # if you are using this is a GitHub action or some other automated pipeline, you - # need to pass the batch flag to indicate its not interactive. + # need to pass the batch flag to indicate it's not interactive. - "--batch" - "--local-user" - "{{ .Env.GPG_FINGERPRINT }}" # set this environment variable for your signing key diff --git a/CHANGELOG.md b/CHANGELOG.md index 2a9649e8..de710d84 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -207,7 +207,7 @@ BUG FIXES: * Added instructions for delay needed after SDDC creation for site recovery [\#21](https://github.com/vmware/terraform-provider-vmc/pull/21) * Removed capitalized error messages from code [\#23](https://github.com/vmware/terraform-provider-vmc/pull/23) -* Updated module name in go.mod [\#24](https://github.com/vmware/terraform-provider-vmc/pull/24) +* Updated module name in `go.mod`. [\#24](https://github.com/vmware/terraform-provider-vmc/pull/24) ENHANCEMENTS: diff --git a/README.md b/README.md index ced828b5..cf493097 100644 --- a/README.md +++ b/README.md @@ -34,7 +34,7 @@ Learn more: The Terraform Provider for VMware Cloud on AWS is a Partner tier provider. -Partner tier providers are owned and maintained by a partner in the HashiCorp Technology Partner Program. HashiCorp verifies the authenticity of the publisher and the provider is listed on the [Terraform Registry][terraform-registry] with a Partner tier label. +Partner tier providers are owned and maintained by a partner in the HashiCorp Technology Partner Program. HashiCorp verifies the authenticity of the publisher and the provider are listed on the [Terraform Registry][terraform-registry] with a Partner tier label. To use a released version of the Terraform provider in your environment, run `terraform init` and Terraform will automatically install the provider from the Terraform Registry. @@ -63,7 +63,7 @@ If you would like to submit a pull request, please read the [contribution guidel ## Support -The Terraform Provider for VMware Cloud on AWS is supported by Broadcom and the provider community. For bugs and feature requests please open a Github Issue and label it appropriately or contact Broadcom support. +The Terraform Provider for VMware Cloud on AWS is supported by Broadcom and the provider community. For bugs and feature requests please open a GitHub Issue and label it appropriately or contact Broadcom support. ## License diff --git a/docs/install.md b/docs/install.md index 74ce5aca..9cf2ab64 100644 --- a/docs/install.md +++ b/docs/install.md @@ -14,7 +14,7 @@ SPDX-License-Identifier: MPL-2.0 The Terraform Provider for VMware Cloud on AWS is a Partner Tier provider. -Partner providers are owned and maintained by a partner in the HashiCorp Technology Partner Program. HashiCorp verifies the authenticity of the publisher and the provider is listed on the [Terraform Registry][terraform-registry] with a partner tier label. +Partner providers are owned and maintained by a partner in the HashiCorp Technology Partner Program. HashiCorp verifies the authenticity of the publisher and the provider are listed on the [Terraform Registry][terraform-registry] with a partner tier label. ### Configure the Terraform Configuration Files diff --git a/docs/test.md b/docs/test.md index 5fdd7e3b..4afec931 100644 --- a/docs/test.md +++ b/docs/test.md @@ -16,7 +16,7 @@ create real resources, and often cost money to run. ## Configuring Environment Variables -Set required environment variables based based on your infrastructure settings. +Set required environment variables based on your infrastructure settings. ```sh $ # clientId and client secret of the test OAuth2.0 app attached to the test organization with at least @@ -54,7 +54,7 @@ If you want to run against a specific set of tests, run `make testacc` with the $ make testacc TESTARGS="-run=TestAccResourceVmcSddc_basic" ``` -Additionally, A limited set of acceptance tests can be ran with the ZEROCLOUD +Additionally, a limited set of acceptance tests can be run with the ZEROCLOUD cloud provider, which is much faster and cheaper, while providing decent API coverage:. For example: diff --git a/examples/README.md b/examples/README.md index a56f111a..296bacd4 100644 --- a/examples/README.md +++ b/examples/README.md @@ -2,7 +2,7 @@ This is an example that demonstrates the creation of VMC resources like SDDC, cluster, public IP, site recovery and SRM node. -For site recovery activation, a 10 minute delay must be added after SDDC is created and before site recovery can be activated. +For site recovery activation, a 10-minute delay must be added after SDDC is created and before site recovery can be activated. To add delay after SDDC has been created, update SDDC resource in [main.tf](https://github.com/vmware/terraform-provider-vmc/blob/master/examples/main.tf) with local-exec provisioner: diff --git a/website/docs/d/customer_subnets.html.markdown b/website/docs/d/customer_subnets.html.markdown index 9c6a15fd..2cc37c85 100644 --- a/website/docs/d/customer_subnets.html.markdown +++ b/website/docs/d/customer_subnets.html.markdown @@ -21,7 +21,7 @@ data "vmc_customer_subnets" "my_subnets" { * `org_id` - (Computed) Organization identifier. -* `region` - (Required) The AWS specific (e.g us-west-2) or VMC specific region (e.g US_WEST_2) of the cloud resources to work in. +* `region` - (Required) The AWS specific (e.g. us-west-2) or VMC specific region (e.g. US_WEST_2) of the cloud resources to work in. * `num_hosts` - (Optional) The number of hosts. diff --git a/website/docs/d/sddc.html.markdown b/website/docs/d/sddc.html.markdown index e61c9374..b2ce41ac 100644 --- a/website/docs/d/sddc.html.markdown +++ b/website/docs/d/sddc.html.markdown @@ -28,7 +28,7 @@ In addition to arguments listed above, the following attributes are exported: * `id` - SDDC identifier. -* `region` - The AWS specific (e.g us-west-2) or VMC specific region (e.g US_WEST_2) of the cloud resources to work in. +* `region` - The AWS specific (e.g. us-west-2) or VMC specific region (e.g. US_WEST_2) of the cloud resources to work in. * `sddc_name` - Name of the SDDC. @@ -50,7 +50,7 @@ In addition to arguments listed above, the following attributes are exported: * `vc_url` - VC URL. -* `cloud_username` - Cloud user name. +* `cloud_username` - Cloud username. * `nsxt_reverse_proxy_url` - NSXT reverse proxy url for managing public IP. diff --git a/website/docs/index.html.markdown b/website/docs/index.html.markdown index ef04faa7..ac30dd5a 100644 --- a/website/docs/index.html.markdown +++ b/website/docs/index.html.markdown @@ -21,7 +21,7 @@ resources. In order to use the provider you need to obtain the authentication token from the Cloud Service Provider by providing the org scoped API token. The provider client uses Cloud Service Provider (CSP) API -to exchange this org scoped API token/OAuth App Id and Secret for user access token. +to exchange this org scoped API token/OAuth App ID and Secret for user access token. Note that in all the examples you will need to update the `client_id` and `client_secret` or `api_token` and `org_id` settings in the variables.tf file to match those configured in your VMC environment. diff --git a/website/docs/r/sddc.html.markdown b/website/docs/r/sddc.html.markdown index 93e99761..d384f962 100644 --- a/website/docs/r/sddc.html.markdown +++ b/website/docs/r/sddc.html.markdown @@ -120,7 +120,7 @@ resource "vmc_sddc" "sddc_1" { For deployment type "MultiAZ", a single SDDC can be deployed across two AWS availability zones. -When enabled the default number of ESXi hosts supported in a MultiAZ SDDC is 6. Additional hosts can be added later but must to be done in pairs across AWS availability zones.The MultiAZ SDDC requires an AWS VPC with two subnets, one subnet per availability zone. +When enabled the default number of ESXi hosts supported in a MultiAZ SDDC is 6. Additional hosts can be added later but must be done in pairs across AWS availability zones.The MultiAZ SDDC requires an AWS VPC with two subnets, one subnet per availability zone. ## Example @@ -168,7 +168,7 @@ The following arguments are supported: * `org_id` - (Required) Organization identifier. -* `region` - (Required) The AWS specific (e.g us-west-2) or VMC specific region (e.g US_WEST_2) of the cloud resources to work in. +* `region` - (Required) The AWS specific (e.g. us-west-2) or VMC specific region (e.g. US_WEST_2) of the cloud resources to work in. * `sddc_name` - (Required) Name of the SDDC. @@ -178,7 +178,7 @@ The following arguments are supported: * `account_link_sddc_config` - (Optional) The account linking configuration object. -* `host_instance_type` - (Optional) The instance type for the esx hosts in the primary cluster of the SDDC. Possible values : I3_METAL, I3EN_METAL, I4I_METAL, and R5_METAL. Default value : I3_METAL. Currently I3EN_METAL host_instance_type does not support 1NODE and 2 node SDDC deployment. +* `host_instance_type` - (Optional) The instance type for the esx hosts in the primary cluster of the SDDC. Possible values : I3_METAL, I3EN_METAL, I4I_METAL, and R5_METAL. Default value : I3_METAL. Currently, I3EN_METAL host_instance_type does not support 1NODE and 2 node SDDC deployment. * `vpc_cidr` - (Optional) SDDC management network CIDR. Only prefix of 16, 20 and 23 are supported. Note : Specify a private subnet range (RFC 1918) to be used for vCenter Server, NSX Manager, and ESXi hosts. Choose a range that will not conflict with other networks you will connect to this SDDC. @@ -200,7 +200,7 @@ The following arguments are supported: * `sso_domain` - (Optional) The SSO domain name to use for vSphere users. If not specified, vmc.local will be used. -* `sddc_template_id` - (Optional) If provided, configuration from the template will applied to the provisioned SDDC. +* `sddc_template_id` - (Optional) If provided, configuration from the template will be applied to the provisioned SDDC. * `deployment_type` - (Optional) Denotes if request is for a SingleAZ or a MultiAZ SDDC. Default : SingleAZ. diff --git a/website/docs/r/site_recovery.html.markdown b/website/docs/r/site_recovery.html.markdown index db298d7b..75e6a891 100644 --- a/website/docs/r/site_recovery.html.markdown +++ b/website/docs/r/site_recovery.html.markdown @@ -71,7 +71,7 @@ The following arguments are supported for vmc_site_recovery resource: * `sddc_id` - (Required) SDDC identifier. * `srm_node_extension_key_suffix` - (Optional) Custom extension key suffix for SRM. If not specified, default extension key will be used. -The custom extension suffix must contain 13 characters or less, be composed of letters, numbers, ., - characters. +The custom extension suffix must contain 13 characters or fewer, be composed of letters, numbers, ., - characters. The extension suffix must begin and end with a letter or number. The suffix is appended to com.vmware.vcDr- to form the full extension key. diff --git a/website/docs/r/srm_node.html.markdown b/website/docs/r/srm_node.html.markdown index 538a783b..9894fd0a 100644 --- a/website/docs/r/srm_node.html.markdown +++ b/website/docs/r/srm_node.html.markdown @@ -37,7 +37,7 @@ The following arguments are supported for vmc_srm_node resource: * `sddc_id` - (Required) SDDC identifier. * `srm_node_extension_key_suffix` - (Required) Custom extension key suffix for SRM. If not specified, default extension key will be used. -The custom extension suffix must contain 13 characters or less, be composed of letters, numbers, ., - characters. +The custom extension suffix must contain 13 characters or fewer, be composed of letters, numbers, ., - characters. The extension suffix must begin and end with a letter or number. The suffix is appended to com.vmware.vcDr- to form the full extension key. ## Attributes Reference