Skip to content

Added clear action to checkboxes in Style Guide

Craig Norris requested to merge docs-add-clear-action into master

What does this MR do?

The Style Guide is missing an approved word to describe removing a selection from a checkbox. I suggest that we use the word clear to describe this action.

As part of this, I recommend that we change the recommended check for enabling a checkbox to select, as it allows us to reduce the amount of recommended words (while still communicating meaning), and it looks repetitive to check the checkbox. (Plus, check is an overloaded word and has multiple meanings -- either select the option, or just examine it.)

Related issues

none

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.
Edited by GitLab Release Tools Bot

Merge request reports