Add "Key Concepts" documentation #5275
Open
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
This adds a new page that gives an overview of the different concepts in Minder. It starts adding the items that were recently implemented and are yet to be documented Signed-off-by: Juan Antonio Osorio <[email protected]>
rdimitrov
reviewed
Jan 9, 2025
| ## Data Sources | ||
|
|
||
| Data sources complement providers by fetching additional contextual information from | ||
| third-party APIs. While providers manage entities, data sources provide: |
There was a problem hiding this comment.
What do you think about updating the examples below, so it doesn't sound like data sources are solely for the purpose of enriching information about dependencies?
|
|
||
| 2. *Evaluation*: Minder evaluates the entity against defined policies. | ||
|
|
||
| 3. *Remediation*: Issues identified during evaluation are flagged or resolved. |
There was a problem hiding this comment.
Should this be called Actions or perhaps add Alerting too to the list?
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.
Summary
This adds a new page that gives an overview of the different concepts in
Minder. It starts adding the items that were recently implemented and
are yet to be documented
Change Type
Mark the type of change your PR introduces:
Testing
Outline how the changes were tested, including steps to reproduce and any relevant configurations.
Attach screenshots if helpful.
Review Checklist: