Improve how the deprecations doc is auto-generated (relative links)
The docs need relative links, but the release post needs absolute links.
We should have the release post items using absolute links, and then the script should generate relative links automatically when needed.
- Related to !69358 (merged)
- Related to !66770 (merged)
- Related to gitlab-com/Product#2864 (closed)
Iterative improvement plan
-
(!71054 (merged)) Add the vale
exclusion code for relative links to the deprecations doc, so absolute links are ignored.-
As part of this, run the rake task and update the doc (all links will change to absolute).
At this point, PMs/EMs/etc... should be able to run the rake task themselves, and all TWs need to do is review/merge the updates.
-
-
When we are all happy that it's working correctly, re-add the pipeline job that makes sure we are running the rake task in each MR and keeping things in sync. -
Improve the rake task so it generates relative links for the gitlab
docs, and absolute links for the release post. -
If this works fine for a reasonable amount of time, remove the code that stops the linter, and start linting the deprecations doc again.
Edited by Marcel Amirault