docs(datasource/aws-rds): improve readme #29870
Open
Conversation
This file contains 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
HonkingGoose
commented
Jun 26, 2024
| } | ||
| ``` | ||
|
|
||
| The above configuration will ...insert explanation of bits below... |
There was a problem hiding this comment.
Need a maintainer suggestion for this line too. 😉
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.
Changes
aws-rdsdatasource readme:Context
A user showed their config for "terraform + rds datasource + aurora-mysql", that should probably go in the docs.
They also said that the docs don't warn that by default the aws-rds datasource does not work with Amazon Aurora. So I'm warning about that in the docs too now.
Drive-by PR, not closing any issue with this, but it does resolve a bit of the discussion:
Documentation (please check one with an [x])
How I've tested my work (please select one)
I have verified these changes via: