Skip to content

Improvements of the hooks documentation #11

Description

@c8y3

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.

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions