Merge pull request #190 from chrislovecnm/readme-updates

Updated documentation with development notes
terraform-google-modules · Jun 25, 2019 · f34320d · f34320d
2 parents 348549a + 428b0f8
commit f34320d
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 0 deletions.
diff --git a/Makefile b/Makefile
@@ -96,6 +96,10 @@ generate_docs:
 generate:
 	@source test/make.sh && generate
 
+.PHONY: dev
+dev: generate generate_docs
+	@echo "Updated files"
+
 # Versioning
 .PHONY: version
 version:

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