Merge pull request #32825 from iKunal-Singh/doc-branch

Fix punctuation, spelling mistakes, preposition and article usage in terraform CLI documentation
revert-32615-patch-1
Craig Wright 2 years ago committed by GitHub
commit 85303ff93e
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194

@ -48,10 +48,9 @@ Without a saved plan file, `terraform apply` supports all planning modes and pla
The following options change how the apply command executes and reports on the apply operation.
- `-auto-approve` - Skips interactive approval of plan before applying. This
option is ignored when you pass a previously-saved plan file, because
Terraform considers you passing the plan file as the approval and so
will never prompt in that case.
- `-auto-approve` - Skips interactive approval of the plan before applying. Terraform ignores this
option when you pass a previously-saved plan file. This is because
Terraform interprets the act of passing the plan file as the approval.
- `-compact-warnings` - Shows any warning messages in a compact form which
includes only the summary messages, unless the warnings are accompanied by
@ -86,7 +85,7 @@ The following options change how the apply command executes and reports on the a
if you are running Terraform in a context where its output will be
rendered by a system that cannot interpret terminal formatting.
- `-parallelism=n` - Limit the number of concurrent operation as Terraform
- `-parallelism=n` - Limit the number of concurrent operations as Terraform
[walks the graph](/terraform/internals/graph#walking-the-graph). Defaults to
10\.

@ -52,7 +52,7 @@ The command-line flags are all optional. The following flags are available:
- `-no-color` - If specified, output won't contain any color.
- `-parallelism=n` - Limit the number of concurrent operation as Terraform
- `-parallelism=n` - Limit the number of concurrent operations as Terraform
[walks the graph](/terraform/internals/graph#walking-the-graph). Defaults
to 10.
@ -67,8 +67,8 @@ The command-line flags are all optional. The following flags are available:
- `-var-file=foo` - Set variables in the Terraform configuration from
a [variable file](/terraform/language/values/variables#variable-definitions-tfvars-files). If
a `terraform.tfvars` or any `.auto.tfvars` files are present in the current
directory, they will be automatically loaded. `terraform.tfvars` is loaded
`terraform.tfvars` or any `.auto.tfvars` files are present in the current
directory, they are automatically loaded. Terraform loads `terraform.tfvars`
first and the `.auto.tfvars` files after in alphabetical order. Any files
specified by `-var-file` override any values set automatically from files in
the working directory. This flag can be used multiple times. This is only

@ -32,9 +32,9 @@ local CLI configuration file called `credentials.tfrc.json`. When you run
the API token and give you a chance to cancel if the current configuration is
not as desired.
If you don't wish to store your API token in the default location, you can
If you do not wish to store your API token in the default location, you can
optionally configure a
[credentials helper program](/terraform/cli/config/config-file#credentials-helpers) which knows
[credentials helper program](/terraform/cli/config/config-file#credentials-helpers) that knows
how to store and later retrieve credentials in some other system, such as
your organization's existing secrets management system.

@ -18,7 +18,7 @@ The command will list all resources in the state file matching the given
addresses (if any). If no addresses are given, all resources are listed.
The resources listed are sorted according to module depth order followed
by alphabetical. This means that resources that are in your immediate
alphabetically. This means that resources that are in your immediate
configuration are listed first, and resources that are more deeply nested
within modules are listed last.

@ -17,7 +17,7 @@ existing state. It is thus primarily useful for general verification of
reusable modules, including correctness of attribute names and value types.
It is safe to run this command automatically, for example as a post-save
check in a text editor or as a test step for a re-usable module in a CI
check in a text editor or as a test step for a reusable module in a CI
system.
Validation requires an initialized working directory with any referenced plugins and modules installed. To initialize a working directory for validation without accessing any configured backend, use:
@ -26,7 +26,7 @@ Validation requires an initialized working directory with any referenced plugins
$ terraform init -backend=false
```
To verify configuration in the context of a particular run (a particular
To verify the configuration in the context of a particular run (a particular
target workspace, input variable values, etc), use the `terraform plan`
command instead, which includes an implied validation check.
@ -107,7 +107,7 @@ The nested objects in `diagnostics` have the following properties:
Summaries are typically short, single sentences, but can sometimes be longer
as a result of returning errors from subsystems that are not designed to
return full diagnostics, where the entire error message therefore becomes the
return full diagnostics, where the entire error message becomes the
summary. In those cases, the summary might include newline characters which
a renderer should honor when presenting the message visually to a user.
@ -119,7 +119,7 @@ The nested objects in `diagnostics` have the following properties:
reference.
Detail messages are often multiple paragraphs and possibly interspersed with
non-paragraph lines, so tools which aim to present detail messages to the
non-paragraph lines, so tools that aim to present detailed messages to the
user should distinguish between lines without leading spaces, treating them
as paragraphs, and lines with leading spaces, treating them as preformatted
text. Renderers should then soft-wrap the paragraphs to fit the width of the
@ -127,16 +127,16 @@ The nested objects in `diagnostics` have the following properties:
Some Terraform detail messages contain an approximation of bullet
lists using ASCII characters to mark the bullets. This is not a
contractural formatting convention, so renderers should avoid depending on
contractual formatting convention, so renderers should avoid depending on
it and should instead treat those lines as either paragraphs or preformatted
text. Future versions of this format may define additional rules for other text conventions, but will maintain backward compatibility.
text.
- `range` (object): An optional object referencing a portion of the configuration
source code that the diagnostic message relates to. For errors, this will
typically indicate the bounds of the specific block header, attribute, or
expression which was detected as invalid.
A source range is an object with a property `filename` which gives the
A source range is an object with a property `filename` that gives the
filename as a relative path from the current working directory, and then
two properties `start` and `end` which are both themselves objects
describing source positions, as described below.
@ -152,7 +152,7 @@ The nested objects in `diagnostics` have the following properties:
- `context` (string): An optional summary of the root context of the
diagnostic. For example, this might be the resource block containing the
expression which triggered the diagnostic. For some diagnostics this
expression that triggered the diagnostic. For some diagnostics, this
information is not available, and then this property will be `null`.
- `code` (string): A snippet of Terraform configuration including the
@ -197,7 +197,7 @@ interpretation only.
### Expression Value
An expression value object gives additional information about a value which is
An expression value object gives additional information about a value that is
part of the expression which triggered the diagnostic. This is especially
useful when using `for_each` or similar constructs, in order to identify
exactly which values are responsible for an error. The object has two properties:

@ -46,7 +46,7 @@ $ terraform import aws_instance.example i-abcd1234
This command locates the AWS EC2 instance with ID `i-abcd1234`. Then it attaches
the existing settings of the instance, as described by the EC2 API, to the
name `aws_instance.example` of a module. In this example the module path
name `aws_instance.example` of a module. In this example, the module path
implies that the root module is used. Finally, the mapping is saved in the
Terraform state.
@ -73,8 +73,8 @@ multiple resources are imported. For example, an AWS network ACL imports
an `aws_network_acl` but also one `aws_network_acl_rule` for each rule.
In this scenario, the secondary resources will not already exist in
configuration, so it is necessary to consult the import output and create
a `resource` block in configuration for each secondary resource. If this is
the configuration, so it is necessary to consult the import output and create
a `resource` block in the configuration for each secondary resource. If this is
not done, Terraform will plan to destroy the imported objects on the next run.
If you want to rename or otherwise move the imported resources, the

Loading…
Cancel
Save