Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
38 changes: 38 additions & 0 deletions .github/workflows/code-style.yml
Original file line number Diff line number Diff line change
Expand Up @@ -44,3 +44,41 @@ jobs:
run: |
flake8 docs --count --select=E9,F63,F7,F82 --show-source --statistics
flake8 docs --count --max-complexity=12 --max-line-length=130 --statistics

file-naming:
name: File Naming Convention
runs-on: ubuntu-latest
steps:
- name: Check out repository
uses: actions/checkout@v6

- name: Check docs file naming
run: |
echo "Checking documentation filenames…"

invalid_files=$(find docs \
-type f \( \
-name "*.rst" \
-o -name "*.png" \
-o -name "*.jpg" \
-o -name "*.jpeg" \
-o -name "*.svg" \
-o -name "*.gif" \
-o -name "*.tiff" \
\) \
| grep -Ev '^docs/_(static|templates)/' \
| grep -E '[A-Z_]' || true)

if [ -n "$invalid_files" ]; then
echo "❌ Invalid documentation filenames found:"
echo "$invalid_files"
echo ""
echo "Rules:"
echo " - lowercase only"
echo " - use '-' as separator"
echo " - no underscores '_'"
echo " - exception: docs/_static/** and docs/_templates/**"
exit 1
fi

echo "✅ Documentation filenames look good."
12 changes: 12 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,18 @@ If you find a bug in the documentation, please [open an issue](https://github.co

The documentation is hosted on Read-the-Docs and using standard Sphinx documentation. The documentation is written in reStructuredText (`.rst`) format. It can be compiled locally using Sphinx and viewed in a web browser.

### File Naming Convention

While it may not be clear at first, naming of documentation files is important for clarity and organization. It is also directly reflected in the URLs of the hosted documentation. Please follow these conventions when naming documentation files:

- Use lowercase letters.
- Use hyphens (`-`) to separate words. Do not use underscores (`_`).
- Avoid using special characters or spaces.
- Use descriptive names that reflect the content of the file.
- Do not change names of existing files unless absolutely necessary, as this may break links.

Adhering to these conventions will help maintain a consistent and organized documentation structure.

### Writing Style

When contributing to the documentation, please follow the following writing style:
Expand Down
File renamed without changes.
File renamed without changes.
2 changes: 1 addition & 1 deletion docs/architecture/intro.rst
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ A key objective of this architecture is to prevent vendor lock-in, ensuring tool

The architecture also supports both current well-known and potential future patterns of interactions between components, fostering innovative use cases that enhance automation and machine-actionability of digital object information exchange. For example, while it is yet uncommon for data repositories to update DMPs, the architecture anticipates and accommodates such potential pathways.

.. figure:: OSTrails-architecture.png
.. figure:: ostrails-reference-architecture.png

OSTrails Architecture

Expand Down
File renamed without changes.
2 changes: 1 addition & 1 deletion docs/commons/dmp/dmp-common-standard.rst
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ Within the DMP Commons, the RDA DMP Common Standard:

The standard intentionally avoids domain-specific requirements or policy-driven constraints. Such specializations are addressed at higher layers (e.g. application profiles), allowing the common standard to remain stable and broadly applicable.

.. figure:: maDMP-diagram-v1.2.png
.. figure:: dmp-common-standard-diagram.png
:alt: RDA DMP Common Standard for maDMPs v1.2
:target: https://github.com/RDA-DMP-Common/RDA-DMP-Common-Standard/tree/v1.2

Expand Down
2 changes: 1 addition & 1 deletion docs/commons/dmp/dmp-commons.rst
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ In addition, DMP Commons are relevant for data stewards and other stakeholders w

The Commons are built as a **layered framework** consisting of a common data model, an OSTrails (i.e. Europe/EOSC) -specific application profile, and a standard API. Together, these layers enable consistent interpretation of DMP content and predictable interactions between services, regardless of their internal architectures. This approach allows platforms to evolve independently while remaining interoperable at the boundaries. In addition, we provide `maDMP mappings <mappings/index>`_ to support the development of application profiles and to align DMP information with external standards and domain models.

.. figure:: ostrails_dmp-commons.png
.. figure:: dmp-commons.png
:alt: DMP Commons Layers
:align: center
:scale: 60%
Expand Down
4 changes: 2 additions & 2 deletions docs/commons/dmp/mappings/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -73,5 +73,5 @@ We will add more mappings as we progress with the review.
:maxdepth: 1
:titlesonly:

Science Europe maDMP mapping <Science-Europe-maDMP-mapping>
Austrian FWF – maDMP mapping <Austrian-FWF–maDMP-mapping>
Science Europe maDMP mapping <science-europe>
Austrian FWF – maDMP mapping <austrian-fwf>
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ This repository is built on top of the **FAIR Data Point (FDP)**, a
software framework maintained by the
`FAIRDataTeam <https://github.com/FAIRDataTeam>`_.

.. figure:: Test-Algorithm-Registry.png
.. figure:: test-algorithm-registry.png
:alt: Test Algorithm Registry
:align: center

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,11 +13,11 @@ The following resources in this section are part of the FAIR Commons component.
:maxdepth: 1
:titlesonly:

Guidance Element Specification <Guidance-Element-Specification>
FAIR Test Results Vocabulary (FTR) <FAIR-Test-Results-Vocabulary-FTR>
Assessment Recommended API <Assessment-Recommended-API>
Catalogue of Benchmarks and Metrics <Catalogue-of-Benchmarks>
Catalogue of Tests <Catalogue-of-Tests>
Catalogue of Benchmark Scoring Algorithms <Catalogue-of-Benchmark-Scoring-Algorithms>
Code of Shared Tests <Shared-Tests>
Guidance Element Specification <guidance-element-specification>
FAIR Test Results Vocabulary (FTR) <fair-test-results-vocabulary-ftr>
Assessment Recommended API <assessment-recommended-api>
Catalogue of Benchmarks and Metrics <catalogue-of-benchmarks>
Catalogue of Tests <catalogue-of-tests>
Catalogue of Benchmark Scoring Algorithms <catalogue-of-benchmark-scoring-algorithms>
Code of Shared Tests <shared-tests>

Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ of this activity is either a ``TestResult`` or a ``TestResultSet``.

----

.. figure:: FAIRTestResult_diagram_v12.drawio.png
.. figure:: fair-test-results-vocabulary-ftr-diagram.png
:alt: FAIR Testing Resource Vocabulary (FTR)
:target: https://github.com/OSTrails/FAIR_testing_resource_vocabulary

Expand Down
7 changes: 3 additions & 4 deletions docs/commons/skg/mappings/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,6 @@ Below, we list SKG mappings defined for commonly used scholarly metadata sources
:maxdepth: 1
:titlesonly:

DDI SKG-IF mapping <Mapping-SKGIF-DDI>
RO-Crate SKG-IF mapping <Mapping-SKGIF-RO-Crate>
OpenAIRE Graph SKG-IF mapping <Mapping-SKGIF-OpenAIRE>

DDI SKG-IF mapping <ddi>
RO-Crate SKG-IF mapping <ro-crate>
OpenAIRE Graph SKG-IF mapping <openaire-graph>
15 changes: 8 additions & 7 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -17,9 +17,9 @@ The documentation is structured as follows:
:caption: Architecture

Introduction <architecture/intro>
DMP IF <architecture/dmp_if>
SKG IF <architecture/skg_if>
FAIR IF <architecture/fair_if>
DMP IF <architecture/dmp-if>
SKG IF <architecture/skg-if>
FAIR IF <architecture/fair-if>


.. toctree::
Expand All @@ -30,16 +30,17 @@ The documentation is structured as follows:
Governance <commons/governance>
DMP Commons <commons/dmp/dmp-commons.rst>
SKG Commons <commons/skg/skg-commons.rst>
FAIR Commons <commons/FAIR/FAIR-commons.rst>
FAIR Commons <commons/fair/fair-commons.rst>


.. toctree::
:maxdepth: 4
:caption: Tools

FAIR Tools <tools/FAIR>
DMP Tools <tools/DMP>
SKG Tools <tools/SKG>
FAIR Tools <tools/fair>
DMP Tools <tools/dmp>
SKG Tools <tools/skg>


.. toctree::
:maxdepth: 4
Expand Down
18 changes: 0 additions & 18 deletions docs/tools/FAIR.rst

This file was deleted.

Binary file not shown.
Binary file removed docs/tools/FAIR_tools/fairassist-search-filter.png
Binary file not shown.
File renamed without changes.
18 changes: 18 additions & 0 deletions docs/tools/fair.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
OSTrails FAIR Tools
====================


The following resources in this section are part of the FAIR Tools component.

.. toctree::
:caption: Tools
:maxdepth: 1
:titlesonly:

FAIR Champion <fair/fair-champion>
FOOPS <fair/foops>
FAIROS <fair/fairos>
FAIRsharing <fair/fairsharing>
FAIR Assessment Authoring Tool <fair/fair-assessment-authoring-tool>
FAIR Validator <fair/fair-validator>

File renamed without changes.
File renamed without changes.
6 changes: 3 additions & 3 deletions docs/tools/SKG.rst → docs/tools/skg.rst
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,6 @@ The following resources in this section are part of the SKG Tools component.
:maxdepth: 1
:titlesonly:

OpenAIRE Graph SKG-IF API <SKG_tools/openaire>
RO-HUB SKG-IF API <SKG_tools/rohub>
CESSDA SKG-IF API <SKG_tools/cessda>
OpenAIRE Graph SKG-IF API <skg/openaire-graph>
RO-HUB SKG-IF API <skg/rohub>
CESSDA SKG-IF API <skg/cessda>
File renamed without changes.
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ The OpenAIRE Graph employs a comprehensive data model that encapsulates a divers

The graph not only represents these entities but also illustrates the relationships between them. This interconnectedness allows users to explore citations, collaborations, project affiliations, and software dependencies among a vast network of research products.

.. figure:: SKG-OpenAIRE-Graph.png
.. figure:: openaire-graph.png
:alt: SKG OpenAIRE Graph
:align: center

Expand Down
File renamed without changes.
Loading