Start copy editing job control page
What does this MR do?
As part of the related issue, we should improve this highly visited page. The first step is to remove the deprecated only/except information:
- The only/except keywords have been officially deprecated for a while now, so it's time to remove these examples as part of no longer recommending their use: !135835 (merged)
- The "unsafe regex" feature flag was removed 2 years ago (!79611 (merged)), was default disabled for years before, and is related to the deprecated keywords and was never really a recommended thing to do. As a result, we should remove that as well.
Additionally, while I was here, I also removed antiquated version history as well, as per our guidelines: https://docs.gitlab.com/ee/development/documentation/versions.html#which-versions-are-removed
Related issues
Related to https://gitlab.com/gitlab-org/technical-writing/-/issues/981
Author's checklist
-
Optional. Consider taking the GitLab Technical Writing Fundamentals course. -
Follow the: -
If you're adding a new page, add the product tier badge under the H1 topic title. -
If you are a GitLab team member, request a review based on: - The documentation page's metadata.
- The associated Technical Writer.
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.
Reviewer's checklist
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.
-
If the content requires it, ensure the information is reviewed by a subject matter expert. - Technical writer review items:
-
Ensure docs metadata is present and up-to-date. -
Ensure the appropriate labels are added to this MR. -
Ensure a release milestone is set. - If relevant to this MR, ensure content topic type principles are in use, including:
-
The headings should be something you'd do a Google search for. Instead of Default behavior
, say something likeDefault behavior when you close an issue
. -
The headings (other than the page title) should be active. Instead of Configuring GDK
, say something likeConfigure GDK
. -
Any task steps should be written as a numbered list. - If the content still needs to be edited for topic types, you can create a follow-up issue with the docs-technical-debt label.
-
-
-
Review by assigned maintainer, who can always request/require the reviews above. Maintainer's review can occur before or after a technical writer review.