Describe authoritative external links
What does this MR do?
Problem: GitLab docs frequently include links to blog posts, articles, and even wikis. In most cases, such links are not authoritative.
Solution: In our documentation style guide, set out criteria for external links.
When describing interfaces to external software, it's often helpful to include links to external documentation. When possible, include a link to an authoritative source. For example, if you're describing a feature in Microsoft's Active Directory, include a link to official Microsoft documentation.
Related issues
Author's checklist
-
Follow the Documentation Guidelines and Style Guide. -
If applicable, update the permissions table. -
Link docs to and from the higher-level index page, plus other related docs where helpful. -
Apply the documentation label.
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
-
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.
Edited by Mike Jang