docs: focus readme intro on plugin flexibility #1508
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
wcmjunior
approved these changes
Aug 15, 2025
There was a problem hiding this comment.
Thanks for making this a separate PR @danielfrankcom . :-)
Some nits considering the whole README and not necessarily the changes you made:
- In
arn:aws:secretsmanager:<Region>:<AccountId>:secret:SecretName-6RandomCharacters, I suggest changing toarn:<Partition>:secretsmanager:<Region>:<AccountId>:secret:SecretName-6RandomCharacters. - I suggest that the texts in the table cells are all aligned to the left to make it easier to read. It is quite hard to read lots of text when it is centralized. I think centralization works well with just a few characters or numbers, other than that it is quite hard to read.
sergiyvamz
reviewed
Aug 18, 2025
sergiyvamz
approved these changes
Aug 18, 2025
Those both look like good changes to me, but I'll leave them to future PRs given the limited scope of this one. |
hsuamz
approved these changes
Aug 19, 2025
hsuamz
changed the title
Frank-Gu-81
added a commit
to QuChen88/aws-advanced-jdbc-wrapper
that referenced
this pull request
Aug 25, 2025
Use telemetryMetricsBackend instead of telemetryTracesBackend in the RuntimeException when an invalid metrics backend is configured. chore(deps): bump software.amazon.awssdk:rds from 2.32.21 to 2.32.25 (aws#1509) Signed-off-by: dependabot[bot] <[email protected]> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> docs: focus readme intro on plugin flexibility (aws#1508) docs: clarifying blue/green compatibility with current service landscape (aws#1512)
Frank-Gu-81
added a commit
to QuChen88/aws-advanced-jdbc-wrapper
that referenced
this pull request
Aug 25, 2025
Use telemetryMetricsBackend instead of telemetryTracesBackend in the RuntimeException when an invalid metrics backend is configured. chore(deps): bump software.amazon.awssdk:rds from 2.32.21 to 2.32.25 (aws#1509) Signed-off-by: dependabot[bot] <[email protected]> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> docs: focus readme intro on plugin flexibility (aws#1508) docs: clarifying blue/green compatibility with current service landscape (aws#1512)
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.
Summary
This PR updates the project
README.mdfile, based on the changes in #1478. These changes restructure the introductory mentions of failover. The revised introduction focuses on the universal benefits of using the wrapper library.Description
After discussion of potential DSQL auth integration, it became clear that the existing
README.mdintroduction focuses on failover, and plugins which are relevant to only specific database services. In #1478 we restructured the project introduction to describe the universal benefits of the wrapper, and focus on the modularity of the plugins offered by the project. This avoids a major focus on failover, which implies the failover functionality is universally applicable.I have extracted the non-DSQL
README.mdchanges from #1478 in an effort to simplify the linked PR, and separate this change which is still applicable without DSQL.The PR also includes a few whitespace fixes and a table alignment issue, both of which were performed by my IDE automatically.
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.