docs(devel-guide): Adding some improves and clarifications to developer guide #3749
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
jfagoagas
requested changes
Apr 10, 2024
docs/developer-guide/checks.md
Outdated
| We are going to use the `ec2_ami_public` check form the `AWS` provider as an example. So the folder name will `prowler/providers/aws/services/ec2/ec2_ami_public` (following the format `prowler/providers/<provider>/services/<service>/<check_name>`), with the name of check following the pattern: `service_subservice_resource_action`. | ||
|
|
||
| ???+ note | ||
| A subservice is more specific part of a service that is gonna be audit. Sometime it could be the shortened name of the class attribute that is gonna be acceded in the check. |
There was a problem hiding this comment.
Suggested change
| A subservice is more specific part of a service that is gonna be audit. Sometime it could be the shortened name of the class attribute that is gonna be acceded in the check. | |
| A subservice is an specific component of a service that is gonna be audited. Sometimes it could be the shortened name of the class attribute that is gonna be accessed in the check. |
jfagoagas
previously approved these changes
Apr 11, 2024
puchy22
force-pushed
the
improve_devel_guide
branch
from
57a530c
to
168f2c1
Compare
sergargar
pushed a commit
that referenced
this pull request
Apr 15, 2024
…er guide (#3749) Co-authored-by: Pepe Fagoaga <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Context
There are some things in the developer guide that cannot be full understood to new users.
Description
Change services and checks docs pages to make more understandable for new users, adding new clarifications and fixing the error of Check FAIL status.
License
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.