ben.carrasco/prowler
1
0
Fork 0
mirror of https://github.com/prowler-cloud/prowler.git synced 2026-07-20 19:11:54 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
429f807f8c4e9ca62a0c58cf39ccb5cecf04130a
prowler/docs
T
History
Andoni A. 429f807f8c docs(image): document registry authentication methods 
- Cover basic auth, token-based auth, and manual docker login
- Document auth method priority and automatic cleanup behavior
- Update troubleshooting section with environment variable references
2026-02-13 10:59:17 +01:00
..
developer-guide
ci: add duplicate test name checker across providers (#9949)
2026-02-03 12:00:41 +01:00
getting-started
fix(image): include missing merge changes from stage-1 and docs branches
2026-02-12 22:38:11 +01:00
images
docs: restructure SAML SSO guide for Okta App Catalog (#10012)
2026-02-11 11:15:59 +01:00
img
docs: enhance README (#9505)
2025-12-10 18:28:27 +01:00
security
docs(security): restructure security page into dedicated sections (#9836)
2026-01-20 15:27:29 +01:00
snippets
docs: add version label in pages (#9020)
2025-10-27 09:20:37 +01:00
user-guide
docs(image): document registry authentication methods
2026-02-13 10:59:17 +01:00
.mintlifyignore
docs: migrate to Mintlify (#8894)
2025-10-15 16:38:56 +02:00
AGENTS.md
docs(alibabacloud): provider documentation (#9721)
2026-01-07 11:45:57 +01:00
docs.json
docs(image): add Image provider getting-started guide
2026-02-06 15:22:11 +01:00
favicon.ico
chore(favicon): update favicon logo (#4151)
2024-06-03 12:01:30 +02:00
introduction.mdx
docs(openstack): add provider to introduction table (#9990)
2026-02-09 10:33:10 +01:00
README.md
docs: migrate to Mintlify (#8894)
2025-10-15 16:38:56 +02:00
style.css
docs: add version label in pages (#9020)
2025-10-27 09:20:37 +01:00
support.mdx
docs(security): restructure security page into dedicated sections (#9836)
2026-01-20 15:27:29 +01:00
troubleshooting.mdx
fix(image): include missing merge changes from stage-1 and docs branches
2026-02-12 22:38:11 +01:00

README.md

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 App, CLI, providers, and compliance
  • Developer Guide: Technical documentation for developers contributing to Prowler

Local Development

Install the Mintlify CLI to preview documentation changes locally:

npm i -g mint

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 update to 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.json file and that the page path is correctly listed in the navigation.

Resources

Reference in New Issue View Git Blame Copy Permalink