Clarify some parts of the tutorial #6
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
It is a bit late to reminder users about this in chapter nine. We can do this the first time we add a new JSON object.
The concept of an array describing a Dataset and LearningResource is introduced early on but not reflected here in the tutorial. It then reappears in final RO-Crate Metadata Document.
Making sure users know that to get more out of the visualization they have to click on the resources makes sense here. Some may otherwise just look at the first result provided by the JSON-LD playground.
It's important to bring forward why we are doing something in a text. Some contextualizing information about the base URI is provided here and then it can be revisited in the conclusions of this episode.
elichad
approved these changes
Feb 5, 2025
|
Ah, I ran the checks forgetting they are broken. That's for me to fix - I'll go ahead and merge this :) |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Instructions
Thanks for contributing! ❤️
If this contribution is for instructor training, please email the link to this contribution to
[email protected] so we can record your progress. You've completed your contribution
step for instructor checkout by submitting this contribution!
Keep in mind that lesson maintainers are volunteers and it may take them some time to
respond to your contribution. Although not all contributions can be incorporated into the lesson
materials, we appreciate your time and effort to improve the curriculum. If you have any questions
about the lesson maintenance process or would like to volunteer your time as a contribution
reviewer, please contact The Carpentries Team at [email protected].
You may delete these instructions from your comment.
- The Carpentries
I found a few small tweaks that could be made in the tutorial to make it clearer for those building their solution while working through it, or to provide more context as to why folks might be doing something in particular.
I build and tested the site locally using the Makefile and it looked okay.
I have committed each change as a separate commit so that they can be reviewed independently of each other and cherry-picked via git if they are useful.
Thanks for this great resource, a very useful crash course for me today!