Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Avoid duplication of tutorial material #179

Closed
elichad opened this issue Mar 19, 2024 · 3 comments
Closed

Avoid duplication of tutorial material #179

elichad opened this issue Mar 19, 2024 · 3 comments
Labels
documentation Improvements or additions to documentation

Comments

@elichad
Copy link
Contributor

elichad commented Mar 19, 2024

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 (galaxyproject/training-material#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 elichad added the documentation Improvements or additions to documentation label Mar 19, 2024
@elichad
Copy link
Contributor Author

elichad commented Mar 19, 2024

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
Copy link
Contributor Author

elichad commented Mar 26, 2024

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
Copy link
Collaborator

simleo commented Mar 26, 2024

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.

@simleo simleo closed this as completed Mar 26, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

2 participants