ResiLien
/
terraform
2
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

website: add documentation for terraform providers schema (#20468) 

* website: add documentation for terraform providers schema
This commit is contained in:
Kristin Laemmert 2019-02-27 11:08:31 -08:00 committed by GitHub
parent 47443e39ad
commit f44e4b2c6a
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 87 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
website/docs/commands/providers.html.markdown
View File

@ -1,9 +1,9 @@
--- ---
layout: "docs" layout: "commands-providers"
page_title: "Command: providers" page_title: "Command: providers"
sidebar_current: "docs-commands-providers" sidebar_current: "docs-commands-providers"
description: |- 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. 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 This command gives an overview of all of the current dependencies, as an aid
to understanding why a particular provider is needed. 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
Usage: `terraform providers [config-path]` Usage: `terraform providers [config-path]`
Pass an explicit configuration path to override the default of using the Pass an explicit configuration path to override the default of using the
current working directory. current working directory.
Please refer to the subcommands to the left for additional usages.

22
website/docs/commands/providers/schema.html.md Normal file
View File

@ -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.

58
website/layouts/commands-providers.erb Normal file
View File

@ -0,0 +1,58 @@
<% wrap_layout :inner do %>
<% content_for :sidebar do %>
<h4><a href="/docs/index.html">Terraform CLI</a></h4>
<ul class="nav docs-sidenav">
<li<%= sidebar_current("docs-commands") %>>
<a class="back" href="/docs/commands/index.html">Commands (CLI)</a>
<ul class="nav">
<li<%= sidebar_current("docs-commands-providers") %>>
<a href="/docs/commands/providers.html">providers</a>
<ul class="nav">
<li<%= sidebar_current("docs-commands-providers-schema") %>>
<a href="/docs/commands/providers/schema.html">list</a>
</li>
</ul>
</li>
</ul>
</li>
</ul>
<h4>Other Docs</h4>
<ul class="nav docs-sidenav">
<li>
<a class="back" href="/downloads.html">Download Terraform</a>
</li>
<li>
<a class="back" href="/intro/index.html">Introduction to Terraform</a>
</li>
<li>
<a class="back" href="/docs/enterprise/index.html">Terraform Enterprise</a>
</li>
<li>
<a class="back" href="/guides/index.html">Guides and Whitepapers</a>
</li>
<li>
<a class="back" href="/docs/registry/index.html">Terraform Registry</a>
</li>
<li>
<a class="back" href="/docs/github-actions/index.html">Terraform GitHub Actions</a>
</li>
<li>
<a class="back" href="/docs/extend/index.html">Extending Terraform</a>
</li>
</ul>
<% end %>
<%= yield %>
<% end %>