History

Laura Pacilio 03e6f0d385 Update formatting for terminal commands		2021-07-02 12:16:45 -04:00
..
docs	Merge pull request #28983 from KurtLehnardt/patch-1	2021-06-30 08:54:04 -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	commands: `terraform add` (#28874 )	2021-06-17 12:08:37 -04:00
upgrade-guides	Update 0-15.html.markdown	2021-06-09 11:08:45 -07:00
README.md	Update formatting for terminal commands	2021-07-02 12:16:45 -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.

Set Up Local Environment

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

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

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

Launch Site Locally

Navigate into your local terraform top-level directory and run make website. Preview the site at http://localhost:4567.