Skip to content

Loosen vale admin rule to allow new menu option

Marcel Amirault requested to merge update-admin-vale-rule into master

What does this MR do?

Loosens the vale rule that checks for admin, when we should use the full name. The changes in #333265 (closed) mean we now have a lot more mentions of Admin that are actually valid.

This changes the rule to care about capitalization, so it's looking for admin or Admin. When found, it compares to the valid strings, so Admin would pass, but admin would not. It will fail to find instances of Admin used incorrectly, like "You must have the Admin role", but that's the only solution I found so far. It's better to have loose rules without false positives, than to have a bunch of false positives we can't fix.

  • Before change: 326 results, including a mix of both valid ones and false positives.
  • After change: 176 results, which should all be valid.

Related issues

#333265 (comment 598761900)

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.

For suggestions that you are confident don't need to be reviewed, change them locally and push a commit directly to save others from unneeded reviews. For example:

  • Clear typos, like this is a typpo.
  • Minor issues, like single quotes instead of double quotes, Oxford commas, and periods.

For more information, see our documentation on Merging a merge request.

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

Loading