From 7d5db9522f4e67af435e44d236fe45e3bcc05ce3 Mon Sep 17 00:00:00 2001 From: Nick Fagerlund Date: Tue, 20 Nov 2018 16:54:18 -0800 Subject: [PATCH] website: Fix plugin path on Windows (#19423) ...and one other reference to the application data directory. Context: https://docs.microsoft.com/en-us/windows/desktop/shell/knownfolderid#folderid_roamingappdata In newer Windows versions, the folder accessible as `%APPDATA%` (and via various APIs) is actually at something like "documents and settings\user\application data\roaming", while earlier versions omit the "\roaming" part of the path. This means you can confuse people by referring to the "application data" directory by its human name, because "roaming" is the real application data directory, but it looks like a subdirectory of "application data". Thus, it's less confusing to just use the `%APPDATA%` variable, with the added benefit that you can copy and paste the path and it'll just work in most places. --- website/docs/commands/cli-config.html.markdown | 2 +- website/docs/commands/init.html.markdown | 2 +- website/docs/configuration/providers.html.md | 4 ++-- website/docs/plugins/basics.html.md | 2 +- 4 files changed, 5 insertions(+), 5 deletions(-) diff --git a/website/docs/commands/cli-config.html.markdown b/website/docs/commands/cli-config.html.markdown index eb420fd82..72e114df4 100644 --- a/website/docs/commands/cli-config.html.markdown +++ b/website/docs/commands/cli-config.html.markdown @@ -19,7 +19,7 @@ The configuration is placed in a single file whose location depends on the host operating system: * On Windows, the file must be named named `terraform.rc` and placed - in the relevant user's "Application Data" directory. The physical location + in the relevant user's `%APPDATA%` directory. The physical location of this directory depends on your Windows version and system configuration; use `$env:APPDATA` in PowerShell to find its location on your system. * On all other systems, the file must be named `.terraformrc` (note diff --git a/website/docs/commands/init.html.markdown b/website/docs/commands/init.html.markdown index 1c78ce7a0..8e4a09dd0 100644 --- a/website/docs/commands/init.html.markdown +++ b/website/docs/commands/init.html.markdown @@ -123,7 +123,7 @@ For [providers distributed by HashiCorp](/docs/providers/index.html), init will automatically download and install plugins if necessary. Plugins can also be manually installed in the user plugins directory, located at `~/.terraform.d/plugins` on most operating systems and -`\plugins` on Windows. +`%APPDATA%\terraform.d\plugins` on Windows. For more information about configuring and installing providers, see [Configuration: Providers](/docs/configuration/providers.html). diff --git a/website/docs/configuration/providers.html.md b/website/docs/configuration/providers.html.md index 28e4dcfdd..2304f1c52 100644 --- a/website/docs/configuration/providers.html.md +++ b/website/docs/configuration/providers.html.md @@ -211,8 +211,8 @@ locations, depending on the host operating system: Operating system | User plugins directory ------------------|----------------------- -Windows | `terraform.d\plugins` in your user's "Application Data" directory -All other systems | `.terraform.d/plugins` in your user's home directory +Windows | `%APPDATA%\terraform.d\plugins` +All other systems | `~/.terraform.d/plugins` Once a plugin is installed, `terraform init` can initialize it normally. diff --git a/website/docs/plugins/basics.html.md b/website/docs/plugins/basics.html.md index dafcec5bb..bba437822 100644 --- a/website/docs/plugins/basics.html.md +++ b/website/docs/plugins/basics.html.md @@ -39,7 +39,7 @@ in its respective documentation section. The [provider plugins distributed by HashiCorp](/docs/providers/index.html) are automatically installed by `terraform init`. Third-party plugins (both providers and provisioners) can be manually installed into the user plugins -directory, located at `\terraform.d\plugins` on Windows and +directory, located at `%APPDATA%\terraform.d\plugins` on Windows and `~/.terraform.d/plugins` on other systems. For more information, see: