diff --git a/.github/workflows/release-zenodo-deposit.yml b/.github/workflows/release-zenodo-deposit.yml index 074caed0..1ff3999c 100644 --- a/.github/workflows/release-zenodo-deposit.yml +++ b/.github/workflows/release-zenodo-deposit.yml @@ -41,7 +41,7 @@ jobs: - name: Create a draft on Zenodo # uses: zenodraft/action@0.10.0 - uses: korvoj/zenodraft-action@main + uses: korvoj/zenodraft-action@clarin-fix env: GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} # ZENODO_SANDBOX_ACCESS_TOKEN: ${{ secrets.ZENODO_SANDBOX_ACCESS_TOKEN }} diff --git a/.zenodo.json b/.zenodo.json index 683146ac..080828d3 100644 --- a/.zenodo.json +++ b/.zenodo.json @@ -38,9 +38,9 @@ "FAIR quality assessment" ], "license": "CC-BY-4.0", - "publication_date": "2024-09-20", + "publication_date": "2024-10-01", "title": "FAIR-by-Design training for the CLARIN community", - "version": "1.0.0", + "version": "1.0.1", "upload_type": "lesson", "communities": [ { diff --git a/CITATION.cff b/CITATION.cff index 45566de2..b7e900e7 100644 --- a/CITATION.cff +++ b/CITATION.cff @@ -33,9 +33,9 @@ abstract: >- introduces the CLARIN community to the FAIR-by-Design Methodology, which provides a systematic approach that embeds the FAIR principles into the backward instructional design process. -version: 1.0.0 -doi: 10.5281/zenodo.13816183 -date-released: '2024-09-20' +version: 1.0.1 +doi: 10.5281/zenodo.13867278 +date-released: '2024-10-01' license: CC-BY-4.0 license-url: https://creativecommons.org/licenses/by/4.0/legalcode.txt keywords: diff --git a/RELEASE_NOTES.md b/RELEASE_NOTES.md index 904c5abd..2a9e6f29 100644 --- a/RELEASE_NOTES.md +++ b/RELEASE_NOTES.md @@ -5,4 +5,9 @@ - This is the initial version of the training materials used for the virtual training on the FAIR-by-Design Methodology adapted to the CLARIN community. - \ No newline at end of file +## 1.0.1 (2024-10-01) + +- New release with very small typos and technical fixes in some of the slides +- Updated formulas in the QA.xlsx document that provides practical use of the quality assurance checklists + + diff --git a/linkset.json b/linkset.json index 85f564ed..406de631 100644 --- a/linkset.json +++ b/linkset.json @@ -1 +1 @@ -{"linkset": [{"anchor": "https://fair-by-design-methodology.github.io/clarin-training/latest/", "type": [{"href": "https://schema.org/LearningResource"}, {"href": "https://schema.org/AboutPage"}], "author": [{"href": "https://orcid.org/0000-0003-0034-2855"}, {"href": "https://orcid.org/0000-0001-7271-6655"}, {"href": "https://orcid.org/0000-0002-8126-6294"}, {"href": "https://orcid.org/0000-0003-3828-0135"}, {"href": "https://orcid.org/0000-0002-0736-0311"}], "item": [{"href": "https://github.com/FAIR-by-Design-Methodology/CLARIN-Training/blob/main/resources/syllabus.md", "type": "text/markdown"}, {"href": "https://github.com/FAIR-by-Design-Methodology/CLARIN-Training/blob/main/resources/index.md", "type": "text/markdown"}, {"href": "https://github.com/FAIR-by-Design-Methodology/CLARIN-Training/blob/main/resources/1st%20Session/04%20Metadata/04_plan.md", "type": "text/markdown"}, {"href": "https://github.com/FAIR-by-Design-Methodology/CLARIN-Training/blob/main/resources/1st%20Session/04%20Metadata/Metadata%20and%20Controled%20Vocabularies.md", "type": "text/markdown"}, {"href": "https://github.com/FAIR-by-Design-Methodology/CLARIN-Training/blob/main/resources/1st%20Session/07%20Citing%20and%20attribution/07_plan.md", "type": "text/markdown"}, {"href": "https://github.com/FAIR-by-Design-Methodology/CLARIN-Training/blob/main/resources/1st%20Session/07%20Citing%20and%20attribution/Citing%20and%20attribution.md", "type": "text/markdown"}, {"href": "https://github.com/FAIR-by-Design-Methodology/CLARIN-Training/blob/main/resources/1st%20Session/03%20FAIR-by-Design%20Methodology/03_plan.md", "type": "text/markdown"}, {"href": "https://github.com/FAIR-by-Design-Methodology/CLARIN-Training/blob/main/resources/1st%20Session/03%20FAIR-by-Design%20Methodology/FAIR-by-Design_content.md", "type": "text/markdown"}, {"href": "https://github.com/FAIR-by-Design-Methodology/CLARIN-Training/blob/main/resources/1st%20Session/02%20Skills4EOSC/About%20Skills4EOSC.md", "type": "text/markdown"}, {"href": "https://github.com/FAIR-by-Design-Methodology/CLARIN-Training/blob/main/resources/1st%20Session/08%20Hands-on/hands-on.md", "type": "text/markdown"}, {"href": "https://github.com/FAIR-by-Design-Methodology/CLARIN-Training/blob/main/resources/1st%20Session/08%20Hands-on/08_plan.md", "type": "text/markdown"}, {"href": "https://github.com/FAIR-by-Design-Methodology/CLARIN-Training/blob/main/resources/1st%20Session/08%20Hands-on/Activities/hands-on_details.md", "type": "text/markdown"}, {"href": "https://github.com/FAIR-by-Design-Methodology/CLARIN-Training/blob/main/resources/1st%20Session/06%20Rich%20learning%20exp/06_plan.md", "type": "text/markdown"}, {"href": "https://github.com/FAIR-by-Design-Methodology/CLARIN-Training/blob/main/resources/1st%20Session/06%20Rich%20learning%20exp/Rich%20learning%20experience.md", "type": "text/markdown"}, {"href": "https://github.com/FAIR-by-Design-Methodology/CLARIN-Training/blob/main/resources/1st%20Session/09%20Wrap-up/wrap-up.md", "type": "text/markdown"}, {"href": "https://github.com/FAIR-by-Design-Methodology/CLARIN-Training/blob/main/resources/1st%20Session/01%20CLARIN/About%20CLARIN.md", "type": "text/markdown"}, {"href": "https://github.com/FAIR-by-Design-Methodology/CLARIN-Training/blob/main/resources/1st%20Session/05%20Facilitator%20kit/05_plan.md", "type": "text/markdown"}, {"href": "https://github.com/FAIR-by-Design-Methodology/CLARIN-Training/blob/main/resources/1st%20Session/05%20Facilitator%20kit/Facilitator%20kit.md", "type": "text/markdown"}, {"href": "https://github.com/FAIR-by-Design-Methodology/CLARIN-Training/blob/main/resources/facilitator_guide.md", "type": "text/markdown"}, {"href": "https://github.com/FAIR-by-Design-Methodology/CLARIN-Training/blob/main/resources/Feedback/training_feedback.md", "type": "text/markdown"}, {"href": "https://github.com/FAIR-by-Design-Methodology/CLARIN-Training/blob/main/resources/2nd%20Session/02%20Version%20control/version_plan.md", "type": "text/markdown"}, {"href": "https://github.com/FAIR-by-Design-Methodology/CLARIN-Training/blob/main/resources/2nd%20Session/02%20Version%20control/Version%20control.md", "type": "text/markdown"}, {"href": "https://github.com/FAIR-by-Design-Methodology/CLARIN-Training/blob/main/resources/2nd%20Session/07%20Hands-on/07_plan.md", "type": "text/markdown"}, {"href": "https://github.com/FAIR-by-Design-Methodology/CLARIN-Training/blob/main/resources/2nd%20Session/07%20Hands-on/hands-on.md", "type": "text/markdown"}, {"href": "https://github.com/FAIR-by-Design-Methodology/CLARIN-Training/blob/main/resources/2nd%20Session/07%20Hands-on/Activities/hands-on_details.md", "type": "text/markdown"}, {"href": "https://github.com/FAIR-by-Design-Methodology/CLARIN-Training/blob/main/resources/2nd%20Session/05%20Co-creation/Co-creation.md", "type": "text/markdown"}, {"href": "https://github.com/FAIR-by-Design-Methodology/CLARIN-Training/blob/main/resources/2nd%20Session/05%20Co-creation/co-creation_plan.md", "type": "text/markdown"}, {"href": "https://github.com/FAIR-by-Design-Methodology/CLARIN-Training/blob/main/resources/2nd%20Session/03%20Recognition/recognition_plan.md", "type": "text/markdown"}, {"href": "https://github.com/FAIR-by-Design-Methodology/CLARIN-Training/blob/main/resources/2nd%20Session/03%20Recognition/recognition.md", "type": "text/markdown"}, {"href": "https://github.com/FAIR-by-Design-Methodology/CLARIN-Training/blob/main/resources/2nd%20Session/01%20Recap/recap.md", "type": "text/markdown"}, {"href": "https://github.com/FAIR-by-Design-Methodology/CLARIN-Training/blob/main/resources/2nd%20Session/06%20Quallity%20assurance/QA_plan.md", "type": "text/markdown"}, {"href": "https://github.com/FAIR-by-Design-Methodology/CLARIN-Training/blob/main/resources/2nd%20Session/06%20Quallity%20assurance/quality_assurance.md", "type": "text/markdown"}, {"href": "https://github.com/FAIR-by-Design-Methodology/CLARIN-Training/blob/main/resources/2nd%20Session/04%20Publishing/publishing_plan.md", "type": "text/markdown"}, {"href": "https://github.com/FAIR-by-Design-Methodology/CLARIN-Training/blob/main/resources/2nd%20Session/04%20Publishing/Publishing%20considerations.md", "type": "text/markdown"}, {"href": "https://github.com/FAIR-by-Design-Methodology/CLARIN-Training/blob/main/resources/2nd%20Session/08%20Wrap-up/wrap-up.md", "type": "text/markdown"}, {"href": "https://github.com/FAIR-by-Design-Methodology/CLARIN-Training", "type": "text/html"}], "describedby": [{"href": "https://raw.githubusercontent.com/FAIR-by-Design-Methodology/CLARIN-Training/main/CITATION.cff", "type": "application/yaml", "profile": "https://citation-file-format.github.io/1.2.0/schema.json"}], "license": [{"href": "https://spdx.org/licenses/CC-BY-4.0.html"}], "related": [{"href": "https://doi.org/10.5281/zenodo.13816183", "type": "text/html"}]}]} \ No newline at end of file +{"linkset": [{"anchor": "https://fair-by-design-methodology.github.io/clarin-training/latest/", "type": [{"href": "https://schema.org/LearningResource"}, {"href": "https://schema.org/AboutPage"}], "author": [{"href": "https://orcid.org/0000-0003-0034-2855"}, {"href": "https://orcid.org/0000-0001-7271-6655"}, {"href": "https://orcid.org/0000-0002-8126-6294"}, {"href": "https://orcid.org/0000-0003-3828-0135"}, {"href": "https://orcid.org/0000-0002-0736-0311"}], "item": [{"href": "https://github.com/FAIR-by-Design-Methodology/CLARIN-Training/blob/main/resources/syllabus.md", "type": "text/markdown"}, {"href": "https://github.com/FAIR-by-Design-Methodology/CLARIN-Training/blob/main/resources/index.md", "type": "text/markdown"}, {"href": "https://github.com/FAIR-by-Design-Methodology/CLARIN-Training/blob/main/resources/1st%20Session/04%20Metadata/04_plan.md", "type": "text/markdown"}, {"href": "https://github.com/FAIR-by-Design-Methodology/CLARIN-Training/blob/main/resources/1st%20Session/04%20Metadata/Metadata%20and%20Controled%20Vocabularies.md", "type": "text/markdown"}, {"href": "https://github.com/FAIR-by-Design-Methodology/CLARIN-Training/blob/main/resources/1st%20Session/07%20Citing%20and%20attribution/07_plan.md", "type": "text/markdown"}, {"href": "https://github.com/FAIR-by-Design-Methodology/CLARIN-Training/blob/main/resources/1st%20Session/07%20Citing%20and%20attribution/Citing%20and%20attribution.md", "type": "text/markdown"}, {"href": "https://github.com/FAIR-by-Design-Methodology/CLARIN-Training/blob/main/resources/1st%20Session/03%20FAIR-by-Design%20Methodology/03_plan.md", "type": "text/markdown"}, {"href": "https://github.com/FAIR-by-Design-Methodology/CLARIN-Training/blob/main/resources/1st%20Session/03%20FAIR-by-Design%20Methodology/FAIR-by-Design_content.md", "type": "text/markdown"}, {"href": "https://github.com/FAIR-by-Design-Methodology/CLARIN-Training/blob/main/resources/1st%20Session/02%20Skills4EOSC/About%20Skills4EOSC.md", "type": "text/markdown"}, {"href": "https://github.com/FAIR-by-Design-Methodology/CLARIN-Training/blob/main/resources/1st%20Session/08%20Hands-on/hands-on.md", "type": "text/markdown"}, {"href": "https://github.com/FAIR-by-Design-Methodology/CLARIN-Training/blob/main/resources/1st%20Session/08%20Hands-on/08_plan.md", "type": "text/markdown"}, {"href": "https://github.com/FAIR-by-Design-Methodology/CLARIN-Training/blob/main/resources/1st%20Session/08%20Hands-on/Activities/hands-on_details.md", "type": "text/markdown"}, {"href": "https://github.com/FAIR-by-Design-Methodology/CLARIN-Training/blob/main/resources/1st%20Session/06%20Rich%20learning%20exp/06_plan.md", "type": "text/markdown"}, {"href": "https://github.com/FAIR-by-Design-Methodology/CLARIN-Training/blob/main/resources/1st%20Session/06%20Rich%20learning%20exp/Rich%20learning%20experience.md", "type": "text/markdown"}, {"href": "https://github.com/FAIR-by-Design-Methodology/CLARIN-Training/blob/main/resources/1st%20Session/09%20Wrap-up/wrap-up.md", "type": "text/markdown"}, {"href": "https://github.com/FAIR-by-Design-Methodology/CLARIN-Training/blob/main/resources/1st%20Session/01%20CLARIN/About%20CLARIN.md", "type": "text/markdown"}, {"href": "https://github.com/FAIR-by-Design-Methodology/CLARIN-Training/blob/main/resources/1st%20Session/05%20Facilitator%20kit/05_plan.md", "type": "text/markdown"}, {"href": "https://github.com/FAIR-by-Design-Methodology/CLARIN-Training/blob/main/resources/1st%20Session/05%20Facilitator%20kit/Facilitator%20kit.md", "type": "text/markdown"}, {"href": "https://github.com/FAIR-by-Design-Methodology/CLARIN-Training/blob/main/resources/facilitator_guide.md", "type": "text/markdown"}, {"href": "https://github.com/FAIR-by-Design-Methodology/CLARIN-Training/blob/main/resources/Feedback/training_feedback.md", "type": "text/markdown"}, {"href": "https://github.com/FAIR-by-Design-Methodology/CLARIN-Training/blob/main/resources/2nd%20Session/02%20Version%20control/version_plan.md", "type": "text/markdown"}, {"href": "https://github.com/FAIR-by-Design-Methodology/CLARIN-Training/blob/main/resources/2nd%20Session/02%20Version%20control/Version%20control.md", "type": "text/markdown"}, {"href": "https://github.com/FAIR-by-Design-Methodology/CLARIN-Training/blob/main/resources/2nd%20Session/07%20Hands-on/07_plan.md", "type": "text/markdown"}, {"href": "https://github.com/FAIR-by-Design-Methodology/CLARIN-Training/blob/main/resources/2nd%20Session/07%20Hands-on/hands-on.md", "type": "text/markdown"}, {"href": "https://github.com/FAIR-by-Design-Methodology/CLARIN-Training/blob/main/resources/2nd%20Session/07%20Hands-on/Activities/hands-on_details.md", "type": "text/markdown"}, {"href": "https://github.com/FAIR-by-Design-Methodology/CLARIN-Training/blob/main/resources/2nd%20Session/05%20Co-creation/Co-creation.md", "type": "text/markdown"}, {"href": "https://github.com/FAIR-by-Design-Methodology/CLARIN-Training/blob/main/resources/2nd%20Session/05%20Co-creation/co-creation_plan.md", "type": "text/markdown"}, {"href": "https://github.com/FAIR-by-Design-Methodology/CLARIN-Training/blob/main/resources/2nd%20Session/03%20Recognition/recognition_plan.md", "type": "text/markdown"}, {"href": "https://github.com/FAIR-by-Design-Methodology/CLARIN-Training/blob/main/resources/2nd%20Session/03%20Recognition/recognition.md", "type": "text/markdown"}, {"href": "https://github.com/FAIR-by-Design-Methodology/CLARIN-Training/blob/main/resources/2nd%20Session/01%20Recap/recap.md", "type": "text/markdown"}, {"href": "https://github.com/FAIR-by-Design-Methodology/CLARIN-Training/blob/main/resources/2nd%20Session/06%20Quallity%20assurance/QA_plan.md", "type": "text/markdown"}, {"href": "https://github.com/FAIR-by-Design-Methodology/CLARIN-Training/blob/main/resources/2nd%20Session/06%20Quallity%20assurance/quality_assurance.md", "type": "text/markdown"}, {"href": "https://github.com/FAIR-by-Design-Methodology/CLARIN-Training/blob/main/resources/2nd%20Session/04%20Publishing/publishing_plan.md", "type": "text/markdown"}, {"href": "https://github.com/FAIR-by-Design-Methodology/CLARIN-Training/blob/main/resources/2nd%20Session/04%20Publishing/Publishing%20considerations.md", "type": "text/markdown"}, {"href": "https://github.com/FAIR-by-Design-Methodology/CLARIN-Training/blob/main/resources/2nd%20Session/08%20Wrap-up/wrap-up.md", "type": "text/markdown"}, {"href": "https://github.com/FAIR-by-Design-Methodology/CLARIN-Training", "type": "text/html"}], "describedby": [{"href": "https://raw.githubusercontent.com/FAIR-by-Design-Methodology/CLARIN-Training/main/CITATION.cff", "type": "application/yaml", "profile": "https://citation-file-format.github.io/1.2.0/schema.json"}], "license": [{"href": "https://spdx.org/licenses/CC-BY-4.0.html"}], "related": [{"href": "https://doi.org/10.5281/zenodo.13867278", "type": "text/html"}]}]} \ No newline at end of file diff --git a/mkdocs.yml b/mkdocs.yml index 6f11a808..dd2edd22 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -83,8 +83,8 @@ citation: affiliation: CLARIN title: "FAIR-by-Design training for the CLARIN community" abstract: "When developing learning materials, it is essential to ensure they are FAIR (Findable, Accessible, Interoperable, and Reusable) from both the learners' and trainers' perspectives. Therefore, integrating FAIR principles into the development of learning materials is a crucial element. This training introduces the CLARIN community to the FAIR-by-Design Methodology, which provides a systematic approach that embeds the FAIR principles into the backward instructional design process." - version: 1.0.0 - doi: 10.5281/zenodo.13816183 + version: 1.0.1 + doi: 10.5281/zenodo.13867278 date-released: "2024" license: CC-BY-4.0 license-url: "https://creativecommons.org/licenses/by/4.0/legalcode.txt" @@ -95,7 +95,7 @@ citation: - FAIR instructional design - FAIR quality assessment repository: "https://github.com/FAIR-by-Design-Methodology/CLARIN-Training" -signposting_linkset: https://raw.githubusercontent.com/FAIR-by-Design-Methodology/CLARIN-Training/main/linkset.json # do not update manually +signposting_linkset: https://raw.githubusercontent.com/FAIR-by-Design-Methodology/CLARIN-Training/1.0.1/linkset.json # do not update manually signposting_default_profile: '' # update with an URL towards the profile used for the Markdown pages (optional) # signposting_gitbook_url: https://gitbook.example.com # leave commented (prefixed with `#`) if using GitHub Pages with the default domain. signposting_exclusions: diff --git a/resources/syllabus.md b/resources/syllabus.md index 8061ee28..88f0b999 100644 --- a/resources/syllabus.md +++ b/resources/syllabus.md @@ -18,7 +18,7 @@ abstract: "When developing learning materials, it is essential to ensure they ar primaryLanguage: "EN" license: "http://creativecommons.org/licenses/by/4.0/" versionDate: "2024-09-19" -urlToResource: "https://doi.org/10.5281/zenodo.13816183" +urlToResource: "https://doi.org/10.5281/zenodo.13867278" resourceURLType: "URL" targetGroup: "Training materials designers, Training workflow and infrastructure managers" learningResourceType: "GitBook" @@ -154,7 +154,7 @@ Sonja Filiposka[![ORCID logo](./attachments/orcid_16x16.webp)](https://orcid.org ## DOI -[https://doi.org/10.5281/zenodo.13816183](https://doi.org/10.5281/zenodo.13816183) +[https://doi.org/10.5281/zenodo.13867278](https://doi.org/10.5281/zenodo.13867278) ## Accessibility Mission