[DOC]: Add section on "using" junifer #117

New issue

Closed

opened 2022-11-03 14:02:16 +00:00 by fraimondo · 0 comments

fraimondo commented

2022-11-03 14:02:16 +00:00

(Migrated from github.com)

Which element of the documentation do you want to modify and why?

Currently we have

Installing
Understanding
Pipeline steps
Extending (on #104)

So we expect readers to understand, see what junifer has, and extend, without using it?

We should add a new section between 2 and 3 that is kind of a tutorial on how to use junifer:

Codeless (YAML)
- Explain the YAML file
  - DataGrabber
  - Preprocess
  - Markers
  - Storage
  - Optional features:
    - custom modules
    - queue
- Use the YAML file (CLI)
Code (python): in a second PR/issue, not now

Anything else to say?

No response

### Which element of the documentation do you want to modify and why? Currently we have 1) Installing 2) Understanding 3) Pipeline steps 4) Extending (on #104) So we expect readers to understand, see what junifer has, and extend, without using it? We should add a new section between 2 and 3 that is kind of a tutorial on how to use junifer: * Codeless (YAML) * Explain the YAML file * DataGrabber * Preprocess * Markers * Storage * Optional features: * custom modules * queue * Use the YAML file (CLI) * Code (python): in a second PR/issue, not now ### Anything else to say? _No response_