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.

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

Improve documentation for GitHub modules #334

Merged
merged 3 commits into from
May 24, 2022
Merged

Improve documentation for GitHub modules #334

merged 3 commits into from
May 24, 2022

Conversation

tpdownes
Copy link
Member

  • link to Terraform documentation of double-slash subdirectory notation
  • link to Terraform and git documentation for selecting a reference
  • ensure README includes examples of each feature above

Submission Checklist

  • Have you installed and run this change against pre-commit? (pre-commit install)
  • Are all tests passing? (make tests)
  • Have you written unit tests to cover this change?
  • Is unit test coverage still above 80%?
  • Have you updated all applicable documentation?
  • Have you followed the guidelines in our Contributing document?

- link to Terraform documentation of double-slash subdirectory notation
- link to Terraform and git documentation for selecting a reference
- ensure README includes examples of each feature above
modules/README.md Show resolved Hide resolved
modules/README.md Show resolved Hide resolved
@nick-stroud nick-stroud assigned tpdownes and unassigned nick-stroud May 23, 2022
- link to DAOS example which used a GitHub module
- add section on use of remote modules generally
@tpdownes tpdownes assigned nick-stroud and unassigned tpdownes May 23, 2022
nick-stroud
nick-stroud previously approved these changes May 23, 2022
modules/README.md Outdated Show resolved Hide resolved
modules/README.md Outdated Show resolved Hide resolved
@nick-stroud nick-stroud assigned tpdownes and unassigned nick-stroud May 23, 2022
@nick-stroud nick-stroud assigned tpdownes and unassigned nick-stroud May 24, 2022
@tpdownes tpdownes merged commit 98ff649 into GoogleCloudPlatform:develop May 24, 2022
@tpdownes tpdownes deleted the doc_github_source_features branch May 31, 2022 21:46
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants