Skip to content

Changed format of alert boxes

Suzanne Selhorn requested to merge docs-update-alert-boxes into master

What does this MR do?

This MR updates all notes, tips, warnings, and cautions to be in the new format.

We are going to only use NOTE: and WARNING: from now on, with no additional text. See the style guide guidance here: https://docs.gitlab.com/ee/development/documentation/styleguide/index.html#alert-boxes

Related issues

Related to: &5020 (closed)

Related to: gitlab#291024 (closed)

Related to: gitlab#291023 (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

  • 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 Tomasz Maczukin

Merge request reports