[docs] RDS readme #15
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
dstrelau
approved these changes
Nov 16, 2022
Comment on lines
+54
to
+55
| Examples of use of this module can be found | ||
| in [`examples/`](https://github.com/honeycombio/terraform-aws-integrations/tree/main/examples). |
There was a problem hiding this comment.
This is not true. I wonder if we want to 1) provide an example or 2) change (all these modules?) to point people towards the tests instead?
There was a problem hiding this comment.
Good point, I think I anticipated #1 happening. The examples directory seems to be a common Terraform convention so it's probably worth including examples there. I should have time to do this late this week/early next week. Will create an Asana ticket to capture the work 👍
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Which problem is this PR solving?
Fills in a documentation gap for RDS
Short description of the changes
Adds documentation to the RDS submodule README.md matching the style of the other submodules in the repo