Update READMEs to help folks figure out how to successfully make docs changes

README.md

@@ -1,5 +1,4 @@
-Terraform
-=========
+# Terraform
 
 - Website: https://www.terraform.io
 - Forums: [HashiCorp Discuss](https://discuss.hashicorp.com/c/terraform-core)
@@ -15,7 +14,7 @@ The key features of Terraform are:
 
 - **Infrastructure as Code**: Infrastructure is described using a high-level configuration syntax. This allows a blueprint of your datacenter to be versioned and treated as you would any other code. Additionally, infrastructure can be shared and re-used.
 
-- **Execution Plans**: Terraform has a "planning" step where it generates an *execution plan*. The execution plan shows what Terraform will do when you call apply. This lets you avoid any surprises when Terraform manipulates infrastructure.
+- **Execution Plans**: Terraform has a "planning" step where it generates an _execution plan_. The execution plan shows what Terraform will do when you call apply. This lets you avoid any surprises when Terraform manipulates infrastructure.
 
 - **Resource Graph**: Terraform builds a graph of all your resources, and parallelizes the creation and modification of any non-dependent resources. Because of this, Terraform builds infrastructure as efficiently as possible, and operators get insight into dependencies in their infrastructure.
 
@@ -23,24 +22,27 @@ The key features of Terraform are:
 
 For more information, see the [introduction section](https://www.terraform.io/intro) of the Terraform website.
 
-Getting Started & Documentation
--------------------------------
+## Getting Started & Documentation
+
 Documentation is available on the [Terraform website](https://www.terraform.io):
-  - [Intro](https://www.terraform.io/intro/index.html)
-  - [Docs](https://www.terraform.io/docs/index.html)
+
+- [Intro](https://www.terraform.io/intro/index.html)
+- [Docs](https://www.terraform.io/docs/index.html)
 
 If you're new to Terraform and want to get started creating infrastructure, please check out our [Getting Started guides](https://learn.hashicorp.com/terraform#getting-started) on HashiCorp's learning platform. There are also [additional guides](https://learn.hashicorp.com/terraform#operations-and-development) to continue your learning.
 
 Show off your Terraform knowledge by passing a certification exam. Visit the [certification page](https://www.hashicorp.com/certification/) for information about exams and find [study materials](https://learn.hashicorp.com/terraform/certification/terraform-associate) on HashiCorp's learning platform.
 
-Developing Terraform
---------------------
+## Developing Terraform
 
 This repository contains only Terraform core, which includes the command line interface and the main graph engine. Providers are implemented as plugins, and Terraform can automatically download providers that are published on [the Terraform Registry](https://registry.terraform.io). HashiCorp develops some providers, and others are developed by other organizations. For more information, see [Extending Terraform](https://www.terraform.io/docs/extend/index.html).
 
-To learn more about compiling Terraform and contributing suggested changes, please refer to [the contributing guide](.github/CONTRIBUTING.md).
+- To learn more about compiling Terraform and contributing suggested changes, please refer to [the contributing guide](.github/CONTRIBUTING.md).
 
-To learn more about how we handle bug reports, please read the [bug triage guide](./BUGPROCESS.md).
+- To learn more about how we handle bug reports, please read the [bug triage guide](./BUGPROCESS.md).
+
+- To learn how to contribute to the Terraform core documentation, please read the [Terraform Documentation README](/website/README.md).
 
 ## License
+
 [Mozilla Public License v2.0](https://github.com/hashicorp/terraform/blob/main/LICENSE)

website/README.md

@@ -8,6 +8,12 @@ The files in this directory are intended to be used in conjunction with
 different documentation sources together and contains the scripts for testing and building the site as
 a whole.
 
+## Suggesting Changes
+
+You can [submit an issue](https://github.com/hashicorp/terraform/issues/new/choose) with documentation requests or submit a pull request with suggested changes.
+
+Click **Edit this page** at the bottom of any Terraform website page to go directly to the associated markdown file in GitHub.
+
 ## 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`](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.
@@ -18,9 +24,10 @@ 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. Open terminal and 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**
@@ -34,13 +41,16 @@ You should preview all of your changes locally before creating a pull request. T
 Merge the PR to main. The changes will appear in the next major Terraform release.
 
 If you need your changes to be deployed sooner, cherry-pick them to:
+
 - the current release branch (e.g. `v1.0`) and push. They will be deployed in the next minor version release (once every two weeks).
-- the `stable-website` branch and push. They will be included in the next site deploy (see below). Note that the release process resets `stable-website` to match the release tag, removing any additional commits. So, we recommend always cherry-picking to the version branch first and then to `stable-website` when needed.
+- the `stable-website` branch and push. They will be included in the next site deploy (details below). Note that the release process resets `stable-website` to match the release tag, removing any additional commits. So, we recommend always cherry-picking to the version branch first and then to `stable-website` when needed.
 
 ### Deployment
+
 Currently, HashiCorp uses a CircleCI job to deploy the [terraform.io](terraform.io) site. This job can be run manually by many people within HashiCorp, and also runs automatically whenever a user in the HashiCorp GitHub org merges changes to master in the `terraform-website` repository.
 
-New commits in this repository don't automatically deploy the [terraform.io][] site, but an unrelated site deploy will usually happen within a day. If you can't wait that long, you can do a manual CircleCI build or ask someone in the #proj-terraform-docs channel to do so:
-- Log in to circleci.com, and  make sure you're viewing the HashiCorp organization.
+New commits in this repository don't automatically deploy the [terraform.io](https://www.terraform.io/docs/index.html) site, but an unrelated site deploy will usually happen within a day. If you can't wait that long, you can do a manual CircleCI build or ask someone in the #proj-terraform-docs channel to do so:
+
+- Log in to circleci.com, and make sure you're viewing the HashiCorp organization.
 - Go to the terraform-website project's list of workflows.
 - Find the most recent "website-deploy" workflow, and click the "Rerun workflow from start" button (which looks like a refresh button with a numeral "1" inside).