History

Mitchell Hashimoto 55985a6f9e Merge pull request #2752 from SamClinckspoor/patch-1 website: Fixed typo in AWS_CLOUDWATCH_METRIC_ALARM docs		2015-07-17 10:49:38 -07:00
..
helpers	Do matching in sidebar_current via regex or equal sign	2015-05-08 10:40:51 +01:00
source	Merge pull request #2752 from SamClinckspoor/patch-1	2015-07-17 10:49:38 -07:00
.buildpacks	website: initial commit	2014-07-16 17:51:48 -04:00
Gemfile	Fix issues building documentation behind corporate filewall on Windows.	2015-07-09 11:07:45 -04:00
Gemfile.lock	Weird bundler. Weird	2015-07-13 13:15:53 -04:00
LICENSE.md	website: initial commit	2014-07-16 17:51:48 -04:00
Procfile	website: initial commit	2014-07-16 17:51:48 -04:00
README.md	docs: clarify ruby deps for local website dev	2015-05-04 14:51:24 -05:00
Vagrantfile	Fix issues building documentation behind corporate filewall on Windows.	2015-07-09 11:07:45 -04:00
config.rb	Update to newest middleman-hashicorp	2015-05-15 16:11:52 -04:00
config.ru	Add Rack::Protection	2015-07-13 12:50:17 -04: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 the following commands from this directory:

$ bundle
# ( installs all gem dependencies )
$ bundle exec middleman server
# ( boots the local server )

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