Skip to content

Conversation

@janine-c
Copy link
Contributor

What does this PR do?

In this PR, I've deleted the list of rejected AWS brand names from the existing vocabulary, and replaced it with a list of substitutions instead. That way, when someone writes something like AWS ECR, they get an immediate suggestion to replace it with Amazon ECR, so they don't have to spend time looking up what the preferred term is.

If you're reviewing this, please let me know if you see anything about this approach that can be improved!

Motivation

The approach I've chosen seems to provide the most functionality:

  • As described above, Vale now tells you if you've used Amazon/AWS instead of AWS/Amazon, while also immediately suggesting the correct term. The new substitution file is case-insensitive, which means it should identify that instances of, for example, both AWS Workspaces and AWS WorkSpaces need to be corrected to Amazon WorkSpaces.
  • Keeping the accept.txt file allows us to retain detections in case someone uses the right term but with incorrect capitalization (for example, Amazon Cloudfront will get properly corrected to Amazon CloudFront).

Release

  • YES, this PR requires a release
  • NO, this PR doesn't need a release

Additional Notes


Release checklist

  • Create zip files for EACH style folder.
  • Attach the zip files when creating a release.

@janine-c janine-c requested a review from a team as a code owner July 15, 2025 20:36
@janine-c janine-c added the editorial review Waiting on a more in-depth review label Jul 15, 2025
@janine-c janine-c merged commit 8b64fcb into main Jul 16, 2025
2 checks passed
@janine-c janine-c deleted the janine.chan/aws-substitution-list branch July 16, 2025 21:23
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

editorial review Waiting on a more in-depth review

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants