From f44e4b2c6aa7bf034921ba622657e6ca2f6f26ee Mon Sep 17 00:00:00 2001 From: Kristin Laemmert Date: Wed, 27 Feb 2019 11:08:31 -0800 Subject: [PATCH] website: add documentation for terraform providers schema (#20468) * website: add documentation for terraform providers schema --- website/docs/commands/providers.html.markdown | 9 ++- .../docs/commands/providers/schema.html.md | 22 +++++++ website/layouts/commands-providers.erb | 58 +++++++++++++++++++ 3 files changed, 87 insertions(+), 2 deletions(-) create mode 100644 website/docs/commands/providers/schema.html.md create mode 100644 website/layouts/commands-providers.erb diff --git a/website/docs/commands/providers.html.markdown b/website/docs/commands/providers.html.markdown index 688b833ed..85dddce99 100644 --- a/website/docs/commands/providers.html.markdown +++ b/website/docs/commands/providers.html.markdown @@ -1,9 +1,9 @@ --- -layout: "docs" +layout: "commands-providers" page_title: "Command: providers" sidebar_current: "docs-commands-providers" description: |- - The "providers" sub-command prints information about the providers used + The `terraform providers` command prints information about the providers used in the current configuration. --- @@ -28,9 +28,14 @@ Provider dependencies are created in several different ways: This command gives an overview of all of the current dependencies, as an aid to understanding why a particular provider is needed. +This command is a nested subcommand, meaning that it has further subcommands. +These subcommands are listed to the left. + ## Usage Usage: `terraform providers [config-path]` Pass an explicit configuration path to override the default of using the current working directory. + +Please refer to the subcommands to the left for additional usages. diff --git a/website/docs/commands/providers/schema.html.md b/website/docs/commands/providers/schema.html.md new file mode 100644 index 000000000..49c9752a4 --- /dev/null +++ b/website/docs/commands/providers/schema.html.md @@ -0,0 +1,22 @@ +--- +layout: "commands-providers" +page_title: "Command: providers schema" +sidebar_current: "docs-commands-providers-schema" +description: |- + The `terraform providers schema` command prints detailed schemas for the providers used + in the current configuration. +--- + +# Command: terraform providers schema + +The `terraform providers schema` command is used to print detailed schemas for the providers used in the current configuration. + +## Usage + +Usage: `terraform providers schema [options]` + +The list of available flags are: + +* `-json` - Displays the schemas in a machine-readble, JSON format. + +Please note that, at this time, the `-json` flag is a _required_ option. In future releases, this command will be extended to allow for additional options. diff --git a/website/layouts/commands-providers.erb b/website/layouts/commands-providers.erb new file mode 100644 index 000000000..432136308 --- /dev/null +++ b/website/layouts/commands-providers.erb @@ -0,0 +1,58 @@ +<% wrap_layout :inner do %> + <% content_for :sidebar do %> +

Terraform CLI

+ + + +

Other Docs

+ + + <% end %> + + <%= yield %> +<% end %> \ No newline at end of file