Adapt zenodo metadata; improve and update READMEs

.zenodo.json

@@ -7,11 +7,16 @@
       "name": "Linke, David",
       "orcid": "0000-0002-5898-1820",
       "affiliation": "Leibniz Institute for Catalysis, Albert-Einstein-Str. 29 A, 18059 Rostock, Germany"
+    },
+    {
+      "name": "Moustakas, Nikolaos",
+      "orcid": "0000-0002-6242-2167",
+      "affiliation": "Leibniz Institute for Catalysis, Albert-Einstein-Str. 29 A, 18059 Rostock, Germany"
     }
   ],
-  "description": "<p>A repository template with workflows to maintain SKOS-vocabularies on GitHub as a community of for yourself.</p>\n\n<p>The workflows use the software <a href=\"https://github.com/nfdi4cat/voc4cat-tool/\">voc4cat-tool(</a> and GitHub features like pull requests, gh-actions, gh-pages etc. to reduce the maintenance workload for contributors and editors. The template has been developed as part of the <a href=\"http://www.nfdi4cat.org\">NFDI4Cat</a> initiative and is used for the SKOS-vocabulary for catalysis <a href=\"https://github.com/nfdi4cat/voc4cat/\"><b>voc4cat</b></a>.</p>",
+  "description": "<p><b>Voc4Cat</b> is a SKOS vocabulary for the catalysis disciplines.</p><p>The vocabulary was created in the <a href=\"http://www.nfdi4cat.org\">NFDI4Cat</a> initiative. The first collection of terms was published in June 2023 with a focus on photo catalysis. Our goal is to continuously extend the vocabulary to cover all subdisciplines of catalysis. The principles that we follow are summarized in the <a href=\"https://doi.org/10.5281/zenodo.7669182\">Voc4Cat Guidelines</a>.</p><p>If you want to help us building a catalysis vocabulary, please come to our GitHub repository. Everyone is welcome! We tried to make contributing easy: Download the current vocabulary as Excel file, make your edits and upload the modified file in a pull request.</p><p>The voc4cat repository is based on <a href=\"https://github.com/nfdi4cat/voc4cat-template/\">voc4cat-template</a>. The workflows use <a href=\"https://github.com/nfdi4cat/voc4cat-tool/\">voc4cat-tool</a> and GitHub features like pull requests, gh-actions, gh-pages etc. to minimize the workload for contributors and editors.</p>",
   "keywords": [
-    "SKOS", "vocabulary", "maintenance", "xlsx", "linked data", "rdf"
+    "SKOS", "vocabulary", "catalysis", "linked data", "rdf", "Excel"
   ],
   "license": "CC0-1.0",
   "related_identifiers": [
@@ -20,7 +25,13 @@
         "relation": "requires",
         "resource_type": "software",
         "scheme": "doi"
+    },
+    {
+      "identifier": "doi:10.5281/zenodo.8306845",
+      "relation": "hasPart",
+      "resource_type": "workflow",
+      "scheme": "doi"
     }
   ],
-  "upload_type": "workflow"
+  "upload_type": "software"
 }

README.md

@@ -3,8 +3,9 @@
 
 # A SKOS vocabulary for the catalysis disciplines
 
-> **The first collection of terms was just published (June-2023)**.
-> **We will add more content in the coming weeks and month.**
+> **The first collection of terms was published in June 2023.**
+> **Our goal is to grow the vocabulary to cover all subdisciplines of catalysis.**
+>**Please join if you like to help. Everyone is welcome!**
 
 The vocabulary has been created and maintained as part of the [NFDI4Cat](http://www.nfdi4cat.org) initiative and follows our [Voc4Cat Guidelines](https://doi.org/10.5281/zenodo.7669183).
 
@@ -13,13 +14,13 @@ It uses the [voc4cat-tool](https://github.com/nfdi4cat/voc4cat-tool) and GitHub
 
 ## Basic principles
 
-The process to contribute to the **voc4cat vocabulary** is as follows:
+We tried hard to make contributing easy. The process is essentially *(see further below for details)*:
 
-- get and update the vocabulary file (xlsx),
-- submit a pull request with the updated file,
-- collaborate on the pull request with editors or other github users,
+- Download the [most current vocabulary file (xlsx)](https://nfdi4cat.github.io/voc4cat/dev/voc4cat.xlsx),
+- Edit the vocabulary file in Excel,
+- Submit a pull request with the updated file placed in the folder `inbox-excel-vocabs`.<BR>It is important to keep the original file name `voc4cat.xlsx`.
 
-After approval your pull request is ready to be merged by the editors. The merge will include your contribution into the SKOS-vocabulary file in the `vocabularies`-folder. Upon merge the corresponding documentation and a joined turtle file will be automatically built and published to gh-pages.
+After approval your pull request is ready to be merged by the editors. The merge will integrate your contribution into the SKOS-vocabulary files in the `vocabularies`-folder. Upon merge the corresponding documentation and a joined turtle file will be automatically built and published to gh-pages.
 
 Besides this "in-developement" version of the vocabulary, the latest released version and older releases are also available.
 
@@ -79,7 +80,7 @@ Here are the steps for submitting updates in Excel.
   - or why the proposed change may not fit.
 - If you need to fix something update the pull request branch. This will trigger the pipeline to run again.
 
-Finally, when the proposed merge request is accepted, your changes will be integrated in the vocabularies in the folder `vocabularies`. 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.
+Finally, when the proposed pull request is accepted, your changes will be integrated in the vocabularies in the folder `vocabularies`. 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.
 
@@ -89,25 +90,27 @@ To discuss about the workflow for maintaining SKOS vocabularies based on this te
 
 To discuss about the tool that converts Excel to SKOS in gh-actions of this template, create an [voc4cat-tool issue](https://github.com/nfdi4cat/voc4cat-tool/issues).
 
-## Authors and acknowledgment
+## Contributors
 
-### Vocabularies
+For details see the Zenodo record.
 
-- *List all contributors.*
+**A big thanks to our GitHub contributors:**
 
-### Voc4cat template
+<a href="https://github.com/nfdi4cat/voc4cat/graphs/contributors">
+  <img src="https://contrib.rocks/image?repo=nfdi4cat/voc4cat" />
+</a>
 
-- David Linke (ORCID: 0000-0002-5898-1820) - Initial setup of repository and CI/CD pipelines
+*Figure made with [contrib.rocks](https://contrib.rocks).*
 
 ## License
 
 ### Vocabularies
 
-All vocabularies in this repository are CC0 licensed, see [LICENSE](LICENSE) for details.
+All vocabularies in this repository are CC0-1.0 licensed, see [LICENSE](LICENSE) for details.
 
 ### Voc4cat template
 
-The template itself is CC0 licensed, see [LICENSE](LICENSE). Although there is no obligation, we nevertheless appreciate if our work is acknowledged in any derivative work.
+The template itself is CC0-1.0 licensed, see [LICENSE](LICENSE). Although there is no obligation, we nevertheless appreciate if our work is acknowledged in any derivative work.
 
 ## Acknowledgement
 

inbox-excel-vocabs/README.md

@@ -1,11 +1,11 @@
-**Please drop your filled out Excel-templates into this folder and create a merge request.**
+**Please drop/add your updated Excel-file into this folder and create a pull request.**
 
 See also [../README.md](../README.md) for the steps in the contribution process.
 
-- Copy the file with your updates to this folder
-- Rename it to `voc4cat.xlsx`.
-- Add the file to git and submit a pull request.
-- If there is no validation error the vocabulary `vocabularies/voc4cat.ttl` is updated via gh-actions and committed to your pull request. The Excel file is removed from the pull request.
+- If required change the file name back to its original name `voc4cat.xlsx`.
+- Copy your file with the updates to this folder.
+- Add the file to git and submit a pull request. On GitHub the file can be added by dropping it to this folder.
+- If there are no validation errors the turtle files of the vocabulary in `vocabularies/voc4cat/` are updated via gh-actions and committed to your pull request. The Excel file is removed from the pull request.
 - If there are errors, you can examine them in the run log.
 - In any case (error or not) you can download the xlsx file along with a log-file and the generated documentation as [workflow artifact](https://docs.github.com/en/actions/managing-workflow-runs/downloading-workflow-artifacts).
-The xlsx-file in the artifact will be the updated one that is recreated from the updated turtle-file.
+The xlsx-file in the artifact will be an updated one that is either recreated from the updated turtle-files or (in case of errors) annotated.