From 7ba654a8a9e43e4bb2a9390360d44df08ba4f4ed Mon Sep 17 00:00:00 2001 From: Nick Fagerlund Date: Wed, 20 Feb 2019 17:14:12 -0800 Subject: [PATCH] website: Revise show command docs --- website/docs/commands/show.html.markdown | 22 ++++++++++------------ 1 file changed, 10 insertions(+), 12 deletions(-) diff --git a/website/docs/commands/show.html.markdown b/website/docs/commands/show.html.markdown index e2ae06dd5..b6dc92122 100644 --- a/website/docs/commands/show.html.markdown +++ b/website/docs/commands/show.html.markdown @@ -14,23 +14,21 @@ that the planned operations are expected, or to inspect the current state as Terraform sees it. Machine-readable output is generated by adding the `-json` command-line -flag. This is only available when using `show` with a path to a Terraform -plan file. +flag. -**NOTE** -When using the `-json` command-line flag, any sensitive values in -terraform state will be displayed in plain text. For more information, see -[_Sensitive Data in State_](/docs/state/sensitive-data.html). +-> **Note:** When using the `-json` command-line flag, any sensitive values in +Terraform state will be displayed in plain text. For more information, see +[Sensitive Data in State](/docs/state/sensitive-data.html). -## json output +## JSON Output -When `terraform show -json` is run with a path to a Terraform state file or no -path, a json representation of the current state will be shown. +For Terraform state files (including when no path is provided), +`terraform show -json` will show a JSON representation of the state. -When `terraform show -json` is run with a path to a Terraform plan file, a json -representation of the plan, configuration, and current state will be shown. +For Terraform plan files, `terraform show -json` will show a JSON representation +of the plan, configuration, and current state. -The output format is covered in detail in [_JSON Format_](/docs/internals/json-format.html). +The output format is covered in detail in [JSON Format](/docs/internals/json-format.html). ## Usage