docs: update README for artifact coordinates, correct configuration properties, tighten style #175
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
…roperties, tighten style
The README referenced the old Maven coordinate for the AWS KMS. Update to the new coordinate and add
some additional best practices in Maven such as the use of versions in `properties`. In code fences,
add a syntax hint.
Unify the use of YAML mappings over "property" style keys, c.f., spring.cloud.aws. Where keys used
camelCase, correct and use kebab-case for Spring recognition. Apply inline code style where needed,
e.g., `{cipher}`. Use common YAML file extension, c.f., "yml" vs. "yaml".
Signed-off-by: Timothy Stone <[email protected]>
timothystone-knsl
force-pushed
the
docs/fix-artifact-coordinate
branch
from
ec65728 to
29cf46a
Compare
|
|
||
| e.g. `application.yml` | ||
| If all cipher values of your application have been encrypted with the same KMS key and algorithm, you can configure | ||
| the `keyId` and `encryptionAlgorithm` globally in the `bootstrap.yml` as shown above. In case you have to decrypt |
There was a problem hiding this comment.
The use of keyId and encryptionAlgorithm here were left as I was not certain how the "extra options" might be defined in the YAML, i.e., should the form be kebab-case or camelCase?
danielrohe
approved these changes
Jun 7, 2024
|
👍 |
1 similar comment
|
👍 |
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.
The README referenced the old Maven coordinate for the AWS KMS. Update to the new coordinate and add some additional best practices in Maven such as the use of versions in
properties. In code fences, add a syntax hint.Unify the use of YAML mappings over "property" style keys, c.f., spring.cloud.aws. Where keys used camelCase, correct and use kebab-case for Spring recognition. Apply inline code style where needed, e.g.,
{cipher}. Use a single form of the YAML file extension, c.f., "yml" vs. "yaml".Fixes #177