History

Laura Pacilio f46974dbb2 Add detail to settings intro page metadata		2021-07-16 17:03:13 -04:00
..
docs	Add detail to settings intro page metadata	2021-07-16 17:03:13 -04:00
guides	Update page description metadata	2021-06-28 16:00:16 -04:00
intro	Update vs Cloudformation description	2021-07-01 11:07:23 -04:00
layouts	Add compatibility promises to sidebar toc	2021-06-30 10:10:25 -04:00
upgrade-guides	Update 0-15.html.markdown	2021-06-09 11:08:45 -07:00
README.md	Fix numbering for second step	2021-07-02 14:02:03 -04:00

README.md

Terraform Documentation

This directory contains the portions of the Terraform website that pertain to the core functionality, excluding providers and the overall configuration.

The files in this directory are intended to be used in conjunction with the terraform-website repository, which brings all of the different documentation sources together and contains the scripts for testing and building the site as a whole.

Previewing Changes

You should preview all of your changes locally before creating a pull request. The build includes content from this repository and the terraform-website repository, allowing you to preview the entire Terraform documentation site. If terraform-website isn't in your GOPATH, the preview command will clone it to your machine.

Set Up Local Environment

Install Docker.
Create a ~/go directory manually or by installing Go.
Open terminal and set GOPATH as an environment variable:

Bash: export $GOPATH=~/go(bash)

Zsh: echo -n 'export GOPATH=~/go' >> ~/.zshrc
Restart your terminal or command line session.

Launch Site Locally

Navigate into your local terraform top-level directory and run make website.
Open http://localhost:4567 in your web browser. While the preview is running, you can edit pages and Middleman will automatically rebuild them.
When you're done with the preview, press ctrl-C in your terminal to stop the server.