From 0e004f2377b53471e1a989f672053a12b927b38b Mon Sep 17 00:00:00 2001 From: Nick Fagerlund Date: Fri, 9 Jul 2021 14:44:58 -0700 Subject: [PATCH] website: remove legacy provider docs index (#29134) * website: Update or remove references to legacy provider docs We've finally evicted the last of the legacy provider docs from terraform.io! Let's celebrate by purging all memory of them. The 0.11 docs are now so thoroughly legacy that I don't believe they need a new destination for their provider links, so I just removed those. * website: remove old provider docs index This will require a redirect in the terraform-website repo. * Apply suggestions from code review Co-authored-by: Laura Pacilio <83350965+laurapacilio@users.noreply.github.com> Co-authored-by: Laura Pacilio <83350965+laurapacilio@users.noreply.github.com> --- website/docs/cli/commands/index.html.md | 4 +- .../configuration-0-11/data-sources.html.md | 4 +- .../docs/configuration-0-11/providers.html.md | 4 +- .../docs/configuration-0-11/resources.html.md | 6 +-- .../docs/language/data-sources/index.html.md | 8 ++-- website/docs/language/providers/index.html.md | 17 ++++++- website/docs/providers/index.html.markdown | 44 ------------------- website/layouts/language.erb | 5 --- 8 files changed, 30 insertions(+), 62 deletions(-) delete mode 100644 website/docs/providers/index.html.markdown diff --git a/website/docs/cli/commands/index.html.md b/website/docs/cli/commands/index.html.md index 8b5f02291..513825066 100644 --- a/website/docs/cli/commands/index.html.md +++ b/website/docs/cli/commands/index.html.md @@ -19,8 +19,8 @@ We refer to the `terraform` command line tool as "Terraform CLI" elsewhere in the documentation. This terminology is often used to distinguish it from other components you might use in the Terraform product family, such as [Terraform Cloud](/docs/cloud/) or -the various [Terraform providers](/docs/providers/), which are developed and -released separately from Terraform CLI. +the various [Terraform providers](/docs/language/providers/index.html), which +are developed and released separately from Terraform CLI. To view a list of the commands available in your current Terraform version, run `terraform` with no additional arguments: diff --git a/website/docs/configuration-0-11/data-sources.html.md b/website/docs/configuration-0-11/data-sources.html.md index 90f3463e3..abd435e46 100644 --- a/website/docs/configuration-0-11/data-sources.html.md +++ b/website/docs/configuration-0-11/data-sources.html.md @@ -64,8 +64,8 @@ parameter) and `NAME` (second parameter). The combination of the type and name must be unique. Within the block (the `{ }`) is configuration for the data instance. The -configuration is dependent on the type, and is documented for each -data source in the [providers section](/docs/providers/index.html). +configuration is dependent on the type; consult the [provider's documentation] (https://registry.terraform.io/browse/providers) for +details. Each data instance will export one or more attributes, which can be interpolated into other resources using variables of the form diff --git a/website/docs/configuration-0-11/providers.html.md b/website/docs/configuration-0-11/providers.html.md index 2450f38e6..5380ff69e 100644 --- a/website/docs/configuration-0-11/providers.html.md +++ b/website/docs/configuration-0-11/providers.html.md @@ -48,8 +48,8 @@ header. For example, `provider "aws"` above is a configuration for the `aws` provider. Within the block body (between `{ }`) is configuration for the provider. -The configuration is dependent on the type, and is documented -[for each provider](/docs/providers/index.html). +The configuration is dependent on the type. Consult the [provider's documentation](https://registry.terraform.io/browse/providers) for details. +in each provider's documentation. The arguments `alias` and `version`, if present, are special arguments handled by Terraform Core for their respective features described above. All diff --git a/website/docs/configuration-0-11/resources.html.md b/website/docs/configuration-0-11/resources.html.md index 8b31603f4..cbf5cd699 100644 --- a/website/docs/configuration-0-11/resources.html.md +++ b/website/docs/configuration-0-11/resources.html.md @@ -41,9 +41,9 @@ parameter) and `NAME` (second parameter). The combination of the type and name must be unique. Within the block (the `{ }`) is configuration for the resource. The -configuration is dependent on the type, and is documented for each -resource type in the -[providers section](/docs/providers/index.html). +configuration is dependent on the type. Consult the [provider's documentation](https://registry.terraform.io/browse/providers) for details. + +details. ### Meta-parameters diff --git a/website/docs/language/data-sources/index.html.md b/website/docs/language/data-sources/index.html.md index 35af54b4e..969e52574 100644 --- a/website/docs/language/data-sources/index.html.md +++ b/website/docs/language/data-sources/index.html.md @@ -9,7 +9,7 @@ description: |- # Data Sources _Data sources_ allow Terraform use information defined outside of Terraform, -defined by another separate Terraform configuration, or modified by functions. +defined by another separate Terraform configuration, or modified by functions. > **Hands-on:** Try the [Query Data Sources](https://learn.hashicorp.com/tutorials/terraform/data-sources) tutorial on HashiCorp Learn. @@ -173,8 +173,10 @@ block label) and _name_ (second block label). The combination of the type and name must be unique. Within the block (the `{ }`) is configuration for the data instance. The -configuration is dependent on the type, and is documented for each -data source in the [providers section](/docs/providers/index.html). +configuration is dependent on the type; as with +[resources](/docs/language/resources/index.html), each provider on the +[Terraform Registry](https://registry.terraform.io/browse/providers) has its own +documentation for configuring and using the data types it provides. Each data instance will export one or more attributes, which can be used in other resources as reference expressions of the form diff --git a/website/docs/language/providers/index.html.md b/website/docs/language/providers/index.html.md index 648224b9c..9fd5b2f55 100644 --- a/website/docs/language/providers/index.html.md +++ b/website/docs/language/providers/index.html.md @@ -12,7 +12,7 @@ description: |- > **Hands-on:** Try the [Perform CRUD Operations with Providers](https://learn.hashicorp.com/tutorials/terraform/provider-use?in=terraform/configuration-language&utm_source=WEBSITE&utm_medium=WEB_IO&utm_offer=ARTICLE_PAGE&utm_content=DOCS) tutorial on HashiCorp Learn. Terraform relies on plugins called "providers" to interact with cloud providers, -SaaS providers, and other APIs. +SaaS providers, and other APIs. Terraform configurations must declare which providers they require so that Terraform can install and use them. Additionally, some providers require @@ -40,6 +40,21 @@ The [Terraform Registry](https://registry.terraform.io/browse/providers) is the main directory of publicly available Terraform providers, and hosts providers for most major infrastructure platforms. +## Provider Documentation + +Each provider has its own documentation, describing its resource +types and their arguments. + +The [Terraform Registry](https://registry.terraform.io/browse/providers) +includes documentation for a wide range of providers developed by HashiCorp, third-party vendors, and our Terraform community. Use the +"Documentation" link in a provider's header to browse its documentation. + +Provider documentation in the Registry is versioned; you can use the version +menu in the header to change which version you're viewing. + +For details about writing, generating, and previewing provider documentation, +see the [provider publishing documentation](/docs/registry/providers/docs.html). + ## How to Use Providers To use resources from a given provider, you need to include some information diff --git a/website/docs/providers/index.html.markdown b/website/docs/providers/index.html.markdown deleted file mode 100644 index 2656c9784..000000000 --- a/website/docs/providers/index.html.markdown +++ /dev/null @@ -1,44 +0,0 @@ ---- -layout: "language" -page_title: "Provider Documentation" -sidebar_current: "docs-providers" -description: |- - Terraform's resources are implemented by provider plugins. The Terraform - Registry is the main directory of publicly available Terraform providers. ---- - -# Provider Documentation - -Every Terraform provider has its own documentation, describing its resource -types and their arguments. - -The [Terraform Registry](https://registry.terraform.io/browse/providers) is the -main home for provider documentation. When viewing a provider's page on the -Terraform Registry, you can click the "Documentation" link in the header to -browse its documentation. - -Provider documentation in the Registry is versioned; you can use the version -menu in the header to change which version you're viewing. - -Learn more about writing, generating, and rendering provider documentation -in the [provider publishing documentation](/docs/registry/providers/docs.html). - -## Temporary Provider Documentation - -The following providers will be published on the Terraform Registry soon, but -aren't quite ready. Until they're published, their documentation is available at -the links below: - -- [Avi Vantage](/docs/providers/avi/index.html) -- [Chef](/docs/providers/chef/index.html) -- [Cobbler](/docs/providers/cobbler/index.html) -- [Genymotion](/docs/providers/genymotion/index.html) -- [Infoblox](/docs/providers/infoblox/index.html) -- [MySQL](/docs/providers/mysql/index.html) -- [Rubrik](/docs/providers/rubrik/index.html) -- [Rundeck](/docs/providers/rundeck/index.html) - -## Useful tools - -- [Doc preview tool](https://registry.terraform.io/tools/doc-preview) -- [terraform-plugin-docs](https://github.com/hashicorp/terraform-plugin-docs) diff --git a/website/layouts/language.erb b/website/layouts/language.erb index e129c088f..a5610bbd9 100644 --- a/website/layouts/language.erb +++ b/website/layouts/language.erb @@ -167,11 +167,6 @@
  • Dependency Lock File
    • - -
  • - Provider Documentation - -