Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs(integrations): add integrations docs #6269

Conversation

pedrooot
Copy link
Member

Description

This pull request includes significant updates to the docs/developer-guide/integrations.md file to provide comprehensive guidance on creating new integrations with Prowler. The changes introduce detailed steps and best practices for developing, testing, and documenting integrations with external tools.

Documentation improvements:

  • Changed the title from "Create a new integration" to "Creating a New Integration" to improve clarity.
  • Added an introduction explaining the benefits and common targets for Prowler integrations, such as Slack, Jira, and AWS Security Hub.
  • Outlined the steps to create a general integration, including identifying the integration purpose, reviewing Prowler’s capabilities, developing the integration, and testing it.
  • Included guidelines for scripting, configuration, and creating an integration class with methods for testing connections and sending findings.
  • Emphasized the importance of thorough documentation for setup, configuration, and troubleshooting to ensure maintainability and ease of onboarding.

Checklist

License

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.

Copy link
Contributor

You can check the documentation for this PR here -> Prowler Documentation

Copy link
Contributor

github-actions bot commented Jan 7, 2025

You can check the documentation for this PR here -> Prowler Documentation

docs/developer-guide/integrations.md Outdated Show resolved Hide resolved
Copy link
Contributor

github-actions bot commented Jan 7, 2025

You can check the documentation for this PR here -> Prowler Documentation

Copy link
Contributor

github-actions bot commented Jan 7, 2025

You can check the documentation for this PR here -> Prowler Documentation

Copy link
Contributor

github-actions bot commented Jan 7, 2025

You can check the documentation for this PR here -> Prowler Documentation

@jfagoagas jfagoagas requested a review from puchy22 January 10, 2025 10:28
docs/developer-guide/integrations.md Outdated Show resolved Hide resolved
docs/developer-guide/integrations.md Outdated Show resolved Hide resolved
Copy link
Contributor

You can check the documentation for this PR here -> Prowler Documentation

@jfagoagas jfagoagas merged commit 6a5f1a7 into master Jan 10, 2025
10 checks passed
@jfagoagas jfagoagas deleted the PRWLR-4082-include-in-the-developer-guide-how-to-create-a-new-integration branch January 10, 2025 11:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants