Skip to content

Commit c361138

Browse files
a-mileelichad
andauthored
Apply suggestions from code review
Co-authored-by: Eli Chadwick <[email protected]>
1 parent 3a9ca6c commit c361138

File tree

4 files changed

+30
-8
lines changed

4 files changed

+30
-8
lines changed

episodes/03-root.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ If the crate is being served from a Web service,
4242
such as a data repository or database where files are not organized in folders,
4343
then the `@id` might be an absolute URI instead of `./`
4444
-- this is one reason why we point to the root entity from the metadata descriptor,
45-
see section [Root Data Entity](https://www.researchobject.org/ro-crate/specification/1.2/root-data-entity.html) for details.
45+
as you will see in the next section.
4646
::::::::::::::::::::::::::::::::::::::::::::::::::
4747

4848
:::::::::::::::::::::::::::::::::::::::: challenge
@@ -68,8 +68,7 @@ see section [Root Data Entity](https://www.researchobject.org/ro-crate/specifica
6868

6969
The root has several metadata properties that describe the RO-Crate as a whole,
7070
considering it as a Research Object of collected resources.
71-
The section on [root data entity](https://www.researchobject.org/ro-crate/specification/1.2/root-data-entity.html)
72-
details further the required and recommended properties of the root `./`.
71+
In the next section we will cover the required and recommended properties of the root `./`.
7372

7473
:::::::::::::::::::::::::::::::::::::::: keypoints
7574
- The RO-Crate Root is the top-level object of the RO-Crate

episodes/06-cross-references.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ exercises: 4
99
::::::::::::::::::::::::::::::::::::::::::::::::::
1010

1111
:::::::::::::::::::::::::::::::::::::::: objectives
12-
- Understand cross-references in RO Crate
12+
- Understand cross-references in RO-Crate
1313
- Add a data entity reference from the root entity
1414
::::::::::::::::::::::::::::::::::::::::::::::::::
1515

episodes/08-contextual-entities.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,7 @@ A contextual entity might describe:
2424
- The software that processed the data
2525
- The instrument that captured it
2626
- The project that funded it
27+
- The people that contributed to creating it
2728

2829
These entities don’t contain data themselves but give semantic context to the data you’re describing.
2930

episodes/14-common-pitfalls.md

Lines changed: 26 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -46,14 +46,14 @@ Creating RO-Crate packages by hand is a great way to understand their structure,
4646
### 3. Using nested JSON instead of flat structure
4747

4848
- **Problem**: Embedding full descriptions of related entities instead of referencing them with `@id`.
49-
- **Fix**: Use cross-referencing. Define each entity once and refer to it using its `@id`.
49+
- **Fix**: Use cross-referencing. Define each entity once in the `@graph` array and refer to it using its `@id`.
5050

5151
### 4. Repeating or mismatched @id values
52-
- **Problem**: Accidentally defining two entities with the same @id, or referencing an entity with an @id that doesn’t exist.
53-
- **Fix**: Ensure every @id is unique and points to an entity defined in the metadata.
52+
- **Problem**: Accidentally defining two entities with the same @id, or referencing an entity with an @id that doesn’t exist in the `@graph`.
53+
- **Fix**: Ensure every @id is unique and cross-references point to an entity defined in the metadata.
5454

5555
### 5. Forgetting required metadata on key entities
56-
- **Problem**: The root dataset doesn’t have name or license, or files are missing type.
56+
- **Problem**: The root dataset doesn’t have `name` or `license`, or files are missing `@type`.
5757
- **Fix**: Always include the required fields for the root (./) and for files:
5858
```json
5959
{
@@ -93,6 +93,28 @@ Here's an incorrect metadata example. Identify and fix the issues.
9393
5. Missing required properties (description, datePublished, license) on the root dataset.
9494
::::::::::::::::::::::::::::::::::::::::
9595

96+
## RO-Crate validation tools
97+
98+
The [RO-Crate Playground](https://ro-crate.ldaca.edu.au) and the [rocrate-validator](https://rocrate-validator.readthedocs.io/en/latest/) Python package can both be used to check for errors in your RO-Crate metadata. Each of them performs a different set of checks.
99+
100+
:::::::::::::::::::::::::::::::::::::::: challenge
101+
102+
Copy and paste your completed JSON-LD into the [RO-Crate Playground](https://ro-crate.ldaca.edu.au), then click "Validate". Are there any issues?
103+
104+
::::::::::::::::::::::::::::::::::::::::
105+
106+
:::::::::::::::::::::::::::::::::::::::: challenge
107+
108+
Install the [rocrate-validator](https://rocrate-validator.readthedocs.io/en/latest/) and run it on the command line against your completed RO-Crate:
109+
110+
```
111+
rocrate-validator validate <path_to_rocrate>
112+
```
113+
114+
Are there any issues? Are the results different to the RO-Crate Playground?
115+
116+
::::::::::::::::::::::::::::::::::::::::
117+
96118
:::::::::::::::::::::::::::::::::::::::: keypoints
97119
- Include a metadata descriptor with @id: "ro-crate-metadata.json" and @type: "CreativeWork"
98120
- Ensure each referenced @id is also defined as an entity in @graph

0 commit comments

Comments
 (0)