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

Improvements of the hooks documentation #11

Open
c8y3 opened this issue Jan 13, 2023 · 0 comments
Open

Improvements of the hooks documentation #11

c8y3 opened this issue Jan 13, 2023 · 0 comments

Comments

@c8y3
Copy link
Contributor

c8y3 commented Jan 13, 2023

These remarks all concern the documentation page on hooks (https://docs.dfir-iris.org/development/hooks/):

  • Method register_hooks is mentioned in this page, but it is only explained later in the Processor modules page (https://docs.dfir-iris.org/development/modules/quick_start/processor/). I suggest to move the documentation page on hooks down in the Modules section and after the Quick Start
  • rather than one table with all hooks, it would maybe be more readable to have three lists of hooks: postload, manual and preload
  • could you please add a column in the hooks table to document the specific type of data that method hooks_handler will be called with for each hook? This is an import part of the contract between modules code and IRIS.

Thank you.

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

No branches or pull requests

1 participant