Private Link to AWS PrivateLink Rule

This rule ensures consistent terminology by enforcing the use of the official AWS service name "AWS PrivateLink" instead of the generic term "private link".

Maintaining consistent product and service naming is crucial for technical documentation, especially when referring to specific cloud services. Using the official AWS service name helps avoid confusion and maintains professional standards in documentation. It also helps with SEO and ensures alignment with AWS's official documentation and branding guidelines.

Examples:

✗ Incorrect:

  • "You can set up a private link connection..."
  • "The system uses private link for secure communication..."

✓ Correct:

  • "You can set up an AWS PrivateLink connection..."
  • "The system uses AWS PrivateLink for secure communication..."

The rule will flag any instance of "private link" (case-insensitive) and suggest replacing it with "AWS PrivateLink".

Rule Source

This rule comes from: https://github.com/bllchmbrs/docelot-test

Rule Definition

extends: substitution
ignorecase: true
level: warning
message: Consider replacing '%s' with '%s'
swap:
  private link: AWS PrivateLink