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

Co-authored-by: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com>
2026-08-19 09:30:21 +00:00 · 2026-08-03 09:16:47 +02:00
parent b08d2eb472
commit e0cb18bdbd
9 changed files with 22 additions and 22 deletions
@@ -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

@@ -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.

@@ -6,7 +6,7 @@ title: 'Microsoft Defender for Cloud'

 ---

-## **Overview**
+## Overview

 If you're using Microsoft Defender for Cloud to monitor your Azure infrastructure, Prowler can complement it with fully transparent, customizable scans across Azure, AWS, GCP, and Kubernetes. Prowler helps you validate policies, automate compliance, and gain deeper visibility—all from the CLI, API or our Prowler UI.

@@ -19,7 +19,7 @@ You can run Prowler alongside Defender for Cloud to:

 ---

-## **Why use Prowler with Defender for Cloud**
+## Why Use Prowler with Defender for Cloud

 Microsoft Defender for Cloud offers centralized dashboards, alerting, and some cross-cloud coverage. Prowler provides full transparency and control over what’s being checked and how those checks work—no vendor lock-in, no surprises.

@@ -32,11 +32,11 @@ Use them together to get:

 ---

-## **Quickstart**
+## Quickstart

 Here’s how to install Prowler and run a scan in your Azure account.

-### **1\. Install Prowler**
+### 1\. Install Prowler

 ```
 git clone https://github.com/prowler-cloud/prowler
@@ -44,7 +44,7 @@ cd prowler
 ./install.sh
 ```

-### **2\. Authenticate with Azure**
+### 2\. Authenticate with Azure

 Make sure you're signed in and select your subscription:

@@ -53,7 +53,7 @@ az login
 export AZURE_SUBSCRIPTION_ID=$(az account show --query id -o tsv)
 ```

-### **3\. Run a scan**
+### 3\. Run a Scan

 ```
 ./prowler -p Azure -f az-aks -f az-general
@@ -61,7 +61,7 @@ export AZURE_SUBSCRIPTION_ID=$(az account show --query id -o tsv)

 This will run checks focused on Azure Kubernetes Service (AKS) and general Azure best practices.

-### **4\. Review results**
+### 4\. Review Results

 ```
 cat output/prowler-output-*.json
@@ -72,7 +72,7 @@ You can export findings in JSON, CSV, JUnit, HTML, or AWS Security Hub–compati

 ---

-## **Compare capabilities**
+## Compare Capabilities

 | Feature | Microsoft Defender for Cloud | Prowler |
 | ----- | ----- | ----- |
@@ -86,7 +86,7 @@ You can export findings in JSON, CSV, JUnit, HTML, or AWS Security Hub–compati

 ---

-## **Common use cases**
+## Common Use Cases

 **✅ Validate policies**
 Run Prowler to confirm your Azure policies are configured as expected and compliant with frameworks like CIS or NIST.
@@ -4,7 +4,7 @@ title: "AWS Marketplace"

 This section contains the instructions to subscribe to **Prowler Cloud** through the **AWS Marketplace**.

-## How to subscribe
+## How to Subscribe

 To get to the **Prowler Cloud** product listing in the AWS Marketplace, and click the `View purchase options` button:

@@ -16,7 +16,7 @@ To get to the **Prowler Cloud** product listing in the AWS Marketplace, and clic

    ![](/images/aws-marketplace/marketplace-subscribe.png)

-## Set up your account
+## Set Up Your Account

 After you have subscribed to the **Prowler Cloud** product, you will need to set up your **Prowler Cloud** account:

@@ -94,7 +94,7 @@ Prowler supports a wide range of providers organized by category:

 For more information about the checks and compliance of each provider, visit [Prowler Hub](https://hub.prowler.com).

-## Where to go next?
+## Where to Go Next?

 <Columns cols={2}>
  <Card title="User Guide" icon="terminal" href="/user-guide/tutorials/prowler-app">
@@ -133,7 +133,7 @@ Write-Host "$(Get-Date -Format 'yyyy-MM-dd HH:mm:ss') - All jobs completed"

 Output will be stored in `C:\Users\YOUR-USER\Documents\output\`

-## Combining the output files
+## Combining the Output Files

 Guidance is provided for the CSV file format. From the ouput directory, execute either the following Bash or PowerShell script. The script will collect the output from the CSV files, only include the header from the first file, and then output the result as CombinedCSV.csv in the current working directory.

@@ -49,7 +49,7 @@ prowler <provider> -M csv json-ocsf json-asff -o <custom_report_directory>
 Both flags can be used simultaneously to provide a custom directory and filename. `console prowler <provider> -M csv json-ocsf json-asff \ -F <custom_report_name> -o <custom_report_directory>`

 </Note>
-## Output timestamp format
+## Output Timestamp Format

 By default, the timestamp format of the output files is ISO 8601. This can be changed with the flag `--unix-timestamp` generating the timestamp fields in pure unix timestamp format.

@@ -2,7 +2,7 @@
 title: 'Installing Prowler in AWS CloudShell'
 ---

-## Following the migration of AWS CloudShell from Amazon Linux 2 to Amazon Linux 2023
+## Following the Migration of AWS CloudShell from Amazon Linux 2 to Amazon Linux 2023

 AWS CloudShell has migrated from Amazon Linux 2 to Amazon Linux 2023 [[1]](https://aws.amazon.com/about-aws/whats-new/2023/12/aws-cloudshell-migrated-al2023/) [[2]](https://docs.aws.amazon.com/cloudshell/latest/userguide/cloudshell-AL2023-migration.html). With this transition, Python 3.9 is now included by default in AL2023, eliminating the need for manual compilation.

@@ -14,7 +14,7 @@ Prowler for Scaleway scans IAM resources in your Scaleway organization for secur

 Prowler authenticates to Scaleway with a Scaleway API key. See [Scaleway Authentication in Prowler](./authentication) for the full setup, environment variables, CLI flags, and required permissions.

-## Run a scan
+## Run a Scan

 ```bash
 export SCW_ACCESS_KEY="SCW..."
@@ -30,7 +30,7 @@ To run only the IAM root-key check:
 prowler scaleway --check iam_api_keys_no_root_owned
 ```

-## Checks shipped
+## Checks Shipped

 | Check ID | Severity | Description |
 |---|---|---|