janis icon indicating copy to clipboard operation
janis copied to clipboard

Feedback after reading tutorials

Open kinow opened this issue 4 years ago • 0 comments

Hello,

I learned about Janis yesterday after an e-mail sent to the AU/NZ RSE mailing list. Really interesting project, and the code is super organized, and the docs are beyond great! :clap:

The tutorials appeared to be super easy to follow, and I was really impressed when the first workflow ran without errors, and quite fast too.

This pull request includes typos, re-wording, and a couple places where the directory or command was incorrect (I will add notes to this PR).

The main change, I think, is the last commit. When I was in tutorial 1, I realized my ~/janis directory now had a mix of files that I could maintain, but most of them would have to be nuked if I wanted to keep it organized. However, tutorial 1 used janis-tutorials folder, keeping the newly created files isolated from the rest in ~/janis.

So the last commit is me trying to move all the tutorial data under ~/janis/janis-tutorials. It is similar to what you have with Cylc tutorials, or Airflow tutorials I think. Users may keep the tutorial files, or simply discard them by deleting ~/janis/janis-tutorials.

If this change is not really OK, I'd be happy to remove that part :+1:

Also, I found a couple places where the output or the text in the tutorial did not match with what I had in my computer, but I will look at existing issues and create new ones later if necessary.

Thanks again! Bruno

kinow avatar Jul 24 '21 06:07 kinow