Misc reminders about things that are missing in current doc

[MariellaCC]

This thread contains unstructured reminders to be able to keep track of potentially (to be discussed) missing elements in the current doc that came up via experimentation.

[MariellaCC]

In the extending kiara/creating modules doc https://dharpa.org/kiara.documentation/latest/extending_kiara/creating_modules/the_basics/ it may be useful to indicate that the following command is necessary for tests: pip install -e '.[dev_utils]' more details are included in #19

[MariellaCC]

For pipelines development: https://dharpa.org/kiara.documentation/latest/extending_kiara/pipelines/assemble_pipelines/ it may help to specify that it is necessary to enable DEV=true to display pipeline-related errors. Contrarily than with what happens with modules (where some errors appear without enabling this mode), errors don't seem to be displayed for pipelines without using DEV=true.

[makkus]

DEV=true is also useful for general Module development, but yes, more so when writing pipelines. Also, there is another option DEBUG=true which prints out even finer-grained log messages, which helps in some situations like a module/pipeline not appearing in kiara operation list etc.

[MariellaCC]

In the old documentation, in the "Creating a Kiara plugin project" section (https://dharpa.org/kiara.documentation/latest/extending_kiara/creating_modules/the_basics/#creating-a-kiara-plugin-project ), no info is available on how users can update the plugin template in case of changes in the dedicated repo https://github.com/DHARPA-Project/kiara_plugin.develop. At the moment there is no indication for users of how to be informed of important (or less important) updates, and how to update the template, and what level of skills is required for that.

[MariellaCC]

It may be useful for users to have a doc section explaining the automatic checks that are performed and document some cases that happen often (that make the tests fail).