Report: GitLab issues in docs
Issue Description
The product documentation contains many links to GitLab issues, many of them relating to known issues or upcoming feature development. Examples:
- https://docs.gitlab.com/ee/administration/timezone.html (mentions gitlab#27209 (closed))
- https://docs.gitlab.com/ee/administration/geo/disaster_recovery/background_verification.html (mentions &1430 (closed))
- https://docs.gitlab.com/ee/administration/gitaly/praefect.html (mentions &1489)
When these issues/MRs are completed (via closing or merging), they can affect the product documentation. For example, a linked GitLab issue regarding a workaround could be completed, which may then require a change to the doc page. Or an upcoming feature change that is referred to on a doc page may have actually been released, and the doc page needs to be changed to reflect that.
It would be good to have regular automated scans of GitLab issue links in the product documentation to determine those issues that have been closed. We could then use that report to revisit these pages to determine if there are any content changes required.
Note: The automated tooling may need to be configured to ignore GitLab issue links that share a line with the word "Introduced" to avoid false-positives.
(Thanks to @sselhorn for the idea during our discussion about gitlab!34000 (closed).)
Mentioning @gl-docsteam for awareness.
Next steps
-
Validate concept with team -
Determine the technical resource to develop the tool -
Create a linked MR to create the scanning tool -
Develop mechanism to handle regularly generated "completed issue/MR" report
Report name: links-issues