vatlab/sos-docs

Define a reading-path of tutorials for new users

Closed this issue · 3 comments

We have over 80 tutorials which can be intimidating to new users. We should design some paths for users of different levels, something like:

  1. If you are new to SoS, start from 'this one', and follow the green trail from further reading, with topics such as A, B, C, D (with links)
  2. If you would like to know more, follow the blue trail from further reading, which topics such as A, B, C, D (with links).
gaow commented

Wouldnt it be easier to categorize the tutorial to beginner's, intermediate, upper intermediate and advanced levels, and organize material under each part?

that would separate each topic into different sections but perhaps not too bad.

gaow commented

that would separate each topic into different sections but perhaps not too bad.

certainly not each topic right? and if we are careful enough maybe we dont need to break any of those, depending on what you meant by beginner -- for example task on HPC is out of the scope for a beginner. Because one can use an interactive node and do lots of things already using SoS. For example, beginner's guide will be, I guess, able to write something like this in the end as the goal of it?

https://vatlab.github.io/sos-docs/doc/examples/WGS_Call.html

in this example one only needs to understand the process-oriented default flow of data, the f-string method, how to pass in parameters, how to derive input and output names to keep file naming conventions clear, how to run jobs in parallel and how to use docker images others have created.