ben.carrasco/prowler
1
0
Fork 0
mirror of https://github.com/prowler-cloud/prowler.git synced 2026-10-04 02:04:06 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: brand tone and writing style fixes (#12277)

Browse Source 
Co-authored-by: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com>
This commit is contained in:
mintlify[bot]
2026-08-03 09:16:47 +02:00
committed by GitHub
parent b08d2eb472
commit e0cb18bdbd
9 changed files with 22 additions and 22 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/developer-guide/introduction.mdx
+1 -1
View File
@@ -75,7 +75,7 @@ Remember, our community is here to help! If you need guidance, do not hesitate t
## Setting up your development environment
## Setting Up Your Development Environment
### Prerequisites
docs/developer-guide/security-compliance-framework.mdx
+4 -4
View File
@@ -658,7 +658,7 @@ uv run pytest -n auto \
tests/lib/outputs/compliance/
```
## Version handling
## Version Handling
Prowler matches frameworks by concatenating `Framework` and `Version`. A missing or empty `Version` collapses several frameworks to the same key and breaks CLI filtering with `--compliance`.
@@ -756,7 +756,7 @@ uv run pytest -n auto tests/lib/check/universal_compliance_models_test.py \
For guidance on writing Prowler SDK tests, refer to [Unit Testing](/developer-guide/unit-testing).
## Running and listing your framework
## Running and Listing Your Framework
Once the file is in place, the CLI auto-discovers it:
@@ -769,7 +769,7 @@ prowler <provider> --compliance <framework_key> --list-compliance-requirements <
For end-user-facing tutorials (recommended for high-profile frameworks), add a dedicated page under `docs/user-guide/compliance/tutorials/` and register it in the `"Compliance"` group of `docs/docs.json`. See `docs/user-guide/compliance/tutorials/threatscore.mdx` as a reference.
## Submitting the pull request
## Submitting the Pull Request
Before opening the pull request:
@@ -794,7 +794,7 @@ The following issues are the most common when contributing a compliance framewor
- **CSV file is missing after the scan (legacy).** The transformer class is not registered in `prowler/lib/outputs/compliance/compliance_output.py`, or `transform()` raises silently. Run the scan with `--log-level DEBUG`.
- **Findings do not roll up under a requirement.** A check listed in `Checks` either does not exist for that provider or is spelled incorrectly. Run `--list-checks | grep <check_name>` to confirm, or run the check-existence cross-check from "Validating Your Framework".
## Reference examples
## Reference Examples
Use the following files as templates when modeling a new contribution.