Skip to content

Add note about rules being enclosed in double quotes

Russell Dickenson requested to merge russell/add-note-about-quotation-marks into master

What does this MR do?

Notes in several places that a DAST list of rules to be included or excluded must be enclosed in double quotation marks.

Background information:

DAST allows for specific security checks to be included or excluded by their assigned ID. These IDs are provided in a string, for example, "10045,17742,188292". If the CSV list is not enclosed in double quote marks ("), they are interpreted as numeric values, preventing them from being processed correctly.

This MR was raised responding to a MR discussion thread.

Related issues

N/A

Author's checklist

If you are only adding documentation, do not add any of the following labels:

  • ~"feature"
  • ~"frontend"
  • ~"backend"
  • ~"bug"
  • ~"database"

These labels cause the MR to be added to code verification QA issues.

Review 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.
    • 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 like Default behavior when you close an issue.
      • The headings (other than the page title) should be active. Instead of Configuring GDK, say something like Configure 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 above reviews. Maintainer's review can occur before or after a technical writer review.
  • Ensure a release milestone is set.
Edited by Russell Dickenson

Merge request reports