[Improvement][WIP] Add subworkflow documentation

[ThoumyreStanislas]

Describe your changes

Say which test data are used by your module

Checklist before requesting a review

• Create the tool:
  • Edit ./modules/nf-scil/<category>/<tool>/main.nf
  • Edit ./modules/nf-scil/<category>/<tool>/meta.yml
• Generate the tests:
  • Edit ./tests/modules/nf-scil/<category>/<tool>/main.nf
  • Edit ./tests/modules/nf-scil/<category>/<tool>/nextflow.config
  • Add test data locally for tests with the fork repository
  • Generate the test infrastructure and md5sum for all outputs
• Ensure the syntax is correct :
  • Check indentation abides with the rest of the library (don't hesitate to correct others !)
  • Lint everything. Ensure your variables have good names.

[AlexVCaron]

Very nice work , all the content seems to be there ! I will try the steps to create a module before Thursday and get back to you. I would however like a slight reshoot over the text. There is a lot of verb tenses that switch throughout, that also make you switch subject a lot.

For example, you start with imperative tense at line 5, then switch at line 22. I would refrain using we altogether, and use only imperative and impersonal statements. It would make the tutorial flow better and look more like a list of steps to follow.

As for the tests documentation, I'll do a shot on that with Anthony on another PR, where he'll document nf-test. It'll go in another documentation file, we need to move some common things from MODULES.md as well. I'll work the PR and get back to you on how we integrate it here.

[AlexVCaron]

It's going on well. A few comments, then I think it'll be good to go ! We'll merge without the nf-test documentation inserted and add it in another PR, with the help of @gagnonanthony and some changes I have made to the remaining doc.

[AlexVCaron]

Last round of suggestions, then we should done with this one !

[AlexVCaron]

This is all good for me ! I'll let @gagnonanthony and @Manonedde go through one time and validate with their experience building wokrflows. Then, LGTM !

[gagnonanthony]

Great work! I made minor suggestions, but other than that, very nice! 💯

[gagnonanthony]

LGTM ! 🍻

[AlexVCaron]

GJ @ThoumyreStanislas 🥳