Skip to content

Include a list of different doc link methods

Mike Jang requested to merge mjang-doc-update-link-style into master

What does this MR do?

Include a list of the different criteria we use to set up links in our docs.

Related issues

Based on !27188 (comment 304726620) , when I realized how difficult it is to decipher all the criteria we use to set up links.

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.

cc @gl-docsteam

Edited by 🤖 GitLab Bot 🤖

Merge request reports