Skip to content

Add vale rule for "admin" abbreviation

Marcel Amirault requested to merge docs-admin-area-vale into master

What does this MR do?

We needed a better way to find incorrect usage of admin, while allowing Admin Area, and hopefully this rule covers it.

Currently there are 387 instances of incorrect usage, so this is at the warning level. I feel like we could actually have it at the error level someday, if we:

  • Prove this to be solid with no edge cases
  • Clean up all 387 failures.

Related issues

Resolves #258956 (closed)

Author's checklist (required)

Do not add the feature, frontend, backend, ~"bug", or database labels if you are only updating documentation. These labels will cause the MR to be added to code verification QA issues.

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

  • 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.

For more information about labels, see Technical Writing workflows - Labels.

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.
Edited by Marcel Amirault

Merge request reports