From c2b492a8144ae35e7c55d51b9b7bab462e7608e5 Mon Sep 17 00:00:00 2001 From: Laura Pacilio <83350965+laurapacilio@users.noreply.github.com> Date: Fri, 2 Jul 2021 12:08:00 -0400 Subject: [PATCH 01/10] Add initial run local instructions to readme --- website/README.md | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) diff --git a/website/README.md b/website/README.md index 9ac535c19d..cc7313ad67 100644 --- a/website/README.md +++ b/website/README.md @@ -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 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](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. \ No newline at end of file From 03e6f0d3851595fc1056c2f5fde415c665d0086f Mon Sep 17 00:00:00 2001 From: Laura Pacilio <83350965+laurapacilio@users.noreply.github.com> Date: Fri, 2 Jul 2021 12:16:45 -0400 Subject: [PATCH 02/10] Update formatting for terminal commands --- website/README.md | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/website/README.md b/website/README.md index cc7313ad67..9a1f9ff6d2 100644 --- a/website/README.md +++ b/website/README.md @@ -16,9 +16,11 @@ You should preview all of your changes locally before creating a pull request. T 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` +3. 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** From 0fc32e5858278cda49f3b65cb72c477f9ab3b7f9 Mon Sep 17 00:00:00 2001 From: Laura Pacilio <83350965+laurapacilio@users.noreply.github.com> Date: Fri, 2 Jul 2021 12:19:28 -0400 Subject: [PATCH 03/10] Fix indentation --- website/README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/website/README.md b/website/README.md index 9a1f9ff6d2..3f29b878ef 100644 --- a/website/README.md +++ b/website/README.md @@ -18,9 +18,9 @@ You should preview all of your changes locally before creating a pull request. T 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`(bash) + Bash: `export $GOPATH=~/go`(bash) - Zsh: `echo -n 'export GOPATH=~/go' >> ~/.zshrc` + Zsh: `echo -n 'export GOPATH=~/go' >> ~/.zshrc` 4. Restart your terminal or command line session. **Launch Site Locally** From 10ccf2bd7f5107148ec5b2ea430fea17ce00d681 Mon Sep 17 00:00:00 2001 From: Laura Pacilio <83350965+laurapacilio@users.noreply.github.com> Date: Fri, 2 Jul 2021 12:26:33 -0400 Subject: [PATCH 04/10] Add more context to run instructions --- website/README.md | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/website/README.md b/website/README.md index 3f29b878ef..b15dd594d9 100644 --- a/website/README.md +++ b/website/README.md @@ -25,4 +25,8 @@ You should preview all of your changes locally before creating a pull request. T **Launch Site Locally** -Navigate into your local `terraform` top-level directory and run `make website`. Preview the site at http://localhost:4567. \ No newline at end of file +1. From terminal, navigate into your local `terraform` top-level directory and run `make website`. +3. Open `http://localhost:4567` in your web browser. +4. When you're done with the preview, press ctrl-C in your terminal to stop the server. + +While the preview is running, you can edit pages and Middleman will automatically rebuild them. From f2d89464ef5224a7cd56fcafc16840619b76dcf7 Mon Sep 17 00:00:00 2001 From: Laura Pacilio <83350965+laurapacilio@users.noreply.github.com> Date: Fri, 2 Jul 2021 12:29:35 -0400 Subject: [PATCH 05/10] Revise grouping in steps --- website/README.md | 8 +++----- 1 file changed, 3 insertions(+), 5 deletions(-) diff --git a/website/README.md b/website/README.md index b15dd594d9..f40809464a 100644 --- a/website/README.md +++ b/website/README.md @@ -16,7 +16,7 @@ You should preview all of your changes locally before creating a pull request. T 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: +3. Open terminal and set GOPATH as an environment variable: Bash: `export $GOPATH=~/go`(bash) @@ -25,8 +25,6 @@ You should preview all of your changes locally before creating a pull request. T **Launch Site Locally** -1. From terminal, navigate into your local `terraform` top-level directory and run `make website`. -3. Open `http://localhost:4567` in your web browser. +1. Navigate into your local `terraform` top-level directory and run `make website`. +3. Open `http://localhost:4567` in your web browser. While the preview is running, you can edit pages and Middleman will automatically rebuild them. 4. When you're done with the preview, press ctrl-C in your terminal to stop the server. - -While the preview is running, you can edit pages and Middleman will automatically rebuild them. From 52e209472638e9fc4f80b8161e3afb82f1abcae4 Mon Sep 17 00:00:00 2001 From: Laura Pacilio <83350965+laurapacilio@users.noreply.github.com> Date: Fri, 2 Jul 2021 13:49:59 -0400 Subject: [PATCH 06/10] Update website/README.md Co-authored-by: Tu Nguyen --- website/README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/website/README.md b/website/README.md index f40809464a..f9abbe4356 100644 --- a/website/README.md +++ b/website/README.md @@ -15,13 +15,13 @@ You should preview all of your changes locally before creating a pull request. T **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. Open terminal and set GOPATH as an environment variable: +1. Create a `~/go` directory manually or by [installing Go](https://golang.org/doc/install). +1. 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. +1. Restart your terminal or command line session. **Launch Site Locally** From b3736334f7828df3a306c05a39a30162341ae00e Mon Sep 17 00:00:00 2001 From: Laura Pacilio <83350965+laurapacilio@users.noreply.github.com> Date: Fri, 2 Jul 2021 13:50:09 -0400 Subject: [PATCH 07/10] Update website/README.md Co-authored-by: Tu Nguyen --- website/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/website/README.md b/website/README.md index f9abbe4356..263fbf2c8b 100644 --- a/website/README.md +++ b/website/README.md @@ -27,4 +27,4 @@ You should preview all of your changes locally before creating a pull request. T 1. Navigate into your local `terraform` top-level directory and run `make website`. 3. Open `http://localhost:4567` in your web browser. While the preview is running, you can edit pages and Middleman will automatically rebuild them. -4. When you're done with the preview, press ctrl-C in your terminal to stop the server. +4. When you're done with the preview, press `ctrl-C` in your terminal to stop the server. From d3b9d5cddaf7c3216e7eb9c2163f6a3d397122c1 Mon Sep 17 00:00:00 2001 From: Laura Pacilio <83350965+laurapacilio@users.noreply.github.com> Date: Fri, 2 Jul 2021 13:51:00 -0400 Subject: [PATCH 08/10] Update website/README.md Co-authored-by: Tu Nguyen --- website/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/website/README.md b/website/README.md index 263fbf2c8b..45df244a7d 100644 --- a/website/README.md +++ b/website/README.md @@ -10,7 +10,7 @@ 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. +You should preview all of your changes locally before creating a pull request. The build includes content from this repository and the [`terraform-website`](https://github.com/hashicorp/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** From 13d690081c47e057f04e5fab70df111dfb1e5839 Mon Sep 17 00:00:00 2001 From: Laura Pacilio <83350965+laurapacilio@users.noreply.github.com> Date: Fri, 2 Jul 2021 13:52:15 -0400 Subject: [PATCH 09/10] Fix numbering in first section --- website/README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/website/README.md b/website/README.md index 45df244a7d..d6c63bd9e7 100644 --- a/website/README.md +++ b/website/README.md @@ -15,13 +15,13 @@ You should preview all of your changes locally before creating a pull request. T **Set Up Local Environment** 1. [Install Docker](https://docs.docker.com/get-docker/). -1. Create a `~/go` directory manually or by [installing Go](https://golang.org/doc/install). -1. Open terminal and set `GOPATH` as an environment variable: +2. Create a `~/go` directory manually or by [installing Go](https://golang.org/doc/install). +3. Open terminal and set `GOPATH` as an environment variable: Bash: `export $GOPATH=~/go`(bash) Zsh: `echo -n 'export GOPATH=~/go' >> ~/.zshrc` -1. Restart your terminal or command line session. +4. Restart your terminal or command line session. **Launch Site Locally** From a8600ca2e4e8f925577a993b61bdcb9bae94da1d Mon Sep 17 00:00:00 2001 From: Laura Pacilio <83350965+laurapacilio@users.noreply.github.com> Date: Fri, 2 Jul 2021 14:02:03 -0400 Subject: [PATCH 10/10] Fix numbering for second step --- website/README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/website/README.md b/website/README.md index d6c63bd9e7..0fb9be1020 100644 --- a/website/README.md +++ b/website/README.md @@ -26,5 +26,5 @@ You should preview all of your changes locally before creating a pull request. T **Launch Site Locally** 1. Navigate into your local `terraform` top-level directory and run `make website`. -3. Open `http://localhost:4567` in your web browser. While the preview is running, you can edit pages and Middleman will automatically rebuild them. -4. When you're done with the preview, press `ctrl-C` in your terminal to stop the server. +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.