Improve technical writing link in the Documentation MR template
What does this MR do and why?
This MR updates the “Documentation” MR template to point to the publicly-accessible technical writing course rather than the edcast technical writing course.
The technical writing course is excellent, but users interacting with this MR for the first time who are not GitLab team members may have trouble logging in to the edcast technical writing course and have to search for the publicly-accessible version of the course.
With this MR, contributors can find the public technical writing course easier. The public page also provides a link to the edcast version that earns a badge.
Screenshots or screen recordings
Current behavior
The Documentation MR template currently points to a restricted-access technical writing course. The figure below shows the link for this optional course in the bottom-left corner, enclosed in a red box.
New behavior
The edited Documentation MR template points to the public version of the same technical writing course. All material on this page is publicly accessible; the page also points to the class for GitLab team members.
How to set up and validate locally
I’m not sure how best to validate the new MR template. Opening the GitLab site in GitPod creates repositories, but none seem to use the MR templates.
What I did was: copy the MR text into a markdown previewer to confirm the new URL renders as expected. For example: https://gitlab.com/pibion/gitlab/-/blob/update-documentation-merge-request-template/.gitlab/merge_request_templates/Documentation.md.
MR acceptance checklist
This checklist encourages us to confirm any changes have been analyzed to reduce risks in quality, performance, reliability, security, and maintainability.
-
I have evaluated the MR acceptance checklist for this MR.
Related issues and MR
This MR is an attempt to resolve #361822.
See also the discussion at gitlab-com/www-gitlab-com#13376 (closed).