Merge pull request #1862 from gruntwork-io/james/oss-3982-control-release-of-docs-updates-prior-to-v2

docs: point examples and links at v1.0.1 instead of main

Author: yhakbar

docs/_config.yml

@@ -29,11 +29,15 @@ description: >- # this means to ignore newlines until "baseurl:"
 baseurl: "" # the subpath of your site, e.g. /blog
 full_company_name: "Gruntwork, Inc"
 thumbnail_path: "/assets/img/terratest-thumbnail.png"
+# The Git ref (tag) that documentation examples and "View on GitHub" links point at.
+# Keep this on the latest GA release so users copy stable, released code rather than
+# whatever is currently on `main`. Update this and github_api_url below on each GA release.
+stable_ref: v1.0.1
 repository: "github.com/gruntwork-io/terratest"
 twitter_username: https://twitter.com/gruntwork_io
 github_username:  https://github.com/gruntwork-io
 
-github_api_url: https://raw.githubusercontent.com/gruntwork-io/terratest/main
+github_api_url: https://raw.githubusercontent.com/gruntwork-io/terratest/v1.0.1
 
 # Build settings
 # theme: minima

docs/_data/examples.yml

@@ -9,7 +9,7 @@
       default: true
   learn_more:
     - name: Terraform Hello, World
-      url: https://github.com/gruntwork-io/terratest/tree/main/examples/terraform-hello-world-example
+      url: https://github.com/gruntwork-io/terratest/tree/v1.0.1/examples/terraform-hello-world-example
 
 - id: packer-hello-world
   name: Packer Hello, World Example
@@ -22,7 +22,7 @@
       default: true
   learn_more:
     - name: Packer Hello, World
-      url: https://github.com/gruntwork-io/terratest/tree/main/examples/packer-hello-world-example
+      url: https://github.com/gruntwork-io/terratest/tree/v1.0.1/examples/packer-hello-world-example
 
 - id: docker-hello-world
   name: Docker Hello, World Example
@@ -36,7 +36,7 @@
       default: true
   learn_more:
     - name: Docker Hello, World
-      url: https://github.com/gruntwork-io/terratest/tree/main/examples/docker-hello-world-example
+      url: https://github.com/gruntwork-io/terratest/tree/v1.0.1/examples/docker-hello-world-example
 
 - id: kubernetes-hello-world
   name: Kubernetes Hello, World Example
@@ -49,7 +49,7 @@
       default: true
   learn_more:
     - name: Kubernetes Hello, World
-      url: https://github.com/gruntwork-io/terratest/tree/main/examples/kubernetes-hello-world-example
+      url: https://github.com/gruntwork-io/terratest/tree/v1.0.1/examples/kubernetes-hello-world-example
 
 - id: terragrunt-hello-world
   name: Terragrunt Example
@@ -64,9 +64,9 @@
       default: true
   learn_more:
     - name: Terragrunt Unit
-      url: https://github.com/gruntwork-io/terratest/tree/main/examples/terragrunt-example
+      url: https://github.com/gruntwork-io/terratest/tree/v1.0.1/examples/terragrunt-example
     - name: Terragrunt Stack
-      url: https://github.com/gruntwork-io/terratest/tree/main/examples/terragrunt-multi-module-example
+      url: https://github.com/gruntwork-io/terratest/tree/v1.0.1/examples/terragrunt-multi-module-example
 
 - id: aws-hello-world
   name: AWS Hello, World Example
@@ -79,7 +79,7 @@
       default: true
   learn_more:
     - name: AWS Hello, World
-      url: https://github.com/gruntwork-io/terratest/tree/main/examples/terraform-aws-hello-world-example
+      url: https://github.com/gruntwork-io/terratest/tree/v1.0.1/examples/terraform-aws-hello-world-example
 
 - id: gcp-hello-world
   name: GCP Hello, World Example
@@ -92,7 +92,7 @@
       default: true
   learn_more:
     - name: GCP Hello, World
-      url: https://github.com/gruntwork-io/terratest/tree/main/examples/terraform-gcp-hello-world-example
+      url: https://github.com/gruntwork-io/terratest/tree/v1.0.1/examples/terraform-gcp-hello-world-example
 
 - id: azure-basic
   name: Azure Hello, World Example
@@ -109,7 +109,7 @@
       default: true
   learn_more:
     - name: Terraform Azure Example
-      url: https://github.com/gruntwork-io/terratest/tree/main/examples/azure/terraform-azure-example
+      url: https://github.com/gruntwork-io/terratest/tree/v1.0.1/examples/azure/terraform-azure-example
 
 - id: opa-terraform
   name: OPA Terraform Example
@@ -126,7 +126,7 @@
       default: true
   learn_more:
     - name: Terraform OPA Example
-      url: https://github.com/gruntwork-io/terratest/tree/main/examples/terraform-opa-example
+      url: https://github.com/gruntwork-io/terratest/tree/v1.0.1/examples/terraform-opa-example
 
 - id: client-factory
   name: Azure Client Factory

docs/_docs/01_getting-started/packages-overview.md

@@ -11,7 +11,7 @@ nav_title_link: /docs/
 ---
 
 Now that you've had a chance to browse the examples and their tests, here's an overview of the packages you'll find in
-Terratest's [modules folder](https://github.com/gruntwork-io/terratest/tree/main/modules) and how they can help you test different types infrastructure:
+Terratest's [modules folder](https://github.com/gruntwork-io/terratest/tree/{{ site.stable_ref }}/modules) and how they can help you test different types infrastructure:
 
 {:.doc-styled-table}
 | Package            | Description                                                                                                                                                                                                                                                                                          |
@@ -25,7 +25,7 @@ Terratest's [modules folder](https://github.com/gruntwork-io/terratest/tree/main
 | **httphelper**    | Functions for making HTTP requests. Examples: make an HTTP request to a URL and check the status code and body contain the expected values, run a simple HTTP server locally.                                                                                                                        |
 | **k8s**            | Functions that make it easier to work with Kubernetes. Examples: Getting the list of nodes in a cluster, waiting until all nodes in a cluster is ready.                                                                                                                                              |
 | **logger**         | A replacement for Go's `t.Log` and `t.Logf` that writes the logs to `stdout` immediately, rather than buffering them until the very end of the test. This makes debugging and iterating easier.                                                                                                      |
-| **logger/parser**  | Includes functions for parsing out interleaved go test output and piecing out the individual test logs. Used by the [terratest_log_parser](https://github.com/gruntwork-io/terratest/tree/main/cmd/terratest_log_parser) command.                                                                                                                       |
+| **logger/parser**  | Includes functions for parsing out interleaved go test output and piecing out the individual test logs. Used by the [terratest_log_parser](https://github.com/gruntwork-io/terratest/tree/{{ site.stable_ref }}/cmd/terratest_log_parser) command.                                                                                                                       |
 | **packer**         | Functions for working with Packer. Examples: run a Packer build and return the ID of the artifact that was created.                                                                                                                                                                                  |
 | **random**         | Functions for generating random data. Examples: generate a unique ID that can be used to namespace resources so multiple tests running in parallel don't clash.                                                                                                                                      |
 | **retry**          | Functions for retrying actions. Examples: retry a function up to a maximum number of retries, retry a function until a stop function is called, wait up to a certain timeout for a function to complete. These are especially useful when working with distributed systems and eventual consistency. |

docs/_docs/01_getting-started/quick-start.md

@@ -26,9 +26,9 @@ types of infrastructure code you can test (e.g., Packer, Kubernetes, etc).
 
 1. Create an `examples` and `test` folder.
 
-1. Copy the folder including all the files from the [basic terraform example](https://github.com/gruntwork-io/terratest/tree/main/examples/terraform-basic-example/) into the `examples` folder.
+1. Copy the folder including all the files from the [basic terraform example](https://github.com/gruntwork-io/terratest/tree/{{ site.stable_ref }}/examples/terraform-basic-example/) into the `examples` folder.
 
-1. Copy the [basic terraform example test](https://github.com/gruntwork-io/terratest/blob/main/test/terraform_basic_example_test.go) into the `test` folder.
+1. Copy the [basic terraform example test](https://github.com/gruntwork-io/terratest/blob/{{ site.stable_ref }}/test/terraform_basic_example_test.go) into the `test` folder.
 
 1. To configure dependencies, run:
 

docs/_docs/01_getting-started/testing-terragrunt.md

@@ -94,5 +94,5 @@ For Terragrunt [stacks](https://terragrunt.gruntwork.io/docs/features/stacks/):
 ## Further Reading
 
 - [Terragrunt Documentation](https://terragrunt.gruntwork.io/)
-- [Stack example](https://github.com/gruntwork-io/terratest/tree/main/examples/terragrunt-multi-module-example)
+- [Stack example](https://github.com/gruntwork-io/terratest/tree/{{ site.stable_ref }}/examples/terragrunt-multi-module-example)
 - [terragrunt package reference](https://pkg.go.dev/github.com/gruntwork-io/terratest/modules/terragrunt)

docs/_docs/02_testing-best-practices/iterating-locally-using-docker.md

@@ -19,13 +19,13 @@ Here are some techniques we use with Docker:
 
 - If your script is used in a Packer template, add a [Docker
   builder](https://www.packer.io/docs/builders/docker.html) to the template so you can create a Docker image from the
-  same code. See the [Packer Docker Example](https://github.com/gruntwork-io/terratest/tree/main/examples/packer-docker-example) for working sample code.
+  same code. See the [Packer Docker Example](https://github.com/gruntwork-io/terratest/tree/{{ site.stable_ref }}/examples/packer-docker-example) for working sample code.
 
 - We have prebuilt Docker images for major Linux distros that have many important dependencies (e.g., curl, vim,
-  tar, sudo) already installed. See the [test-docker-images folder](https://github.com/gruntwork-io/terratest/tree/main/test-docker-images) for more details.
+  tar, sudo) already installed. See the [test-docker-images folder](https://github.com/gruntwork-io/terratest/tree/{{ site.stable_ref }}/test-docker-images) for more details.
 
 - Create a `docker-compose.yml` to make it easier to run your Docker image with all the ports, environment variables,
-  and other settings it needs. See the [Packer Docker Example](https://github.com/gruntwork-io/terratest/tree/main/examples/packer-docker-example) for working sample code.
+  and other settings it needs. See the [Packer Docker Example](https://github.com/gruntwork-io/terratest/tree/{{ site.stable_ref }}/examples/packer-docker-example) for working sample code.
 
 - With scripts in Docker, you can replace _some_ real-world dependencies with mocks! One way to do this is to create
   some "mock scripts" and to bind-mount them in `docker-compose.yml` in a way that replaces the real dependency. For

docs/_docs/02_testing-best-practices/iterating-locally-using-test-stages.md

@@ -23,7 +23,7 @@ each time you change a single line of code can be very slow.
 
 This is where Terratest's `teststructure` package comes in handy: it allows you to explicitly break up your tests into
 stages and to be able to disable any one of those stages by setting an environment variable. Check out the
-[terraform_packer_example_test.go](https://github.com/gruntwork-io/terratest/blob/main/test/terraform_packer_example_test.go)
+[terraform_packer_example_test.go](https://github.com/gruntwork-io/terratest/blob/{{ site.stable_ref }}/test/terraform_packer_example_test.go)
 for working sample code.
 
 ## How to skip stages

docs/_includes/examples/example.html

@@ -58,7 +58,7 @@
         {% unless include.skip_view_on_github %}
           <div class="example__file-link">
             <p>View on GitHub:</p>
-            <a href="https://{{ site.repository }}/tree/main{{ file.url }}">{{ site.repository }}{{ file.url }}</a>
+            <a href="https://{{ site.repository }}/tree/{{ site.stable_ref }}{{ file.url }}">{{ site.repository }}{{ file.url }}</a>
           </div>
         {% endunless %}
       </div>

docs/_includes/examples/explorer.html

@@ -26,7 +26,7 @@
     {% if include.example_id == nil %}
       <div class="hidden-navs__static-links">
         <a
-          href="https://github.com/gruntwork-io/terratest/tree/main/examples"
+          href="https://github.com/gruntwork-io/terratest/tree/{{ site.stable_ref }}/examples"
           class="examples__nav-item static-link nav-{{ example.id }}"
           target="_blank"
           >