Add docs for profiles #1405
Add docs for profiles #1405
Conversation
Signed-off-by: Radoslav Dimitrov <radoslav@stacklok.com>
docs/docs/understand/profiles.md
Outdated
| repository: | ||
| - type: secret_scanning | ||
| def: | ||
| enabled: true |
There was a problem hiding this comment.
Since we talk about different entity types in the text, should we include a profile that has examples for at least two?
We might also want to add an example of the different settings and how to find them in rule_types.
Let me know if you want to merge this first and do a follow-up.
There was a problem hiding this comment.
I thought about it, but I saw a comment in another PR about keeping things simple so I wasn't sure to which extend I have to put all of the available details here.
I'l add another entity type and have a few sentences providing a simple example of how to find the available settings for a given rule type.
There was a problem hiding this comment.
I think if we point to the repo with examples, it would be sufficient
| rules for various entity types, such as repositories, pull requests, and artifacts, across your registered GitHub | ||
| repositories. | ||
|
|
||
| Profiles are defined in a YAML file and can be easily configured to meet your compliance requirements. |
There was a problem hiding this comment.
We should probably also point to https://github.com/stacklok/minder-rules-and-profiles/tree/main/profiles/github
docs/docs/understand/profiles.md
Outdated
| repository: | ||
| - type: secret_scanning | ||
| def: | ||
| enabled: true |
There was a problem hiding this comment.
I think if we point to the repo with examples, it would be sufficient
Signed-off-by: Radoslav Dimitrov <radoslav@stacklok.com>
No description provided.