Clarify instructions in the docs for adding excluded paths
What does this MR do?
For one of the given scenarios as part of the Category Maturity Scorecard testing, we had a customer go to the docs and copy/paste the SAST_EXCLUDED_PATHS variable into their gitlab-ci.yml template (after which they added a docs path to exclude). In the process, he overrode the defaults (spec, test, tests, tmp). These defaults are listed in the docs, but I think we can do a better job of explaining that including this variable in the yml will override those defaults, and that if they want to add more paths, they'll have to , in addition, copy/paste the default paths as well.
See Slack thread (internal)
Screenshots (strongly suggested)
Does this MR meet the acceptance criteria?
Conformity
-
📋 Does this MR need a changelog?-
I have included a changelog entry. -
I have not included a changelog entry because _____.
-
-
Documentation (if required) -
Code review guidelines -
Merge request performance guidelines -
Style guides -
Database guides -
Separation of EE specific content
Availability and Testing
-
Review and add/update tests for this feature/bug. Consider all test levels. See the Test Planning Process. -
Tested in all supported browsers -
Informed Infrastructure department of a default or new setting change, if applicable per definition of done
Security
If this MR contains changes to processing or storing of credentials or tokens, authorization and authentication methods and other items described in the security review guidelines:
-
Label as security and @ mention @gitlab-com/gl-security/appsec
-
The MR includes necessary changes to maintain consistency between UI, API, email, or other methods -
Security reports checked/validated by a reviewer from the AppSec team
cc @rdickenson @tmccaslin @twoodham @theoretick @rossfuhrman @ssarka @nmccorrison @markrian @jannik_lehmann @zrice