Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Updated documentation with development notes #190

Merged
merged 3 commits into from
Jun 25, 2019
Merged

Updated documentation with development notes #190

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
65f2d4c
Updated documentation with development notes
Jun 25, 2019
5cc2963
Update README.md
chrislovecnm Jun 25, 2019
428b0f8
Update README.md
chrislovecnm Jun 25, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions Makefile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
3 changes: 3 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down