From a67bf5b34f0d1fdcdbf6b8b50977fd8f9b7cd532 Mon Sep 17 00:00:00 2001 From: Thomas O'Donnell Date: Sat, 23 Jan 2021 15:17:51 +0100 Subject: [PATCH] docs(terraform): Make version perf issue obvious (#2107) This intends to make the performance issue with the terraform version more obvious. --- docs/config/README.md | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/docs/config/README.md b/docs/config/README.md index 5fc98c76..a078e74c 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