Remove redundant **Note:** from docs
What does this MR do?
The notation we use to represent a note is:
NOTE: **Note:**
This is a noteThis 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; doneRelated 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)
- Follow the Documentation Guidelines and Style Guide.
- If you have Developer permissions or higher:
- Ensure that the product tier badge is added to doc's
h1. - Apply the documentation label, plus:
- The corresponding DevOps stage and group labels, if applicable.
- development guidelines when changing docs under
doc/development/*,CONTRIBUTING.md, orREADME.md. - development guidelines and Documentation guidelines when changing docs under
development/documentation/*. - development guidelines and Description templates (.gitlab/*) when creating/updating issue and MR description templates.
- Assign the designated Technical Writer.
- Ensure that the product tier badge is added to doc's
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:
- Update the permissions table.
- Link docs to and from the higher-level index page, plus other related docs where helpful.
- Add the product tier badge accordingly.
- Add GitLab's version history note(s).
- Add/update the feature flag section.
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.
- Ensure docs metadata are present and up-to-date.
- Ensure Technical Writing and documentation are added.
- Add the corresponding
docs::scoped label. - If working on UI text, add the corresponding
UI Textscoped label. - Add twdoing when starting work on the MR.
- Add twfinished if Technical Writing team work on the MR is complete but it remains open.
For more information about labels, see Technical Writing workflows - Labels.
3. Maintainer
- Review by assigned maintainer, who can always request/require the above reviews. Maintainer's review can occur before or after a technical writer review.
- Ensure a release milestone is set.
- If there has not been a technical writer review, create an issue for one using the Doc Review template.