Skip to content

When citing UI text, match the style there even if it breaks a rule, but then propose a change to the UI text

Mike Lewis requested to merge docs-style-match-bad-ui-text into master

What does this MR do?

Clarifies the guidance to match UI text capitalization/wording verbatim in docs with a mention to also raise an issue/MR if you think the UI text is styled improperly.

Per a suggestion from @axil on Slack.

Anyone can merge once we have 2 style committee approvers out of @mjang1 @sselhorn @marcia

Related issues

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.

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 Mike Lewis

Merge request reports