ResiLien
/
terraform
2
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
terraform/website
History
Dan Carley 64c1280951 command/fmt: Improve documentation for -diff and defaults (#6398) 
* command/fmt: Document -diff doesn't disable -write

As noted in hashicorp/terraform#6343, this description misleadingly
suggested that the `-diff` option disables the `-write` option.

This isn't the case and because of the default options (described in
c753390) the behaviour of `terraform fmt -diff` is actually the same as
`terraform fmt -write -list -diff`.

Replace the "instead of rewriting" description to clarify that.

Documentation in hcl/fmtcmd is corrected in hashicorp/hcl#117 but it's not
really necessary to bump the dependency version.

* command/fmt: Show flag defaults in help text

These were documented on the website but not in the `-help` text. This
should help to clarify that you need to pass `-list=false -write=false
-diff` if you only want to see diffs.

Accordingly I've replaced the word "disabled" with "always false" in the
STDIN special cases so that it matches the terminology used in the defaults
and better indicates that it is overridden.

NB: The 3x duplicated defaults and documentation makes me feel uneasy once
again. I'm not sure how to solve that, though.
 		2016-04-29 00:39:53 +01:00
..
.bundle annoucnement bnr 2016-04-11 13:02:15 -05:00
helpers Do matching in sidebar_current via regex or equal sign 2015-05-08 10:40:51 +01:00
scripts Fix website metadata script 2016-04-12 20:09:27 +01:00
source command/fmt: Improve documentation for -diff and defaults (#6398) 2016-04-29 00:39:53 +01:00
Gemfile Fix issues building documentation behind corporate filewall on Windows. 2015-07-09 11:07:45 -04:00
Gemfile.lock Update middleman-hashicorp (#6315) 2016-04-22 22:52:52 -05:00
LICENSE.md website: initial commit 2014-07-16 17:51:48 -04:00
Makefile fix Makefile 2015-09-24 11:48:52 -07:00
README.md Update README to point to Makefile 2015-09-24 09:57:38 -07:00
Vagrantfile provider/azurerm: Clean up work for base provider 2015-12-15 18:31:02 -05:00
config.rb v0.6.15 2016-04-22 18:29:43 +00:00
config.ru Add Rack::Protection 2015-07-13 12:50:17 -04:00
packer.json Fix website metadata script 2016-04-12 20:09:27 +01:00

README.md

Terraform Website

This subdirectory contains the entire source for the Terraform Website. This is a Middleman project, which builds a static site from these source files.

Contributions Welcome

If you find a typo or you feel like you can improve the HTML, CSS, or JavaScript, we welcome contributions. Feel free to open issues or pull requests like any normal GitHub project, and we'll merge it in.

Running the Site Locally

Running the site locally is simple. First you need a working copy of Ruby >= 2.0 and Bundler. Then you can clone this repo and run make dev.

Then open up http://localhost:4567. Note that some URLs you may need to append ".html" to make them work (in the navigation).