ResiLien
/
terraform
2
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Add initial run local instructions to readme

This commit is contained in:
Laura Pacilio 2021-07-02 12:08:00 -04:00
parent dfc12a6a9e
commit c2b492a814
1 changed files with 17 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
website/README.md
View File

@ -7,3 +7,20 @@ The files in this directory are intended to be used in conjunction with
[the `terraform-website` repository](https://github.com/hashicorp/terraform-website), which brings all of the [the `terraform-website` repository](https://github.com/hashicorp/terraform-website), which brings all of the
different documentation sources together and contains the scripts for testing and building the site as different documentation sources together and contains the scripts for testing and building the site as
a whole. 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](https://docs.docker.com/get-docker/).
2. Create a ~/go directory manually or by [installing Go](https://golang.org/doc/install).
3. Set GOPATH as an environment variable: 
- bash: `export $GOPATH=~/go`
- 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.