From 5202a68cf0543b589f7de97435e132bc7dc98991 Mon Sep 17 00:00:00 2001 From: "mintlify[bot]" <109931778+mintlify[bot]@users.noreply.github.com> Date: Mon, 24 Aug 2026 11:17:37 +0200 Subject: [PATCH] docs: brand tone and writing style fixes (#12510) Co-authored-by: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com> --- docs/developer-guide/provider.mdx | 2 +- docs/developer-guide/unit-testing.mdx | 2 +- docs/getting-started/comparison/gcp.mdx | 2 +- docs/getting-started/installation/prowler-cli.mdx | 2 +- docs/user-guide/cli/tutorials/custom-checks-metadata.mdx | 2 +- docs/user-guide/cli/tutorials/dashboard.mdx | 2 +- docs/user-guide/providers/aws/authentication.mdx | 2 +- docs/user-guide/providers/aws/multiaccount.mdx | 2 +- docs/user-guide/providers/scaleway/authentication.mdx | 2 +- docs/user-guide/tutorials/prowler-app-rbac.mdx | 2 +- 10 files changed, 10 insertions(+), 10 deletions(-) diff --git a/docs/developer-guide/provider.mdx b/docs/developer-guide/provider.mdx index 1a570ccb68..70fd519505 100644 --- a/docs/developer-guide/provider.mdx +++ b/docs/developer-guide/provider.mdx @@ -107,7 +107,7 @@ Once you have decided the provider you want or need to add to Prowler, the next - **SDK Providers**: Low complexity. You have mature examples like AWS, Azure, GCP, Kubernetes, etc. that you can leverage to implement your provider. - **API Providers**: Medium complexity. You need to implement the authentication and session management, and the API calls to the provider. You now have NHN and MongoDB Atlas as example to follow. - **Tool/Wrapper Providers**: High complexity. You need to implement the argument/output mapping to the provider and handle problems that the tool/wrapper may have. You now have IAC and the PowerShell wrapper as example to follow. -- **Hybrid Providers**: High complexity. You need to "customize" your provider, mixing the other types of providers in order to achieve the desired result. You have M365 (msgraph SDK + PowerShell wrapper) and GitHub (PyGithub SDK + graphql API requests) as examples. +- **Hybrid Providers**: High complexity. You need to "customize" your provider, mixing the other types of providers to achieve the desired result. You have M365 (msgraph SDK + PowerShell wrapper) and GitHub (PyGithub SDK + graphql API requests) as examples. ### Determining Regional vs Non-Regional Architecture diff --git a/docs/developer-guide/unit-testing.mdx b/docs/developer-guide/unit-testing.mdx index ca6d068bd4..8c8ba5ed49 100644 --- a/docs/developer-guide/unit-testing.mdx +++ b/docs/developer-guide/unit-testing.mdx @@ -525,7 +525,7 @@ with mock.patch( ): ``` -As demonstrated in the code above, mocking both the AWS audit information and all utilized services is mandatory for proper test execution. +As demonstrated in the code above, mocking both the AWS audit information and all used services is mandatory for proper test execution. #### Patching vs. Importing diff --git a/docs/getting-started/comparison/gcp.mdx b/docs/getting-started/comparison/gcp.mdx index 00f61091d7..7c80b990a0 100644 --- a/docs/getting-started/comparison/gcp.mdx +++ b/docs/getting-started/comparison/gcp.mdx @@ -22,7 +22,7 @@ Google Cloud Security Command Center (Cloud SCC) is a centralized security and r - **GCP-Centric:** While Cloud SCC is powerful within the GCP ecosystem, it is primarily focused on GCP and does not natively extend to multi-cloud environments without additional tools or connectors. -- **Cost Considerations:** As a managed service within GCP, costs can scale with the amount of data ingested and the complexity of the environment, especially as additional features or higher volumes of data are utilized. +- **Cost Considerations:** As a managed service within GCP, costs can scale with the amount of data ingested and the complexity of the environment, especially as additional features or higher volumes of data are used. - **Dependency on GCP Services:** Cloud SCC's capabilities depend on other GCP services being enabled, such as Security Health Analytics and Web Security Scanner, which may increase overall complexity and cost. diff --git a/docs/getting-started/installation/prowler-cli.mdx b/docs/getting-started/installation/prowler-cli.mdx index 717b0e7cc7..597ea13319 100644 --- a/docs/getting-started/installation/prowler-cli.mdx +++ b/docs/getting-started/installation/prowler-cli.mdx @@ -45,7 +45,7 @@ To install Prowler as a Python package, use `Python >= 3.10, <= 3.13`. Prowler i _Requirements_: * Have `docker` installed: https://docs.docker.com/get-docker/. - * In the command below, change `-v` to your local directory path in order to access the reports. + * In the command below, change `-v` to your local directory path to access the reports. * AWS, GCP, Azure and/or Kubernetes credentials _Commands_: diff --git a/docs/user-guide/cli/tutorials/custom-checks-metadata.mdx b/docs/user-guide/cli/tutorials/custom-checks-metadata.mdx index 9ca369eb94..f658432782 100644 --- a/docs/user-guide/cli/tutorials/custom-checks-metadata.mdx +++ b/docs/user-guide/cli/tutorials/custom-checks-metadata.mdx @@ -6,7 +6,7 @@ In certain organizations, the severity of specific checks might differ from the The custom metadata option offers a means to override default metadata set by Prowler. -You can utilize `--custom-checks-metadata-file` followed by the path to your custom checks metadata YAML file. +You can use `--custom-checks-metadata-file` followed by the path to your custom checks metadata YAML file. ## Available Fields diff --git a/docs/user-guide/cli/tutorials/dashboard.mdx b/docs/user-guide/cli/tutorials/dashboard.mdx index 46a910b67c..2a24644e68 100644 --- a/docs/user-guide/cli/tutorials/dashboard.mdx +++ b/docs/user-guide/cli/tutorials/dashboard.mdx @@ -99,7 +99,7 @@ def get_table(data): ## S3 Integration -If you are using Prowler Cloud with the S3 integration or that integration from Prowler CLI and you want to use your data from your S3 bucket, you can run the following command in order to load the dashboard with the new files: +If you are using Prowler Cloud with the S3 integration or that integration from Prowler CLI and you want to use your data from your S3 bucket, you can run the following command to load the dashboard with the new files: ```sh aws s3 cp s3:///output/csv ./output --recursive diff --git a/docs/user-guide/providers/aws/authentication.mdx b/docs/user-guide/providers/aws/authentication.mdx index e3c20ca99d..35c37548ea 100644 --- a/docs/user-guide/providers/aws/authentication.mdx +++ b/docs/user-guide/providers/aws/authentication.mdx @@ -64,7 +64,7 @@ This method grants permanent access and is the recommended setup for production 7. Click "Submit" to deploy the stack - ![Click on submit](/images/providers/submit-third-page.png) + ![Click Submit](/images/providers/submit-third-page.png) To provision the scan role using Terraform: diff --git a/docs/user-guide/providers/aws/multiaccount.mdx b/docs/user-guide/providers/aws/multiaccount.mdx index 824e367875..e89302ee65 100644 --- a/docs/user-guide/providers/aws/multiaccount.mdx +++ b/docs/user-guide/providers/aws/multiaccount.mdx @@ -2,7 +2,7 @@ title: 'Scanning Multiple AWS Accounts with Prowler' --- -Prowler enables security scanning across multiple AWS accounts by utilizing the [Assume Role feature](/user-guide/providers/aws/role-assumption) and [integration with AWS Organizations feature](/user-guide/providers/aws/organizations). +Prowler enables security scanning across multiple AWS accounts by using the [Assume Role feature](/user-guide/providers/aws/role-assumption) and [integration with AWS Organizations feature](/user-guide/providers/aws/organizations). This approach allows execution from a single account with permissions to assume roles in the target accounts. diff --git a/docs/user-guide/providers/scaleway/authentication.mdx b/docs/user-guide/providers/scaleway/authentication.mdx index cecabf3a97..13045104dd 100644 --- a/docs/user-guide/providers/scaleway/authentication.mdx +++ b/docs/user-guide/providers/scaleway/authentication.mdx @@ -34,4 +34,4 @@ prowler scaleway ## Required Scaleway Permissions -The API key bearer needs read access to the IAM API in order to list users and API keys. The `IAMReadOnly` policy is sufficient. Refer to the [Scaleway IAM policy reference](https://www.scaleway.com/en/docs/identity-and-access-management/iam/reference-content/permission-sets/) for the full list of permissions. +The API key bearer needs read access to the IAM API to list users and API keys. The `IAMReadOnly` policy is sufficient. Refer to the [Scaleway IAM policy reference](https://www.scaleway.com/en/docs/identity-and-access-management/iam/reference-content/permission-sets/) for the full list of permissions. diff --git a/docs/user-guide/tutorials/prowler-app-rbac.mdx b/docs/user-guide/tutorials/prowler-app-rbac.mdx index 4668a835fc..90ecafbcb4 100644 --- a/docs/user-guide/tutorials/prowler-app-rbac.mdx +++ b/docs/user-guide/tutorials/prowler-app-rbac.mdx @@ -69,7 +69,7 @@ To remove **another** user from your organization, use the [_Expel from organiza #### Inviting Users -Please be aware that at this time, an email address can only be associated with a single Prowler account. +Note that an email address can only be associated with a single Prowler account. Follow these steps to invite a user to your account: