Skip to content

Remove square brackets and fix orphaned links

Marcel Amirault requested to merge docs-kramdown-fix-2 into master

What does this MR do?

Fix links that got orphaned when the link references were moved to another doc, which were flagged as kramdown warnings. Also adjusts the new doc to not use link references, as this is no longer the standard. Finally, fixes a few more kramdown warnings due to square bracket use.

The links were broken in !16083 (merged) when the link references were moved to a new doc accidentally. This MR puts the links back (in-line), and also brings back a note that got pulled over by accident as well.

Related issues

#212770 (closed)

Author's checklist

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 Bot 🤖

Merge request reports