mirror of
https://github.com/prowler-cloud/prowler.git
synced 2026-10-13 06:54:16 +00:00
Daniel Barranquero
53be73c2ac
send_findings_to_jira() now passes issue_labels (prowler, prowler-{provider},
prowler-{severity}, prowler-{check_id} and prowler-finding-{sanitized uid}),
a finding_url built from the new DJANGO_UI_BASE_URL setting (empty by
default, so self-hosted deployments emit no link unless configured) and the
tenant name as tenant_info. The label sanitizer is local to the API so it
does not depend on an unreleased SDK symbol.
Prowler Documentation
This repository contains the Prowler Open Source documentation powered by Mintlify.
Documentation Structure
- Getting Started: Overview, installation, and basic usage guides
- User Guide: Comprehensive guides for Prowler Cloud, Prowler Local Server, Prowler CLI, providers, and compliance
- Developer Guide: Technical documentation for developers contributing to Prowler
Local Development
Install a reviewed version of the Mintlify CLI to preview documentation changes locally:
npm install --global mint@4.2.689
Run the following command at the root of your documentation (where mint.json is located):
mint dev
View your local preview at http://localhost:3000.
Publishing Changes
Changes pushed to the main branch are automatically deployed to production through Mintlify's GitHub integration.
Documentation Guidelines
When contributing to the documentation, please follow the Prowler documentation style guide located in the .claude directory.
Troubleshooting
- If your dev environment isn't running: Run
mint updateto ensure you have the most recent version of the CLI. - If a page loads as a 404: Make sure you are running in a folder with a valid
mint.jsonfile and that the page path is correctly listed in the navigation.