Skip to content

Commit

Permalink
Merge branch 'nfdi4cat:main' into main
Browse files Browse the repository at this point in the history
  • Loading branch information
nmoust authored Aug 26, 2024
2 parents 95a08d2 + 2bf0185 commit b785cbc
Show file tree
Hide file tree
Showing 11 changed files with 259 additions and 2 deletions.
6 changes: 5 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -101,14 +101,18 @@ Finally, when the proposed pull request is accepted, your changes will be integr
The vocabularies are stored in split form using one folder per vocabulary.
Each concept, collection and concept scheme is stored in a separate file using the ID-part of the IRI as file name.

See [inbox-excel-vocabs/README.md](inbox-excel-vocabs/README.md) for a minimal example how to test the submission process.
See [inbox-excel-vocabs/README.md](https://github.com/nfdi4cat/voc4cat/tree/main/inbox-excel-vocabs/README.md) for a minimal example how to test the submission process.

## How to suggest improvements to the tooling & template?

To discuss about the workflow for maintaining SKOS vocabularies based on this template, create an [voc4cat-template issue](https://github.com/nfdi4cat/voc4cat-template/issues).

To discuss about the tool that converts Excel to SKOS in GitHub-actions of this template, create an [voc4cat-tool issue](https://github.com/nfdi4cat/voc4cat-tool/issues).

## Documentation for voc4cat maintainers

We collect notes on some typical workflows for maintainers in the `docs`-folder, see [docs/README.txt](https://github.com/nfdi4cat/voc4cat/tree/main/docs/for_maintainers/README.md) for an overview.

## Contributors

For details see the Zenodo record.
Expand Down
5 changes: 5 additions & 0 deletions docs/for_maintainers/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# Documentation for voc4cat maintainers

_This may be integrated into a full sphinx/mkdocs-generated HTML documentation later._

- [Handling of ID-requests](/docs/for_maintainers/voc4cat%20maintenance%20-%20Handling%20of%20ID-requests.md)
142 changes: 142 additions & 0 deletions docs/for_maintainers/voc4cat maintenance - Handling of ID-requests.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,142 @@
# voc4cat maintenance - Handling of ID-requests

> This guide is for voc4cat maintainers.
To update or create ID-ranges for people use the following workflow.
It is written for using the git command line.

**Step 1**: Navigate to the folder on your computer with a local clone of the voc4cat-repo:

```cmd
C:\Users\dlinke\MyProg_local
λ cd gh-nfdi4cat\voc4cat
```

Make sure you are on the main branch. If not switch to the main branch with `git switch main`.

**Step 2**: Pull the latest changes into the local repo.

```cmd
C:\Users\dlinke\MyProg_local\gh-nfdi4cat\voc4cat(main -> origin)
λ git pull
remote: Enumerating objects: 33, done.
remote: Counting objects: 100% (33/33), done.
remote: Compressing objects: 100% (23/23), done.
remote: Total 33 (delta 10), reused 30 (delta 10), pack-reused 0
Unpacking objects: 100% (33/33), 100.81 KiB | 291.00 KiB/s, done.
From https://github.com/nfdi4cat/voc4cat
9d78e5a..d0f2cd7 main -> origin/main
+ f9c7ee0...01421a8 gh-pages -> origin/gh-pages (forced update)
Updating 9d78e5a..d0f2cd7
Fast-forward
vocabularies/voc4cat/0007018.ttl | 2 +-
vocabularies/voc4cat/0007101.ttl | 18 ++++++++++++++++++
(...)
```

**Step 3**: Create a feature branch with a reasonable name (here the IDs were requested in issue #79).

```cmd
C:\Users\dlinke\MyProg_local\gh-nfdi4cat\voc4cat(main -> origin)
λ git switch -c issue79-id-request
Switched to a new branch 'issue79-id-request'
```

**Step 4**: Open an editor and update the `idranges.toml` file based on the request.

```cmd
C:\Users\dlinke\MyProg_local\gh-nfdi4cat\voc4cat(issue79-id-request)
λ code .
```

**Step 5**: Push the changes to GitHub. This involves, adding the changed file, setting the remote branch and pushing the changes.

First it is a good idea to check the status of the git repository.

```cmd
C:\Users\dlinke\MyProg_local\gh-nfdi4cat\voc4cat(issue79-id-request)
λ git status
On branch issue79-id-request
Changes not staged for commit:
(use "git add <file>..." to update what will be committed)
(use "git restore <file>..." to discard changes in working directory)
modified: idranges.toml
no changes added to commit (use "git add" and/or "git commit -a")
```

If there is just `idrange.toml` changed (as expected) we proceed:

```cmd
C:\Users\dlinke\MyProg_local\gh-nfdi4cat\voc4cat(issue79-id-request)
λ git add idranges.toml
C:\Users\dlinke\MyProg_local\gh-nfdi4cat\voc4cat(issue79-id-request)
λ git commit -m "Add idrange for philippstangl"
[issue79-id-request c9f6770] Add idrange for philippstangl
1 file changed, 7 insertions(+)
C:\Users\dlinke\MyProg_local\gh-nfdi4cat\voc4cat(issue79-id-request)
λ git push --set-upstream origin issue79-id-request
Enumerating objects: 5, done.
Counting objects: 100% (5/5), done.
Delta compression using up to 4 threads
Compressing objects: 100% (3/3), done.
Writing objects: 100% (3/3), 395 bytes | 79.00 KiB/s, done.
Total 3 (delta 2), reused 0 (delta 0), pack-reused 0
remote: Resolving deltas: 100% (2/2), completed with 2 local objects.
remote:
remote: Create a pull request for 'issue79-id-request' on GitHub by visiting:
remote: https://github.com/nfdi4cat/voc4cat/pull/new/issue79-id-request
remote:
To https://github.com/nfdi4cat/voc4cat.git
* [new branch] issue79-id-request -> issue79-id-request
branch 'issue79-id-request' set up to track 'origin/issue79-id-request'.
C:\Users\dlinke\MyProg_local\gh-nfdi4cat\voc4cat(issue79-id-request -> origin)
```

**Step 6**: Create a pull request on GitHub.

To do this open the the [voc4cat-repo](https://github.com/nfdi4cat/voc4cat). GitHub will automatically offer you to create a PR from the branch just pushed.

You can also use the the link provided in the command line output.

**Step 7**: Accept the PR in GitHub GUI (needs approval by another developer/curator).

After the successful merge, delete the feature branch in the PR-page on GitHub (there is a button for it).

**Step 8**: Clean up your local repo.

Switch back to main in the local repo and pull the latest changes:

```cmd
C:\Users\dlinke\MyProg_local\gh-nfdi4cat\voc4cat(issue79-id-request)
λ git switch main
Switched to branch 'main'
Your branch is up to date with 'origin/main'.
C:\Users\dlinke\MyProg_local\gh-nfdi4cat\voc4cat(main -> origin)
λ git pull
remote: Enumerating objects: 5, done.
remote: Counting objects: 100% (5/5), done.
remote: Compressing objects: 100% (1/1), done.
remote: Total 3 (delta 2), reused 2 (delta 2), pack-reused 0
Unpacking objects: 100% (3/3), 409 bytes | 20.00 KiB/s, done.
From https://github.com/nfdi4cat/voc4cat
d0f2cd7..d634f60 main -> origin/main
Updating d0f2cd7..d634f60
Fast-forward
idranges.toml | 7 +++++++
1 file changed, 7 insertions(+)
```

Finally, you may want to delete the feature branch to keep your local repo clean.

```cmd
C:\Users\dlinke\MyProg_local\gh-nfdi4cat\voc4cat(main -> origin)
λ git branch -d issue79-id-request
warning: deleting branch 'issue79-id-request' that has been merged to
'refs/remotes/origin/issue79-id-request', but not yet merged to HEAD
Deleted branch issue79-id-request (was 7a74c4d).
```
14 changes: 14 additions & 0 deletions vocabularies/voc4cat/0000180.ttl
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
PREFIX dcterms: <http://purl.org/dc/terms/>
PREFIX skos: <http://www.w3.org/2004/02/skos/core#>
PREFIX xsd: <http://www.w3.org/2001/XMLSchema#>

<https://w3id.org/nfdi4cat/voc4cat_0000180>
a skos:Concept ;
dcterms:identifier "voc4cat_0000180"^^xsd:token ;
skos:definition "Entity with a concrete and physical nature."@en ;
skos:historyNote "0000-0002-6242-2167 Nikolaos G. Moustakas and 0000-0002-5898-1820 David Linke created the resource"@en ;
skos:inScheme <https://w3id.org/nfdi4cat/voc4cat_> ;
skos:prefLabel "physical entity"@en ;
skos:topConceptOf <https://w3id.org/nfdi4cat/voc4cat_> ;
.

14 changes: 14 additions & 0 deletions vocabularies/voc4cat/0000181.ttl
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
PREFIX dcterms: <http://purl.org/dc/terms/>
PREFIX skos: <http://www.w3.org/2004/02/skos/core#>
PREFIX xsd: <http://www.w3.org/2001/XMLSchema#>

<https://w3id.org/nfdi4cat/voc4cat_0000181>
a skos:Concept ;
dcterms:identifier "voc4cat_0000181"^^xsd:token ;
skos:definition "Any entity that cannot be located in space-time. E.g., mathematical entities, formal semantics elements, regions within dimensional spaces, ideas, conceptual models."@en ;
skos:historyNote "0000-0002-6242-2167 Nikolaos G. Moustakas and 0000-0002-5898-1820 David Linke created the resource"@en ;
skos:inScheme <https://w3id.org/nfdi4cat/voc4cat_> ;
skos:prefLabel "non-temporal abstract entity"@en ;
skos:topConceptOf <https://w3id.org/nfdi4cat/voc4cat_> ;
.

18 changes: 18 additions & 0 deletions vocabularies/voc4cat/0000182.ttl
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
PREFIX dcterms: <http://purl.org/dc/terms/>
PREFIX skos: <http://www.w3.org/2004/02/skos/core#>
PREFIX xsd: <http://www.w3.org/2001/XMLSchema#>

<https://w3id.org/nfdi4cat/voc4cat_0000182>
a skos:Concept ;
dcterms:identifier "voc4cat_0000182"^^xsd:token ;
skos:definition "Anything that has a temporal dimension, whether it is an instantaneous point in time, a duration, or a sequence of events."@en ;
skos:historyNote "0000-0002-6242-2167 Nikolaos G. Moustakas and 0000-0002-5898-1820 David Linke created the resource"@en ;
skos:inScheme <https://w3id.org/nfdi4cat/voc4cat_> ;
skos:narrower
<https://w3id.org/nfdi4cat/voc4cat_0000183> ,
<https://w3id.org/nfdi4cat/voc4cat_0000184> ,
<https://w3id.org/nfdi4cat/voc4cat_0000185> ;
skos:prefLabel "temporal abstract entity"@en ;
skos:topConceptOf <https://w3id.org/nfdi4cat/voc4cat_> ;
.

14 changes: 14 additions & 0 deletions vocabularies/voc4cat/0000183.ttl
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
PREFIX dcterms: <http://purl.org/dc/terms/>
PREFIX skos: <http://www.w3.org/2004/02/skos/core#>
PREFIX xsd: <http://www.w3.org/2001/XMLSchema#>

<https://w3id.org/nfdi4cat/voc4cat_0000183>
a skos:Concept ;
dcterms:identifier "voc4cat_0000183"^^xsd:token ;
skos:broader <https://w3id.org/nfdi4cat/voc4cat_0000182> ;
skos:definition "An occurrence or happening, marked by a specific point in time. Events can be observed, recorded, and may have an impact on the state of the system or entities involved."@en ;
skos:historyNote "0000-0002-6242-2167 Nikolaos G. Moustakas and 0000-0002-5898-1820 David Linke created the resource"@en ;
skos:inScheme <https://w3id.org/nfdi4cat/voc4cat_> ;
skos:prefLabel "events"@en ;
.

14 changes: 14 additions & 0 deletions vocabularies/voc4cat/0000184.ttl
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
PREFIX dcterms: <http://purl.org/dc/terms/>
PREFIX skos: <http://www.w3.org/2004/02/skos/core#>
PREFIX xsd: <http://www.w3.org/2001/XMLSchema#>

<https://w3id.org/nfdi4cat/voc4cat_0000184>
a skos:Concept ;
dcterms:identifier "voc4cat_0000184"^^xsd:token ;
skos:broader <https://w3id.org/nfdi4cat/voc4cat_0000182> ;
skos:definition "Temporal entities that have a duration and occur at specific points in time."@en ;
skos:historyNote "0000-0002-6242-2167 Nikolaos G. Moustakas and 0000-0002-5898-1820 David Linke created the resource"@en ;
skos:inScheme <https://w3id.org/nfdi4cat/voc4cat_> ;
skos:prefLabel "actions"@en ;
.

14 changes: 14 additions & 0 deletions vocabularies/voc4cat/0000185.ttl
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
PREFIX dcterms: <http://purl.org/dc/terms/>
PREFIX skos: <http://www.w3.org/2004/02/skos/core#>
PREFIX xsd: <http://www.w3.org/2001/XMLSchema#>

<https://w3id.org/nfdi4cat/voc4cat_0000185>
a skos:Concept ;
dcterms:identifier "voc4cat_0000185"^^xsd:token ;
skos:broader <https://w3id.org/nfdi4cat/voc4cat_0000182> ;
skos:definition "A series of temporal entities, like actions, events, changes, or functions that are not isolated but rather a connected sequence of activities. Processes often involve the transformation of inputs into outputs and can be conceptualized as workflows."@en ;
skos:historyNote "0000-0002-6242-2167 Nikolaos G. Moustakas and 0000-0002-5898-1820 David Linke created the resource"@en ;
skos:inScheme <https://w3id.org/nfdi4cat/voc4cat_> ;
skos:prefLabel "processes"@en ;
.

14 changes: 14 additions & 0 deletions vocabularies/voc4cat/0000186.ttl
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
PREFIX dcterms: <http://purl.org/dc/terms/>
PREFIX skos: <http://www.w3.org/2004/02/skos/core#>
PREFIX xsd: <http://www.w3.org/2001/XMLSchema#>

<https://w3id.org/nfdi4cat/voc4cat_0000186>
a skos:Concept ;
dcterms:identifier "voc4cat_0000186"^^xsd:token ;
skos:definition "A characteristic of an entity that is intrinsic to and cannot exist without the entity. E.g., properties, characteristics, qualities of things, states."@en ;
skos:historyNote "0000-0002-6242-2167 Nikolaos G. Moustakas and 0000-0002-5898-1820 David Linke created the resource"@en ;
skos:inScheme <https://w3id.org/nfdi4cat/voc4cat_> ;
skos:prefLabel "attributes"@en ;
skos:topConceptOf <https://w3id.org/nfdi4cat/voc4cat_> ;
.

6 changes: 5 additions & 1 deletion vocabularies/voc4cat/concept_scheme.ttl
Original file line number Diff line number Diff line change
Expand Up @@ -12,14 +12,18 @@ PREFIX xsd: <http://www.w3.org/2001/XMLSchema#>
<https://w3id.org/nfdi4cat/voc4cat_0001900> ,
<https://w3id.org/nfdi4cat/voc4cat_0001901> ;
dcterms:identifier "voc4cat_"^^xsd:token ;
dcterms:modified "2024-05-10"^^xsd:date ;
dcterms:modified "2024-07-01"^^xsd:date ;
dcterms:publisher <https://w3id.org/nfdi4cat/> ;
owl:versionInfo "automatic" ;
skos:definition "A vocabulary for all areas of catalysis initiated in NFDI4Cat. Starting with photocatalysis we add more and more terms from other areas of catalysis and related disciplines like chemical engineering or materials science."@en ;
skos:hasTopConcept
<https://w3id.org/nfdi4cat/voc4cat_0000001> ,
<https://w3id.org/nfdi4cat/voc4cat_0000033> ,
<https://w3id.org/nfdi4cat/voc4cat_0000037> ,
<https://w3id.org/nfdi4cat/voc4cat_0000180> ,
<https://w3id.org/nfdi4cat/voc4cat_0000181> ,
<https://w3id.org/nfdi4cat/voc4cat_0000182> ,
<https://w3id.org/nfdi4cat/voc4cat_0000186> ,
<https://w3id.org/nfdi4cat/voc4cat_0005001> ,
<https://w3id.org/nfdi4cat/voc4cat_0005002> ,
<https://w3id.org/nfdi4cat/voc4cat_0005003> ,
Expand Down

0 comments on commit b785cbc

Please sign in to comment.