add connectors concepts in documentation#235
Open
lucamrgs wants to merge 6 commits intodevelopmentfrom
Open
Conversation
Sigrid maintainability feedbackShow detailsSigrid compared your code against the baseline of 2024-11-07. 👍 What went well?
👎 What could be better?
📚 Remaining technical debt
View this system in Sigrid** to explore your technical debt ⭐️ Sigrid ratings
Did you find this feedback helpful?We would like to know your thoughts to make Sigrid better. |
lucamrgs
changed the title
MaartendeKruijf
force-pushed
the
feature/docs/234-connector-reporters-documentation
branch
from
8c1e222 to
e249951
Compare
MaartendeKruijf
temporarily deployed
to
development-pages
GitHub Actions
Inactive
MaartendeKruijf
requested changes
Nov 7, 2024
Collaborator
MaartendeKruijf
left a comment
MaartendeKruijf
left a comment
There was a problem hiding this comment.
I think is looks good only the links need to be fixed and we could at some paragraph about the asynchronous nature of reporting
| For the execution of a playbook, a *Decomposer* and invoked *Executor*s are injected with a *Reporter*. The *Reporter* maintains the reporting logic that reports execution information to a set of specified and available targets. | ||
|
|
||
| A reporting target can be internal to SOARCA, such as a [Cache](#cache-reporter). A reporting target can also be a third-party tool, such as an external SOAR/ SIEM, or incident case management system. | ||
| A reporting target can be internal to SOARCA, such as a [Cache](#cache-reporter). A reporting target can also be a third-party tool, such as an external SOAR/ SIEM, or incident case management system (see [connectors](https://cossas.github.io/SOARCA/docs/core-components/connectors/)). |
Collaborator
There was a problem hiding this comment.
This link doesn't work
| Along the execution of the workflow steps, the reporting classes will dynamically update the steps execution information such as output variables, and step execution success or failure. | ||
|
|
||
| The reporting features will enable the population and updating of views and data concerning workflow composition and its dynamic execution results. This data can be transmitted to SOARCA internal reporting components such as a cache, as well as to third-party tools. | ||
| The reporting features will enable the population and updating of views and data concerning workflow composition and its dynamic execution results. This data can be transmitted to SOARCA internal reporting components such as a cache, as well as to third-party tools (see [connectors](#connectors)). |
Collaborator
There was a problem hiding this comment.
Also this link doesn't work I think it needs to be
Suggested change
| The reporting features will enable the population and updating of views and data concerning workflow composition and its dynamic execution results. This data can be transmitted to SOARCA internal reporting components such as a cache, as well as to third-party tools (see [connectors](#connectors)). | |
| The reporting features will enable the population and updating of views and data concerning workflow composition and its dynamic execution results. This data can be transmitted to SOARCA internal reporting components such as a cache, as well as to third-party tools (see [connectors](#connectors-and-3--tools-reporting)). |
| @@ -14,13 +14,13 @@ SOARCA utilizes push-based reporting to provide information on the instantiation | |||
|
|
|||
Collaborator
There was a problem hiding this comment.
Maybe we should add a paragraph of flow diagram that explains the asynchronous nature of reporting.
lucamrgs
temporarily deployed
to
development-pages
GitHub Actions
Inactive
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
No description provided.