Add GraphQL examples and enhance JSON schema documentation for compliance frameworks (!205299) · Merge requests · GitLab.org / GitLab · GitLab

What does this MR do?

This MR addresses feedback from the Product Security team's dogfooding of custom compliance frameworks by adding two key documentation improvements:

New GraphQL examples page: Creates doc/api/graphql/compliance_frameworks.md with comprehensive GraphQL examples for configuring compliance frameworks, similar to the existing audit event streaming documentation.
Enhanced JSON schema documentation: Updates the main compliance frameworks page with more detailed information about JSON schema structure and the Compliance Adherence Templates project.

Related issues

Addresses feedback from https://gitlab.com/gitlab-com/gl-security/product-security/product-security-engagements/product-security-requests/-/issues/16#note_2755976160

Changes made

New GraphQL documentation page

Added comprehensive GraphQL examples for compliance framework operations
Includes mutations for creating, updating, and deleting frameworks
Shows how to manage requirements and controls via GraphQL
Provides examples for applying frameworks to projects
Follows the same structure as existing GraphQL documentation

Enhanced main documentation

Added detailed JSON schema information section
Expanded description of the Compliance Adherence Templates project
Improved cross-references between related documentation
Added clearer guidance on JSON template usage

Documentation checklist

Added new GraphQL examples page with comprehensive examples
Enhanced existing compliance frameworks documentation
Followed existing documentation patterns and style
Added appropriate cross-references
Included proper metadata and history sections