summaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
authorThomas O'Donnell <andytom@users.noreply.github.com>2021-01-23 15:17:51 +0100
committerGitHub <noreply@github.com>2021-01-23 15:17:51 +0100
commita67bf5b34f0d1fdcdbf6b8b50977fd8f9b7cd532 (patch)
tree414fc5f77c6c989532be06dcf73b88bc792bfc5a /docs
parent5eacd3abee879ad62dc8abdca6ad54f17d403658 (diff)
docs(terraform): Make version perf issue obvious (#2107)
This intends to make the performance issue with the terraform version more obvious.
Diffstat (limited to 'docs')
-rw-r--r--docs/config/README.md8
1 files changed, 7 insertions, 1 deletions
diff --git a/docs/config/README.md b/docs/config/README.md
index 5fc98c76c..a078e74c9 100644
--- a/docs/config/README.md
+++ b/docs/config/README.md
@@ -2345,8 +2345,14 @@ format = "via [🏎 $version](red bold)"
## Terraform
The `terraform` module shows the currently selected terraform workspace and version.
-By default the terraform version is not shown, since this is slow on current versions of terraform when a lot of plugins are in use.
+
+::: tip
+
+By default the terraform version is not shown, since this is slow for current versions of terraform when a lot of plugins are in use.
If you still want to enable it, [follow the example shown below](#with-version).
+
+:::
+
The module will be shown if any of the following conditions are met:
- The current directory contains a `.terraform` folder