Skip to content

Docs: create rule for the word 'currently'

Amy Qualls requested to merge 219447-docs-aqualls-ephemeral into master

What does this MR do?

The Documentation Style Guide includes the following rule in the language to avoid section:

Avoid using the word currently when talking about the product or its features. The documentation describes the product as it is, and not as it will be at some indeterminate point in the future.

We do not have a Vale rule in place to help writers be able to avoid its use.

Related issues

Closes #219447 (closed)

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

Loading