Skip to content

Commit

Permalink
Update vocabulary.rst (openMetadataInitiative#24)
Browse files Browse the repository at this point in the history
* Update vocabulary.rst

solves openMetadataInitiative#3

* Update vocabulary.rst

* Update vocabulary.rst

* Update vocabulary.rst

* Update vocabulary.rst
  • Loading branch information
lzehl authored Oct 22, 2024
1 parent 0d212b4 commit 0dd91eb
Showing 1 changed file with 19 additions and 2 deletions.
21 changes: 19 additions & 2 deletions docs/shared/contribution_guidelines/vocabulary.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,15 @@ Vocabulary

If you want to contribute to openMINDS by adding information to the openMINDS vocabulary we advise you to first review this chapter.

For each contribution, please raise an `ISSUE <https://github.com/openMetadataInitiative/openMINDS/issues>`_. Start the issue title with ``vocab: `` followed by an informative short title for your contribution. Please provide a more detailed explanation of your contribution in issue description. We will discuss your contribution with you before a pull request is made (by you or by us if you do not feel comfortable making a pull request yourself).
Schema types
############
The following code block sketches the vocabulary implementation for a single schema type:
In openMINDS, schema types are considered version independent, meaning the general information about a schema type remains the same across versions (e.g. its description). We maintain this schema type information centrally on the main openMINDS GitHub repository under: `vocab/types.json <https://github.com/openMetadataInitiative/openMINDS/blob/main/vocab/types.json>`_
In this JSON file, each vocabulary implementation for a single schema type is structured in the following way:
.. code-block:: json
Expand All @@ -26,10 +31,16 @@ The following code block sketches the vocabulary implementation for a single sch
}
}
.. note::
This file is auto-generated with each new schema commit on openMINDS. However, the attributes ``"color"``, ``"description"``, ``"label"``, and ``"semanticEquivalent"`` can be manually overwritten.

Properties
##########

The following code block sketches the vocabulary implementation for a single property:
In openMINDS, general information on properties (e.g., description) are considered schema and (mostly) version independent. We maintain this information centrally on the main openMINDS GitHub repository under: `vocab/properties.json <https://github.com/openMetadataInitiative/openMINDS/blob/main/vocab/properties.json>`_

In this JSON file, each vocabulary implementation for a single property is structured in the following way:

.. code-block:: json
Expand All @@ -44,7 +55,9 @@ The following code block sketches the vocabulary implementation for a single pro
},
"description": "PROPERTYNAME_DESCRIPTION",
"label": "PROPERTYLABEL",
"labelPlural": "PROPERTYLABEL",
"name": "PROPERTYNAME_SHORT",
"namePlural": "PROPERTYLABEL",
"semanticEquivalent": [
"UNIQUEID_OF_EQUIVALENT_PROPERTY"
],
Expand All @@ -55,3 +68,7 @@ The following code block sketches the vocabulary implementation for a single pro
}
}
}
.. note::

This file is auto-generated with each new commit on openMINDS. However, the attributes ``"description"``, ``"label"``, ``"labelPlural"``, ``"namePlural"``, and ``"semanticEquivalent"`` can be manually overwritten.

0 comments on commit 0dd91eb

Please sign in to comment.