nfdi4plants / ARCCommander

Tool to manage your ARCs
MIT License
11 stars 9 forks source link

[Feature Request] Scattered arc commander tutorials #149

Closed Brilator closed 1 year ago

Brilator commented 2 years ago

We currently have three different arc commander tutorials with a bit of overlap.

  1. GH Wiki - Experimentalist user journey: https://github.com/nfdi4plants/arcCommander/wiki/Exemplary-scenario-–-Experimentalist-user-journey
  2. HP Deep dive: https://nfdi4plants.org/content/service/arccommander.html
  3. Knowledge Base Quick Start: https://nfdi4plants.org/nfdi4plants.knowledgebase/docs/tutorials/QuickStart_arc.html

I don't mean to keep only one and delete the others. All three have different perspectives and intentions and they're all valuable, e.g.

  1. Experimentalist journey: here's what you can do, if somebody hands you an ARC. (although, here the example could be aligned with the other more plant related example rather than zebra fish)
  2. Deep dive: those are the major commands, explore for your own ARC.
  3. Quickstart: If you exactly follow this hands-on, you have a working ARC.

However, for easier curation and more consistency I would suggest to merge or collect them at one place (my suggestion would be the knowledge base) and link from the previous places to there.

@Martin-Kuhl @HLWeil @omaus

Martin-Kuhl commented 2 years ago

I'm not sure if we really need the Deep dive in the future, as a well structured wiki (in the form of a docs page as discussed previously) and the QuickStart should be sufficient for most cases. Thus, it leads only to additinal workload in curating the page, as you already mentioned. Plus, I hope that we soon have a GUI so that we probably don't need to teach the command line anymore (more experienced users will be happy with a well structured wiki I guess).

I would go with:

Brilator commented 1 year ago

Last open task:

@CMR248

HLWeil commented 1 year ago

Fixed in https://github.com/nfdi4plants/nfdi4plants.github.io/commit/238038928dd6cff99add77b05cd06d8b15448a3d