Skip to content

Commit

Permalink
Merge pull request #27325 from hashicorp/backport/dec20_link_updates/…
Browse files Browse the repository at this point in the history
…jointly-glorious-yak

Backport of website: Fix broken/wobbly links into v0.14
  • Loading branch information
nfagerlund committed Dec 17, 2020
2 parents 4ff7c0b + 36c43e6 commit 1995dbd
Show file tree
Hide file tree
Showing 44 changed files with 141 additions and 110 deletions.
2 changes: 1 addition & 1 deletion website/docs/backends/state.html.md
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,7 @@ prior to forcing the overwrite.

Backends are responsible for supporting [state locking](/docs/state/locking.html)
if possible. Not all backend types support state locking. In the
[list of supported backend types](/docs/backends/types) we explicitly note
[list of supported backend types](/docs/backends/types/index.html) we explicitly note
whether locking is supported.

For more information on state locking, view the
Expand Down
4 changes: 2 additions & 2 deletions website/docs/backends/types/azurerm.html.md
Original file line number Diff line number Diff line change
Expand Up @@ -146,9 +146,9 @@ data "terraform_remote_state" "foo" {

The following configuration options are supported:

* `storage_account_name` - (Required) The Name of [the Storage Account](https://www.terraform.io/docs/providers/azurerm/r/storage_account.html).
* `storage_account_name` - (Required) The Name of [the Storage Account](https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/resources/storage_account).

* `container_name` - (Required) The Name of [the Storage Container](https://www.terraform.io/docs/providers/azurerm/r/storage_container.html) within the Storage Account.
* `container_name` - (Required) The Name of [the Storage Container](https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/resources/storage_container) within the Storage Account.

* `key` - (Required) The name of the Blob used to retrieve/store Terraform's State file inside the Storage Container.

Expand Down
2 changes: 1 addition & 1 deletion website/docs/backends/types/cos.html.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ terraform {
}
```

This assumes we have a [COS Bucket](https://www.terraform.io/docs/providers/tencentcloud/r/cos_bucket.html) created named `bucket-for-terraform-state-1258798060`,
This assumes we have a [COS Bucket](https://registry.terraform.io/providers/tencentcloudstack/tencentcloud/latest/docs/resources/cos_bucket) created named `bucket-for-terraform-state-1258798060`,
Terraform state will be written into the file `terraform/state/terraform.tfstate`.

## Data Source Configuration
Expand Down
6 changes: 3 additions & 3 deletions website/docs/backends/types/oss.html.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,9 +33,9 @@ terraform {
}
```

This assumes we have a [OSS Bucket](https://www.terraform.io/docs/providers/alicloud/r/oss_bucket.html) created called `bucket-for-terraform-state`,
a [OTS Instance](https://www.terraform.io/docs/providers/alicloud/r/ots_instance.html) called `terraform-remote` and
a [OTS TableStore](https://www.terraform.io/docs/providers/alicloud/r/ots_table.html) called `statelock`. The
This assumes we have a [OSS Bucket](https://registry.terraform.io/providers/aliyun/alicloud/latest/docs/resources/oss_bucket) created called `bucket-for-terraform-state`,
a [OTS Instance](https://registry.terraform.io/providers/aliyun/alicloud/latest/docs/resources/ots_instance) called `terraform-remote` and
a [OTS TableStore](https://registry.terraform.io/providers/aliyun/alicloud/latest/docs/resources/ots_table) called `statelock`. The
Terraform state will be written into the file `path/mystate/version-1.tfstate`. The `TableStore` must have a primary key named `LockID` of type `String`.


Expand Down
2 changes: 1 addition & 1 deletion website/docs/commands/0.13upgrade.html.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ providers are in use for a module, detect the source address for those
providers where possible, and record this information in a
[`required_providers` block][required-providers].

[required-providers]: /docs/configuration/terraform.html#specifying-required-provider-versions
[required-providers]: /docs/configuration/provider-requirements.html

~> Note: the command ignores `.tf.json` files and override files in the module.

Expand Down
10 changes: 5 additions & 5 deletions website/docs/commands/apply.html.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -72,11 +72,11 @@ The command-line flags are all optional. The list of available flags are:

* `-var 'foo=bar'` - Set a variable in the Terraform configuration. This flag
can be set multiple times. Variable values are interpreted as
[HCL](/docs/configuration/syntax.html#HCL), so list and map values can be
specified via this flag.
[literal expressions](/docs/configuration/expressions/types.html) in the
Terraform language, so list and map values can be specified via this flag.

* `-var-file=foo` - Set variables in the Terraform configuration from
a [variable file](/docs/configuration/variables.html#variable-files). If
a [variable file](/docs/configuration/variables.html#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
first and the `.auto.tfvars` files after in alphabetical order. Any files
Expand All @@ -92,14 +92,14 @@ that directory as the root module instead of the current working directory.
That usage is still supported in Terraform v0.14, but is now deprecated and we
plan to remove it in Terraform v0.15. If your workflow relies on overriding
the root module directory, use
[the `-chdir` global option](./#switching-working-directory-with--chdir)
[the `-chdir` global option](./#switching-working-directory-with-chdir)
instead, which works across all commands and makes Terraform consistently look
in the given directory for all files it would normaly read or write in the
current working directory.

If your previous use of this legacy pattern was also relying on Terraform
writing the `.terraform` subdirectory into the current working directory even
though the root module directory was overridden, use
[the `TF_DATA_DIR` environment variable](environment-variables.html#TF_DATA_DIR)
[the `TF_DATA_DIR` environment variable](environment-variables.html#tf_data_dir)
to direct Terraform to write the `.terraform` directory to a location other
than the current working directory.
7 changes: 4 additions & 3 deletions website/docs/commands/import.html.md
Original file line number Diff line number Diff line change
Expand Up @@ -75,11 +75,12 @@ in the configuration for the target resource, and that is the best behavior in m

* `-var 'foo=bar'` - Set a variable in the Terraform configuration. This flag
can be set multiple times. Variable values are interpreted as
[HCL](/docs/configuration/syntax.html#HCL), so list and map values can be
specified via this flag. This is only useful with the `-config` flag.
[literal expressions](/docs/configuration/expressions/types.html) in the
Terraform language, so list and map values can be specified via this flag.
This is only useful with the `-config` flag.

* `-var-file=foo` - Set variables in the Terraform configuration from
a [variable file](/docs/configuration/variables.html#variable-files). If
a [variable file](/docs/configuration/variables.html#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
first and the `.auto.tfvars` files after in alphabetical order. Any files
Expand Down
14 changes: 8 additions & 6 deletions website/docs/commands/init.html.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -142,10 +142,12 @@ You can modify `terraform init`'s plugin behavior with the following options:
cause Terraform to ignore any selections recorded in the dependency lock
file, and to take the newest available version matching the configured
version constraints.
- `-get-plugins=false` — Skip plugin installation. _Note: Since Terraform 0.13, this
command has been superseded by [`provider_installation`](./cli-config.html#provider-installation)
blocks or using the [`plugin_cache_dir`](./cli-config.html#plugin_cache_dir) setting.
It should not be used in Terraform versions 0.13+.
- `-get-plugins=false` — Skip plugin installation.

-> Note: Since Terraform 0.13, this option has been superseded by the
[`provider_installation`](./cli-config.html#provider-installation) and
[`plugin_cache_dir`](./cli-config.html#plugin_cache_dir) settings.
It should not be used in Terraform versions 0.13+.
- `-plugin-dir=PATH` — Force plugin installation to read plugins _only_ from
the specified directory, as if it had been configured as a `filesystem_mirror`
in the CLI configuration. If you intend to routinely use a particular
Expand Down Expand Up @@ -176,14 +178,14 @@ that directory as the root module instead of the current working directory.
That usage is still supported in Terraform v0.14, but is now deprecated and we
plan to remove it in Terraform v0.15. If your workflow relies on overriding
the root module directory, use
[the `-chdir` global option](./#switching-working-directory-with--chdir)
[the `-chdir` global option](./#switching-working-directory-with-chdir)
instead, which works across all commands and makes Terraform consistently look
in the given directory for all files it would normaly read or write in the
current working directory.

If your previous use of this legacy pattern was also relying on Terraform
writing the `.terraform` subdirectory into the current working directory even
though the root module directory was overridden, use
[the `TF_DATA_DIR` environment variable](environment-variables.html#TF_DATA_DIR)
[the `TF_DATA_DIR` environment variable](environment-variables.html#tf_data_dir)
to direct Terraform to write the `.terraform` directory to a location other
than the current working directory.
12 changes: 6 additions & 6 deletions website/docs/commands/plan.html.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -76,13 +76,13 @@ The available options are:
Address](/docs/internals/resource-addressing.html) to target. This flag can
be used multiple times. See below for more information.

* `-var=foo=bar` - Set a variable in the Terraform configuration. This flag
* `-var 'foo=bar'` - Set a variable in the Terraform configuration. This flag
can be set multiple times. Variable values are interpreted as
[HCL](/docs/configuration/syntax.html#HCL), so list and map values can be
specified via this flag.
[literal expressions](/docs/configuration/expressions/types.html) in the
Terraform language, so list and map values can be specified via this flag.

* `-var-file=foo` - Set variables in the Terraform configuration from
a [variable file](/docs/configuration/variables.html#variable-files). If
a [variable file](/docs/configuration/variables.html#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
first and the `.auto.tfvars` files after in alphabetical order. Any files
Expand Down Expand Up @@ -142,14 +142,14 @@ module instead of the current working directory.
That usage is still supported in Terraform v0.14, but is now deprecated and we
plan to remove it in Terraform v0.15. If your workflow relies on overriding
the root module directory, use
[the `-chdir` global option](./#switching-working-directory-with--chdir)
[the `-chdir` global option](./#switching-working-directory-with-chdir)
instead, which works across all commands and makes Terraform consistently look
in the given directory for all files it would normaly read or write in the
current working directory.

If your previous use of this legacy pattern was also relying on Terraform
writing the `.terraform` subdirectory into the current working directory even
though the root module directory was overridden, use
[the `TF_DATA_DIR` environment variable](environment-variables.html#TF_DATA_DIR)
[the `TF_DATA_DIR` environment variable](environment-variables.html#tf_data_dir)
to direct Terraform to write the `.terraform` directory to a location other
than the current working directory.
6 changes: 3 additions & 3 deletions website/docs/commands/refresh.html.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -56,11 +56,11 @@ The `terraform refresh` command accepts the following options:

* `-var 'foo=bar'` - Set a variable in the Terraform configuration. This flag
can be set multiple times. Variable values are interpreted as
[HCL](/docs/configuration/syntax.html#HCL), so list and map values can be
specified via this flag.
[literal expressions](/docs/configuration/expressions/types.html) in the
Terraform language, so list and map values can be specified via this flag.

* `-var-file=foo` - Set variables in the Terraform configuration from
a [variable file](/docs/configuration/variables.html#variable-files). If
a [variable file](/docs/configuration/variables.html#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
first and the `.auto.tfvars` files after in alphabetical order. Any files
Expand Down
2 changes: 1 addition & 1 deletion website/docs/commands/state/push.html.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ manual intervention is necessary with the remote state.
Usage: `terraform state push [options] PATH`

This command will push the state specified by PATH to the currently
configured [backend](/docs/backends).
configured [backend](/docs/configuration/blocks/backends/index.html).

If PATH is "-" then the state data to push is read from stdin. This data
is loaded completely into memory and verified prior to being written to
Expand Down
8 changes: 4 additions & 4 deletions website/docs/configuration-0-11/interpolation.html.md
Original file line number Diff line number Diff line change
Expand Up @@ -409,7 +409,7 @@ The supported built-in functions are:

* `timestamp()` - Returns a UTC timestamp string in RFC 3339 format. This string will change with every
invocation of the function, so in order to prevent diffs on every plan & apply, it must be used with the
[`ignore_changes`](./resources.html#ignore-changes) lifecycle attribute.
[`ignore_changes`](./resources.html#ignore_changes) lifecycle attribute.

* `timeadd(time, duration)` - Returns a UTC timestamp string corresponding to adding a given `duration` to `time` in RFC 3339 format.
For example, `timeadd("2017-11-22T00:00:00Z", "10m")` produces a value `"2017-11-22T00:10:00Z"`.
Expand All @@ -424,7 +424,7 @@ The supported built-in functions are:

* `urlencode(string)` - Returns an URL-safe copy of the string.

* `uuid()` - Returns a random UUID string. This string will change with every invocation of the function, so in order to prevent diffs on every plan & apply, it must be used with the [`ignore_changes`](./resources.html#ignore-changes) lifecycle attribute.
* `uuid()` - Returns a random UUID string. This string will change with every invocation of the function, so in order to prevent diffs on every plan & apply, it must be used with the [`ignore_changes`](./resources.html#ignore_changes) lifecycle attribute.

* `values(map)` - Returns a list of the map values, in the order of the keys
returned by the `keys` function. This function only works on flat maps and
Expand All @@ -449,7 +449,7 @@ Terraform 0.12 and later.
## Templates

Long strings can be managed using templates.
[Templates](/docs/providers/template/index.html) are
[Templates](https://registry.terraform.io/providers/hashicorp/template/latest/docs) are
[data-sources](./data-sources.html) defined by a
string with interpolation tokens (usually loaded from a file) and some variables
to use during interpolation. They have a computed `rendered` attribute
Expand Down Expand Up @@ -487,7 +487,7 @@ by the surrounding scope of the configuration.

You may use any of the built-in functions in your template. For more
details on template usage, please see the
[template_file documentation](/docs/providers/template/d/file.html).
[template_file documentation](https://registry.terraform.io/providers/hashicorp/template/latest/docs/data-sources/file).

### Using Templates with Count

Expand Down
4 changes: 2 additions & 2 deletions website/docs/configuration-0-11/modules.html.md
Original file line number Diff line number Diff line change
Expand Up @@ -233,7 +233,7 @@ resource "aws_s3_bucket" "example" {
This approach is recommended in the common case where only a single
configuration is needed for each provider across the entire configuration.

In more complex situations there may be [multiple provider instances](/docs/configuration/providers.html#multiple-provider-instances),
In more complex situations there may be [multiple provider instances](./providers.html#multiple-provider-instances),
or a child module may need to use different provider settings than
its parent. For such situations, it's necessary to pass providers explicitly
as we will see in the next section.
Expand Down Expand Up @@ -272,7 +272,7 @@ module "example" {

The `providers` argument within a `module` block is similar to
the `provider` argument within a resource as described for
[multiple provider instances](/docs/configuration/providers.html#multiple-provider-instances),
[multiple provider instances](./providers.html#multiple-provider-instances),
but is a map rather than a single string because a module may contain resources
from many different providers.

Expand Down
2 changes: 1 addition & 1 deletion website/docs/configuration-0-11/providers.html.md
Original file line number Diff line number Diff line change
Expand Up @@ -220,7 +220,7 @@ may also be used, but currently may cause errors when running `terraform destroy
## Third-party Plugins

Anyone can develop and distribute their own Terraform providers. (See
[Writing Custom Providers](/docs/extend/writing-custom-providers.html) for more
[Writing Custom Providers](https://learn.hashicorp.com/collections/terraform/providers?utm_source=WEBSITE/docs/extend/writing-custom-providers.htmlutm_medium=WEB_IO/docs/extend/writing-custom-providers.htmlutm_offer=ARTICLE_PAGE/docs/extend/writing-custom-providers.htmlutm_content=DOCS) for more
about provider development.) These third-party providers must be manually
installed, since `terraform init` cannot automatically download them.

Expand Down
6 changes: 3 additions & 3 deletions website/docs/configuration-0-11/resources.html.md
Original file line number Diff line number Diff line change
Expand Up @@ -98,7 +98,7 @@ There are **meta-parameters** available to all resources:
Individual Resources may provide a `timeouts` block to enable users to configure the
amount of time a specific operation is allowed to take before being considered
an error. For example, the
[aws_db_instance](/docs/providers/aws/r/db_instance.html#timeouts)
[aws_db_instance](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/db_instance#timeouts)
resource provides configurable timeouts for the
`create`, `update`, and `delete` operations. Any Resource that provides Timeouts
will document the default values for that operation, and users can overwrite
Expand Down Expand Up @@ -211,7 +211,7 @@ You can use the `${count.index}`
[variable](./variables.html) to accomplish this.

For example, here's how you could create three [AWS
Instances](/docs/providers/aws/r/instance.html) each with their own
Instances](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/instance) each with their own
static IP address:

```hcl
Expand All @@ -232,7 +232,7 @@ resource "aws_instance" "app" {

To reference a particular instance of a resource you can use `resource.foo.*.id[#]` where `#` is the index number of the instance.

For example, to create a list of all [AWS subnet](/docs/providers/aws/r/subnet.html) ids vs referencing a specific subnet in the list you can use this syntax:
For example, to create a list of all [AWS subnet](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/subnet) ids vs referencing a specific subnet in the list you can use this syntax:

```hcl
resource "aws_vpc" "foo" {
Expand Down
2 changes: 1 addition & 1 deletion website/docs/configuration-0-11/variables.html.md
Original file line number Diff line number Diff line change
Expand Up @@ -211,7 +211,7 @@ $ TF_VAR_image=foo terraform apply
```

Maps and lists can be specified using environment variables as well using
[HCL](./syntax.html#HCL) syntax in the value.
[HCL](./syntax.html) syntax in the value.

For a list variable like so:

Expand Down
6 changes: 3 additions & 3 deletions website/docs/configuration/blocks/resources/behavior.html.md
Original file line number Diff line number Diff line change
Expand Up @@ -95,9 +95,9 @@ types that operate only within Terraform itself, calculating some results and
saving those results in the state for future use.

For example, local-only resource types exist for
[generating private keys](/docs/providers/tls/r/private_key.html),
[issuing self-signed TLS certificates](/docs/providers/tls/r/self_signed_cert.html),
and even [generating random ids](/docs/providers/random/r/id.html).
[generating private keys](https://registry.terraform.io/providers/hashicorp/tls/latest/docs/resources/private_key),
[issuing self-signed TLS certificates](https://registry.terraform.io/providers/hashicorp/tls/latest/docs/resources/self_signed_cert),
and even [generating random ids](https://registry.terraform.io/providers/hashicorp/random/latest/docs/resources/id).
While these resource types often have a more marginal purpose than those
managing "real" infrastructure objects, they can be useful as glue to help
connect together other resources.
Expand Down
Loading

0 comments on commit 1995dbd

Please sign in to comment.