Clarify configure SAST with customizations docs
What does this MR do and why?
While investigating https://gitlab.com/gitlab-com/sec-sub-department/section-sec-request-for-help/-/issues/357+s, I consulted the Configure SAST with customizations docs and noticed that they're incorrect.
The docs currently explain:
1. If the project does not have a `.gitlab-ci.yml` file, select **Enable SAST** in the Static
Application Security Testing (SAST) row, otherwise select **Configure SAST**.
These docs indicate that if a .gitlab-ci.yml
file is present, the button will show Configure SAST
, however, this is not the case. In order for the button to show Configure SAST
"[the latest] pipeline must have been successfully executed and generated valid artifacts" for the SAST
scanner to be considered enabled, as explained in Fix text about Ultimate features and clarify co... (!100015 - merged) • Sam White • 15.5.
This MR clarifies the condition required for the button to show Enable SAST
or Configure SAST
.
MR acceptance checklist
Please evaluate this MR against the MR acceptance checklist. It helps you analyze changes to reduce risks in quality, performance, reliability, security, and maintainability.
Screenshots or screen recordings
Before | After |
---|---|
![]() |
![]() |
Merge request reports
Activity
changed milestone to %17.4
requested review from @sam.white
assigned to @adamcohen
@sam.white can you please review this change? I've assigned this to you because you worked on Fix text about Ultimate features and clarify co... (!100015 - merged) • Sam White • 15.5. Thanks!
- A deleted user
added documentation label
1 Message This merge request adds or changes documentation files. A review from the Technical Writing team before you merge is recommended. Reviews can happen after you merge. Documentation review
The following files require a review from a technical writer:
-
doc/user/application_security/sast/index.md
(Link to current live version)
The review does not need to block merging this merge request. See the:
-
Metadata for the
*.md
files that you've changed. The first few lines of each*.md
file identify the stage and group most closely associated with your docs change. - The Technical Writer assigned for that stage and group.
- Documentation workflows for information on when to assign a merge request for review.
If needed, you can retry the
danger-review
job that generated this comment.Generated by
Danger-
- Resolved by 🤖 GitLab Bot 🤖
Proper labels assigned to this merge request. Please ignore me.
@adamcohen
- please see the following guidance and update this merge request.1 Error Please add typebug typefeature, or typemaintenance label to this merge request. Edited by 🤖 GitLab Bot 🤖
added docs-only label
added sectionsec label
- Resolved by Russell Dickenson
requested review from @rdickenson
requested review from @sam.white
added Technical Writing label
started a merge train
mentioned in commit edd6facd
added workflowstaging-canary label
added workflowcanary label and removed workflowstaging-canary label
added workflowstaging label and removed workflowcanary label
added workflowproduction label and removed workflowstaging label
added releasedcandidate label
added releasedpublished label and removed releasedcandidate label