Skip to content

Remove redundant `**Note:**` from docs

Achilleas Pipinellis requested to merge remove-double-notes-notation into master

What does this MR do?

The notation we use to represent a note is:

NOTE: **Note:**
This is a note

This is rendered by Nanoc and presented in an alert box in the docs site. The second **Note:** can be redundant, so let's remove it.

See the docs MR how that would look gitlab-docs!1206 (merged).

Command used:

for i in `grep -r "NOTE: \*\*Note:\*\*" doc | uniq | cut -d':' -f1`; do sed -i 's/NOTE: \*\*Note:\*\*/NOTE:/' $i; done

Related to gitlab-docs!1206 (merged)

Also related to #290314 (closed)

Closes #291022 (closed)

Accessibility concerns

Since we're removing the text that denotes what the alert is actually about, we should cover the accessibility side of things. gitlab-docs!1206 (merged) adds a title and aria-label tags to help with that.

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 Suzanne Selhorn

Merge request reports