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

chore(docs): add summary table to README.md #2402

Merged
merged 5 commits into from
May 24, 2023

Conversation

toniblyx
Copy link
Member

Context

To help users understand what they will be able to do with Prowler, we have added a table with details of what it is covered so far and what is coming soon.
Screenshot 2023-05-23 at 17 54 48

License

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

@toniblyx toniblyx requested a review from a team as a code owner May 23, 2023 15:55
Copy link
Member

@sergargar sergargar left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I love it! Please check my comments.

README.md Outdated
Comment on lines 40 to 46
| Provider | Checks | Services | [Compliance Frameworks](https://docs.prowler.cloud/en/latest/tutorials/compliance/) | [Categories](https://docs.prowler.cloud/en/latest/tutorials/misc/#categories) |
|---|---|---|---|---|
| AWS | 281 | 54: `prowler aws --list-services` | 21: `prowler aws --list-compliance` | 6: `prowler aws --list-categories` |
| GCP | 43 | 7: `prowler gcp --list-services` | CIS soon | - `prowler gcp --list-categories`|
| Azure | 20 | 3: `prowler gcp --list-services` | CIS soon | 1: `prowler azure --list-categories` |
| Kubernetes | Planned | - | - | - |
|
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
| Provider | Checks | Services | [Compliance Frameworks](https://docs.prowler.cloud/en/latest/tutorials/compliance/) | [Categories](https://docs.prowler.cloud/en/latest/tutorials/misc/#categories) |
|---|---|---|---|---|
| AWS | 281 | 54: `prowler aws --list-services` | 21: `prowler aws --list-compliance` | 6: `prowler aws --list-categories` |
| GCP | 43 | 7: `prowler gcp --list-services` | CIS soon | - `prowler gcp --list-categories`|
| Azure | 20 | 3: `prowler gcp --list-services` | CIS soon | 1: `prowler azure --list-categories` |
| Kubernetes | Planned | - | - | - |
|
| Provider | Checks | Services | [Compliance Frameworks](https://docs.prowler.cloud/en/latest/tutorials/compliance/) | [Categories](https://docs.prowler.cloud/en/latest/tutorials/misc/#categories) |
|---|---|---|---|---|
| AWS | 281 | 54 -> `prowler aws --list-services` | 21 -> `prowler aws --list-compliance` | 6 -> `prowler aws --list-categories` |
| GCP | 43 | 7 -> `prowler gcp --list-services` | CIS soon | 0 -> `prowler gcp --list-categories`|
| Azure | 20 | 3 -> `prowler gcp --list-services` | CIS soon | 1 -> `prowler azure --list-categories` |
| Kubernetes | Planned | - | - | - |
|

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

How about putting arrows?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No hahaha

README.md Outdated Show resolved Hide resolved
@jfagoagas jfagoagas force-pushed the PRWLR-1696-add-checks-number-table-to-readme branch from 8ad324e to e8a152f Compare May 24, 2023 06:30
toniblyx and others added 2 commits May 24, 2023 13:23
Co-authored-by: Sergio Garcia <38561120+sergargar@users.noreply.github.com>
sergargar
sergargar previously approved these changes May 24, 2023
Copy link
Member

@sergargar sergargar left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

good job!

README.md Outdated Show resolved Hide resolved
@sergargar sergargar self-requested a review May 24, 2023 11:39
@sergargar sergargar merged commit ff18fd2 into master May 24, 2023
4 checks passed
@sergargar sergargar deleted the PRWLR-1696-add-checks-number-table-to-readme branch May 24, 2023 11:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants