Summary

• Page properties (2 modified, 0 added, 0 removed)

Details

Page properties

Parent

...	...	@@ -1,1 +1,1 @@
1		-Collabs.openminds.Documentation on.WebHome
	1	+Collabs.openminds.Documentation.WebHome

Content

...	...	@@ -21,15 +21,39 @@
21	21	(% style="text-align: justify;" %)
22	22	For this to work smoothly for the existing, but also for all new openMINDS metadata models, the corresponding openMINDS submodules (GitHub repositories) have to meet the following requirements:
23	23
24		-(% style="text-align:justify" %)
25		-* The openMINDS metadata model has to be located on a **public GitHub repository** and published under an **MIT license**.
26		-* The GitHub repository should have at least one **version branch** (e.g., "v1").
27		-* The version branch should have the following **main directory folders**: **##schemas##** (required), **##tests##** (recommended),  **##examples##** (recommended), and **##img##** (optional).
28		-* The **##schemas##** folder should contain the schemas of that metadata model implemented in the **openMINDS schema template syntax** (cf. below). The directory of the schemas can be further structured or flat.
29		-* The **##tests##** folder should contain test-instances (JSON-LDs) for the schemas in a flat directory. The file names for these test-instances should follow the convention of **##<<XXX>>-<<YYY>>.jsonld##** for files that should pass the tests, and **##<<XXX>>-<<YYY>>-nok.jsonld##** for files that should fail the test. In both cases, **##<<XXX>>##** should be replaced with the label of the schema that is tested, and **##<<YYY>>##** with a user defined label for what aspect is tested (e.g., **##person-withoutCI.jsonld##**).
30		-* The **##examples##** folder should contain examples for valid instance collections for that metadata model. Each example should receive its own directory (folder) with a **##README.md##** describing the example, and an **##metadataCollection##** subfolder containing the openMINDS instances (JSON-LDs). This subfolder can be further structured to group related instances.
31		-* The **##img##** folder should contain image files used on that GitHub repository (e.g., the logo of the new openMINDS metadata model). The directory of the images can be further structured or flat.
	24	+(% style="text-align: justify;" %)
	25	+**(1)** The openMINDS metadata model has to be located on a **public GitHub repository** and published under an **MIT license**.
32	32
	27	+(% style="text-align: justify;" %)
	28	+**(2)** The GitHub repository should have at least one **version branch** (e.g., "v1").
	29	+
	30	+(% style="text-align: justify;" %)
	31	+**(3)** The version branch should have the following **main directory folders**: **##schemas##** (required), **##tests##** (recommended),  **##examples##** (recommended), and **##img##** (optional).
	32	+
	33	+(% style="text-align: justify;" %)
	34	+**(4)** The **##schemas##** folder should contain the schemas of that metadata model implemented in the **openMINDS schema template syntax** (cf. below). The directory of the schemas can be further structured or flat.
	35	+
	36	+(% style="text-align: justify;" %)
	37	+**(5)** The **##tests##** folder should contain test-instances (JSON-LDs) for the schemas in a flat directory. The file names for these test-instances should follow the convention of
	38	+
	39	+(% style="text-align: center;" %)
	40	+**##<<XXX>>-<<YYY>>.jsonld##**
	41	+
	42	+(% style="text-align: justify;" %)
	43	+for files that should pass the tests, and
	44	+
	45	+(% style="text-align: center;" %)
	46	+**##<<XXX>>-<<YYY>>-nok.jsonld##**
	47	+
	48	+(% style="text-align: justify;" %)
	49	+for files that should fail the test. In both cases, **##<<XXX>>##** should be replaced with the label of the schema that is tested, and **##<<YYY>>##** with a user defined label for what aspect is tested (e.g., **##person-withoutCI.jsonld##**).
	50	+
	51	+(% style="text-align: justify;" %)
	52	+**(6)** The **##examples##** folder should contain examples for valid instance collections for that metadata model. Each example should receive its own directory (folder) with a **##README.md##** describing the example, and an **##metadataCollection##** subfolder containing the openMINDS instances (JSON-LDs). This subfolder can be further structured or flat.
	53	+
	54	+(% style="text-align: justify;" %)
	55	+**(7)** The **##img##** folder should contain image files used on that GitHub repository (e.g., the logo of the new openMINDS metadata model). The directory of the images can be further structured or flat.
	56	+
33	33	=== The openMINDS vocabulary ===
34	34
35	35	(% style="text-align: justify;" %)
...	...	@@ -36,8 +36,23 @@
36	36	Through the integration pipeline of the openMINDS generator, the openMINDS vocabulary is automatically gathered and stored in the main openMINDS GitHub in order to centrally maintain general definitions and references for **types** and **properties** used in schemas across all openMINDS repositories. How this works is explained in the following.
37	37
38	38	(% style="text-align: justify;" %)
39		-Schema types and properties are stored in dedicated JSON files (**##types.json##** and **##properties.json##**) under the folder **##vocab##** located in the main openMINDS GitHub directory. Each schema type and property occurring in the openMINDS metadata models is automatically represented in those files as nested dictionaries.
	63	+Schema types and properties are stored in dedicated JSON files (**##types.json##** and **##properties.json##**) under the folder **##vocab##** located in the main openMINDS GitHub directory. Each schema type and property occurring in the openMINDS metadata models is automatically represented in those files as nested dictionaries. Here a cutout of the **##types.json##** and **##properties.json##**:
40	40
	65	+{{code language="json" title="Cutout of the openMINDS/vocab/types.json"}}
	66	+{
	67	+ ...,
	68	+ "https://openminds.ebrains.eu/core/Person": {
	69	+ "deprecated": false,
	70	+ "description": "Structured information on a person (alive or dead).",
	71	+ "name": "Person",
	72	+ "translatableTo": [
	73	+ "https://schema.org/Person"
	74	+ ]
	75	+ },
	76	+ ...
	77	+}
	78	+{{/code}}
	79	+
41	41	(% style="text-align: justify;" %)
42	42	The keywords of those nested dictionaries are pre-defined to consistently capture for all schema types and properties their namespace, their occurrence, their general description, and possible references to related or matching schema types and properties of other metadata initiatives (e.g., schema.org). This setup also allows us to define some values/entries to be automatically filled in by the openMINDS integration pipeline with each commit to one of the openMINDS repositories (e.g., the namespace and occurrence) and others to be manually editable later on (e.g., the general description and references).
43	43