Fix issues in deprecation doc
- Dec 02, 2024
-
-
Marcel Amirault authored
Runs vale on deprecation doc to identify previously missed issues. Also updates acronyms and versions rule.
-
While reviewing a deprecation item, I noticed a doubled word, normally caught by Vale. We've turned off Vale on the deprecation doc due to the relative links and the style being more like release post items than product documentation, but this means some important issues get missed. The majority of the changes here include:
GitLab's
.GitLab's
everywhere else.cancelled
and typos.Running Vale on this file highlights a huge number of issues that are easily fixed. This MR fixes a lot, but it's just a drop in the bucket and we might want to consider finding a way to lint this doc, or review it periodically.
If you are a GitLab team member and only adding documentation, do not add any of the following labels:
~"frontend"
~"backend"
~"type::bug"
~"database"
These labels cause the MR to be added to code verification QA issues.
Documentation-related MRs should be reviewed by a Technical Writer for a non-blocking review, based on Documentation Guidelines and the Style Guide.
If you aren't sure which tech writer to ask, use roulette or ask in the #docs Slack channel.
Default behavior
, say something like Default behavior when you close an issue
.Configuring GDK
, say something like Configure GDK
.Runs vale on deprecation doc to identify previously missed issues. Also updates acronyms and versions rule.