Add FAIR tutorial guidelines#69
Closed
andresTabiTuwien wants to merge 109 commits into
Closed
Conversation
Due to inconsistent naming
Added missing underscore
Fixed indentation
adding tutorials related to executing tests
Move John's "create-benchmark.rst" content to here.
Fair tutorial guidelines
Removed references to ShEX and SHACL files for FTR validation.
* Tutorial section for FAIR commons * fix name for a cessda file * Rename discover-test-CESSDA-benchmark.rst to discover-test-cessda-benchmark.rst * First drafts * Fixed missing reference Due to inconsistent naming * Fixed typo * Update create-test-following-ftr.rst Added missing underscore * Fixed build errors * Update define-run-scoring-algorithm.rst Fixed indentation * Update define-run-scoring-algorithm.rst * adding tutorials related to executing tests * adding tutorials related to installing Champion * cleaning up errors * Update create-metric.rst * Update create-metric.rst * Update create-metric.rst * Update create-metric.rst * Update create-metric.rst * Update create-metric.rst * Create define-benchmark-associated-metrics.rst * Update define-benchmark-associated-metrics.rst Move John's "create-benchmark.rst" content to here. * Update create-benchmark.rst * Update and rename create-benchmark.rst to register-benchmark.rst * Update register-benchmark.rst * Update register-benchmark.rst * Update register-benchmark.rst * Update and rename create-metric.rst to register-metric.rst * Update register-benchmark.rst * Update register-metric.rst * Create find-metrics-and-benchmarks.rst * Delete docs/commons/fair/tutorials/register-curate-metric-fs.rst * Update register-metric.rst * Update register-metric.rst * Update register-metric.rst * Update find-metrics-and-benchmarks.rst * Update find-metrics-and-benchmarks.rst * Update find-test-for-digital-object.rst * Update find-test-for-digital-object.rst * Update register-metric.rst * Update find-test-for-digital-object.rst * Update find-test-for-digital-object.rst * Update find-metrics-and-benchmarks.rst * Update register-metric.rst * Update register-benchmark.rst * Update tutorial-index.rst * Update define-benchmark-associated-metrics.rst * How to comply with FTR tutorial created (#50) * Update define-benchmark-associated-metrics.rst clarified text on how to register benchmarks and metrics * Update register-metric.rst updated broken html and made it clearer when to use FAIR wizard and when to use FAIRsharing directly * add Assessment Tools subsection * Add Assessment Tools section to index.rst * Add Assessment Tools to documentation index * update content Updated the assessment tools documentation to include links to FAIR tests. * Create DMP-tests.rst Add links to DMP Tests documentation. * Add testing platforms documentation * Update index.rst * Update index.rst * up * Add assessment tools documentation * Update caption for assessment tools in documentation * Add links to DMP Tests documentation Added links to the DMP Tests documentation. * Update and rename FAIR-tests.rst to fair-tests.rst * Update dmp-tests.rst * Update testing-platforms.rst * add .. _tool-fairos: Added introductory information about the FAIROS tool and its purpose. * Update references in testing-platforms.rst * Update references in testing-platforms.rst * Fix formatting of testing platforms documentation * Update testing platforms documentation Removed references to fairos and foops from testing platforms documentation. * Add links to additional testing platforms * Update fair-tests.rst * Add links to DMP Tests documentation Added links to the DMP Tests documentation. * Document testing platforms for FAIR assessments Added a note about platforms for running FAIR assessments. * fix: correct RST structure and remove stub pages in FAIR tutorials * getting readyfor automated RTD * Toolbox section and life FAIR tests widget * Toolbox section: live FAIR test catalogue, deliverable title, open-in-new-tab links; bump to 0.2.0 * Toolbox section: live FAIR test catalogue, deliverable title, open-in-new-tab links; bump to 0.2.0 * restructure all pages to put deliverables in one place; added benchmarks and algorithms * update changelog --------- Co-authored-by: John Shepherdson <107628491+john-shepherdson@users.noreply.github.com> Co-authored-by: markwilkinson <mark.wilkinson@upm.es> Co-authored-by: saracuriel <144734028+saracuriel@users.noreply.github.com> Co-authored-by: esgg <eg.guardia@gmail.com> Co-authored-by: Allyson Lister <allyson.lister@oerc.ox.ac.uk> Co-authored-by: Mark Wilkinson <markw@illuminae.com>
Resolves conflicts in favor of this branch's newer tools/ restructuring (conceptual/, code/, apis/ split) while keeping upstream's docutils fixes for the FAIR tutorials (blank lines, code-block directives, non-colliding cross-reference labels, corrected :doc: targets). Also fixes remaining broken references left over from the local restructuring: stale tools/skg toctree entry, apis/openaire -> apis/openaire-graph, tools/code/fair-tests.rst's :doc: target, and commons/fair/fair-test-results-vocabulary-ftr.rst's ftr-validator reference (needed a root-relative path). Cleans up duplicate hyperlink-target warnings and two short title underlines. Build is now warning-free (sphinx-build -E): 0 warnings, 0 errors. Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
Also corrects conf.py's release string, which had drifted a version behind the CHANGELOG (stuck at 0.2.0 while CHANGELOG already listed 0.3.0). Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
…d restructured all menus to be hierarchical. Modified a bit of documentation. Assistance from Claude Code
Documents the remaining work under the still-unreleased 0.4.0 entry: five new section pages that make the Toolbox sidebar properly hierarchical, page-title fixes for two toctree-only pages that were silently flattening a level of nesting, and several content corrections (duplicate authoring.rst entry, wrong FAIRassist search param, capitalization, validator retitle). Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
…nto saracuriel-Deliverable3-3
Collaborator
Author
|
Hi @MarekSuchanek, here is the PR for all the info that Mark required for the deliverable. |
MarekSuchanek
approved these changes
Jul 9, 2026
Member
|
It seems that the revert does not help... so I will remove 2 commits from next and then this should be OK again. Do we want to squash this (and there will be no additional PRs from this branch anymore) or rather use normal merge with all commits? @andresTabiTuwien |
Collaborator
Author
|
I would prefer to do the squash and merge and not receive more PRs from that branch or branch with that one as a base in the future. |
MarekSuchanek
added a commit
that referenced
this pull request
Jul 12, 2026
Co-Authored-By: Andres Tabima <andres.romero@tuwien.ac.at> Co-Authored-By: John Shepherdson <107628491+john-shepherdson@users.noreply.github.com> Co-Authored-By: markwilkinson <mark.wilkinson@upm.es> Co-Authored-By: saracuriel <144734028+saracuriel@users.noreply.github.com> Co-Authored-By: esgg <eg.guardia@gmail.com> Co-Authored-By: Allyson Lister <allyson.lister@oerc.ox.ac.uk> Co-Authored-By: Mark Wilkinson <markw@illuminae.com> Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
Member
|
Squash-merged manually via |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
7 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
No description provided.