Skip to content

Adding guide update to avoid profanity

Craig Norris requested to merge docs-avoid-profanity into master

What does this MR do?

In the Language to Avoid section of the Style Guide, this MR adds the guide directive to avoid the use of profanity in the product documentation. It's more of a "don't do this thing you should already know to not do" thing, but it's worth stating if we're to have a complete sense of coverage for the guide, and it could enable automation for the directive.

Related issues

Author's checklist (required)

When applicable:

Review checklist

All reviewers can help ensure accuracy, clarity, completeness, and adherence to the Documentation Guidelines and Style Guide.

1. Primary Reviewer

  • Review by a code reviewer or other selected colleague to confirm accuracy, clarity, and completeness. This can be skipped for minor fixes without substantive content changes.

2. Technical Writer

  • Optional: Technical writer review. If not requested for this MR, must be scheduled post-merge. To request for this MR, assign the writer listed for the applicable DevOps stage.

3. Maintainer

  1. Review by assigned maintainer, who can always request/require the above reviews. Maintainer's review can occur before or after a technical writer review.
  2. Ensure a release milestone is set.
  3. If there has not been a technical writer review, create an issue for one using the Doc Review template.

Merge request reports