Adding PR so that CI will pass

Adding PR #191 in a seperate commit which can be squashed or removed.
terraform-google-modules · Jun 25, 2019 · 13bf6dd · 13bf6dd
1 parent ad65b49
commit 13bf6dd
Show file tree

Hide file tree

Showing 5 changed files with 15 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -233,6 +233,9 @@ To more cleanly handle cases where desired functionality would require complex d
 
 The root module is generated by running `make generate`. Changes to this repository should be made in the [`autogen`](/autogen) directory where appropriate.
 
+Note: The correct sequence to update the repo using autogen functionality is the run `make generate && make generate_docs`.  This
+will create the various Terraform files, and then generate the Terraform documentation using `terraform-docs`.
+
 ## Testing
 
 ### Requirements

diff --git a/autogen/README.md b/autogen/README.md
@@ -182,6 +182,9 @@ To more cleanly handle cases where desired functionality would require complex d
 
 The root module is generated by running `make generate`. Changes to this repository should be made in the [`autogen`](/autogen) directory where appropriate.
 
+Note: The correct sequence to update the repo using autogen functionality is the run `make generate && make generate_docs`.  This
+will create the various Terraform files, and then generate the Terraform documentation using `terraform-docs`.
+
 ## Testing
 
 ### Requirements

diff --git a/modules/beta-private-cluster/README.md b/modules/beta-private-cluster/README.md
@@ -252,6 +252,9 @@ To more cleanly handle cases where desired functionality would require complex d
 
 The root module is generated by running `make generate`. Changes to this repository should be made in the [`autogen`](/autogen) directory where appropriate.
 
+Note: The correct sequence to update the repo using autogen functionality is the run `make generate && make generate_docs`.  This
+will create the various Terraform files, and then generate the Terraform documentation using `terraform-docs`.
+
 ## Testing
 
 ### Requirements

diff --git a/modules/beta-public-cluster/README.md b/modules/beta-public-cluster/README.md
@@ -242,6 +242,9 @@ To more cleanly handle cases where desired functionality would require complex d
 
 The root module is generated by running `make generate`. Changes to this repository should be made in the [`autogen`](/autogen) directory where appropriate.
 
+Note: The correct sequence to update the repo using autogen functionality is the run `make generate && make generate_docs`.  This
+will create the various Terraform files, and then generate the Terraform documentation using `terraform-docs`.
+
 ## Testing
 
 ### Requirements

diff --git a/modules/private-cluster/README.md b/modules/private-cluster/README.md
@@ -243,6 +243,9 @@ To more cleanly handle cases where desired functionality would require complex d
 
 The root module is generated by running `make generate`. Changes to this repository should be made in the [`autogen`](/autogen) directory where appropriate.
 
+Note: The correct sequence to update the repo using autogen functionality is the run `make generate && make generate_docs`.  This
+will create the various Terraform files, and then generate the Terraform documentation using `terraform-docs`.
+
 ## Testing
 
 ### Requirements