docs(compliance): expand developer guide for new compliance frameworks#10870
Open
HugoPBrito wants to merge 4 commits intomasterfrom
Open
Conversation
Rewrites the developer guide for creating a new security compliance framework with complete directory/file conventions, full JSON schema reference, per-framework attribute models, check mapping rules, multi-provider guidance, output formatter steps, local validation, testing, PR submission, and a troubleshooting section. Cross-links the guide from CONTRIBUTING.md. Refs: PROWLER-1359
Contributor
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Workflows to automatically generate PRs for you. |
Contributor
|
✅ All necessary |
Contributor
|
✅ Conflict Markers Resolved All conflict markers have been successfully resolved in this pull request. |
Contributor
🔒 Container Security ScanImage: 📊 Vulnerability Summary
4 package(s) affected
|
…orks Clarifies that every requirement from the source catalog must appear in the framework JSON, even when no check can automate it. Missing requirements skew compliance percentages and dashboard metadata, so an empty Checks array is valid but an omitted requirement is not. Also retargets the rendering reference to Prowler Cloud and replaces the enumerated provider list with "All Providers". Refs: PROWLER-1359
The docs-only change does not require a SDK changelog entry. Refs: PROWLER-1359
Expands the CONTRIBUTING.md contributor index so every developer guide page (concepts, testing, miscellaneous, and provider-specific notes) is one click away. Also normalizes the compliance link to the canonical docs.prowler.com/developer-guide/<slug> path. Refs: PROWLER-1359
jfagoagas
requested changes
Apr 27, 2026
Member
jfagoagas
left a comment
There was a problem hiding this comment.
Please extend the documentation with a compliance page for Prowler Cloud / App. Thanks!
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Context
The existing developer documentation for creating a new security compliance framework was incomplete and scattered. Contributors had no single reference explaining the directory structure, the JSON schema, how framework-specific attribute models work, how to build the output formatter, how to validate the framework locally, or how to submit the PR.
Refs: PROWLER-1359
Description
Expands
docs/developer-guide/security-compliance-framework.mdxinto a comprehensive, copy-paste-friendly guide that covers:<framework>_<version>_<provider>.json).Requirementsentries.Framework/Version).Versionbreaks CLI filtering).--list-compliance,--compliance, CSV inspection, Prowler App).Also:
CONTRIBUTING.md.📚 Docschangelog entry under5.25.0inprowler/CHANGELOG.md.Steps to review
mintlify devfromdocs/) and openDeveloper Guide → Creating a New Security Compliance Framework in Prowler.<Note>callouts.prowler/lib/check/compliance_models.pyto confirm field names, types, and required/optional flags match.my_framework_1.0_aws.jsonunderprowler/compliance/aws/, runpoetry run python prowler-cli.py aws --list-compliance, and confirm the framework appears.CONTRIBUTING.mdlink resolves to the published docs page.5.25.0unreleased section.Checklist
Community Checklist
SDK/CLI
UI
API
License
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.