resilien
/
terraform
2
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity
terraform/website
History
Laura Pacilio b3736334f7
Update website/README.md 
Co-authored-by: Tu Nguyen <im2nguyen@users.noreply.github.com>
 		2021-07-02 13:50:09 -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 website/README.md 2021-07-02 13:50:09 -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

  1. Install Docker.

  2. Create a ~/go directory manually or by installing Go.

  3. Open terminal and 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

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