search

ResearchObject / ro-crate-py

Python library for RO-Crate
https://pypi.org/project/rocrate/
Apache License 2.0
46 stars 23 forks source link

Avoid duplication of tutorial material #179

Closed elichad closed 5 months ago

elichad commented 5 months ago

The tutorial content in the README is very similar to the GTN tutorial for RO-Crate in Python, but they're a bit out of sync due to recent releases.

Having just put in a few updates to the GTN version (https://github.com/galaxyproject/training-material/pull/4850) (which I will also put into the README if needed), I think it'd be best to commit to maintaining and updating one or the other so they don't fall further out of sync. Personally I favour GTN so it's grouped with other RO-Crate tutorials.

elichad commented 5 months ago

It might be that we have to start splitting some of the documentation into basic and advanced material. E.g. the add_jsonld function is more of an advanced feature, because beginners probably won't know JSON-LD before starting with RO-Crate.

elichad commented 5 months ago

After some thought, I think it's okay to keep the parallel documentation for now. I think it's best to keep the GTN tutorial simple, and direct learners to the repo for more advanced features.

simleo commented 5 months ago

After some thought, I think it's okay to keep the parallel documentation for now. I think it's best to keep the GTN tutorial simple, and direct learners to the repo for more advanced features.

I agree. Though there is some overlap, an introductory tutorial is different in purpose from library documentation.