Skip to content

Add shared Code Security configuration page for SAST and SCA#35962

Open
rjcoulter22 wants to merge 5 commits intomasterfrom
ryan.coulter/k9vuln-12786-code-security-configuration-docs
Open

Add shared Code Security configuration page for SAST and SCA#35962
rjcoulter22 wants to merge 5 commits intomasterfrom
ryan.coulter/k9vuln-12786-code-security-configuration-docs

Conversation

@rjcoulter22
Copy link
Copy Markdown
Contributor

@rjcoulter22 rjcoulter22 commented Apr 14, 2026

What does this PR do? What is the motivation?

Adds a new shared Code Security Configuration page covering both SAST and SCA config in one place, given both products are now able to be configured with the unified code security configuration file. The intent is that we will link to the generic page from the config editor in the UI.

Previously, configuration docs only existed under the SAST setup page. Now that the unified config editor supports both sast and sca keys (as part of schema v1.1 created here), a single shared page is used as the entry point to the documentation. Each sub product will have their own specific section going over the configuration for said product.

Changes:

  • New page at /security/code_security/configuration/ covering config locations, precedence/merging, and links to SAST and SCA-specific config docs
  • Adds the new page to the sidebar nav under Code Security
  • Removes duplicated config locations/merging content from the SAST setup page, replacing it with a link to the shared page
  • Adds sca: ignore-paths configuration docs to the SCA index page

Merge instructions

Merge readiness:

  • Ready for merge

AI assistance

Claude Code used for drafting content and structure.

@github-actions github-actions bot added the Architecture Everything related to the Doc backend label Apr 14, 2026
@rjcoulter22 rjcoulter22 force-pushed the ryan.coulter/k9vuln-12786-code-security-configuration-docs branch 5 times, most recently from 169fe2d to f80b670 Compare April 15, 2026 19:06
Content moved from the SAST setup page to a new shared page at
/security/code_security/configuration/. Minimal adjustments: heading
levels and 'SAST' → 'Code Security' in the opening line. All other
text is verbatim. Also adds the new page to the sidebar nav.
- Updates the merge example to v1.1 with both sast and sca sections
- Adds a configuration file format section showing the v1.1 schema
- Adds further reading links to SAST and SCA product config docs
Removes the 'Configuration locations' and 'Configuration precedence
and merging' sections (now at /security/code_security/configuration/)
and replaces them with a link. No other wording changes.
@rjcoulter22 rjcoulter22 force-pushed the ryan.coulter/k9vuln-12786-code-security-configuration-docs branch 2 times, most recently from 7c2c769 to 0ef496f Compare April 15, 2026 19:50
@rjcoulter22 rjcoulter22 force-pushed the ryan.coulter/k9vuln-12786-code-security-configuration-docs branch from 0ef496f to 244d56d Compare April 16, 2026 12:15
@drichards-87 drichards-87 added the editorial review Waiting on a more in-depth review label Apr 16, 2026
@rjcoulter22 rjcoulter22 marked this pull request as ready for review April 16, 2026 19:26
@rjcoulter22 rjcoulter22 requested a review from a team as a code owner April 16, 2026 19:26
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Architecture Everything related to the Doc backend editorial review Waiting on a more in-depth review

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants