Docs: Update how to preview SAST deprecations
What does this MR do?
This updates the preview steps from !95656 (merged) to:
- simplify the steps
- reflect the specific revision necessary for testing in Self-Managed instances due to the change missing the 15.3 self-managed package by a few hours (gitlab-com/www-gitlab-com!109377 (comment 1070883042))
My thought is that we'd update the RP item to point to this specific section for instructions. It is important to note that the existing RP item content is NOT misleading for GitLab.com users, who can directly import SAST.latest
. It is only slightly off for Self-Managed since the template isn't updated in the 15.3 package.
Related issues
gitlab-com/www-gitlab-com!109377 (merged)
Author's checklist
- [-] Optional. Consider taking the GitLab Technical Writing Fundamentals course.
-
Follow the: - [-] If you're adding or changing the main heading of the page (H1), ensure that the product tier badge is added.
-
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 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.