From ae182ddb152860bac7ef2efb1a174383557ffe0b Mon Sep 17 00:00:00 2001 From: Serafeim Chatzopoulos Date: Wed, 21 Sep 2022 18:43:49 +0300 Subject: [PATCH] Adjust schema img size && remove funders/funding streams --- README.md | 2 +- docs/data-model/data-model.md | 15 ++++++++------- docs/data-model/entities/community.md | 2 +- docs/data-model/entities/funder.md | 8 -------- docs/data-model/entities/funding-stream.md | 8 -------- docs/data-model/entities/other.md | 2 +- docs/data-model/entities/result.md | 2 +- docusaurus.config.js | 2 +- .../assets => static/img/docs}/data-model.png | Bin 9 files changed, 13 insertions(+), 28 deletions(-) delete mode 100644 docs/data-model/entities/funder.md delete mode 100644 docs/data-model/entities/funding-stream.md rename {docs/data-model/assets => static/img/docs}/data-model.png (100%) diff --git a/README.md b/README.md index a7428f1..69d82ae 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -# Website +# OpenAIRE Graph Documentation This website is built using [Docusaurus 2](https://docusaurus.io/); please check [here](https://docusaurus.io/docs/installation#requirements) the requirements to run the project. diff --git a/docs/data-model/data-model.md b/docs/data-model/data-model.md index 7e4f745..8268743 100644 --- a/docs/data-model/data-model.md +++ b/docs/data-model/data-model.md @@ -4,24 +4,25 @@ The OpenAIRE Research Graph comprises several types of entities and [relationshi The latest version of the JSON schema can be found on [Bulk downloads](../download). -![Data mode](./assets/data-model.png) +

+ Data model +

The figure above, presents the graph's data model. Its main entities are described in brief below: -* [Research Products](entities/result) represent the outcomes of research activities. +* [Results](entities/result) represent the outcomes of research activities. +* [Data Sources](entities/data-source) are the resources used to collect metadata for the graph objects * [Organizations](entities/organization) correspond to companies or research institutions involved in projects, responsible for operating data sources or consisting the affiliations of Product creators. -* [Funders](entities/funder) (e.g. EC, Wellcome Trust) are agencies responsible for a list of Funding Streams. -* [Funding Streams](entities/funding-stream) represent investments (funding actions) from Funders (e.g. FP7 or H2020). + + * [Projects](entities/project) are research projects funded by a Funding Stream of a Funder. -* [Data Sources](entities/data-source) are the resources used to collect metadata for the graph objects +* [Communities](entities/community) are groups of people with a common research intent. -TODO: communities are present in the existing documentation instead of funders and fundins streams :::note Further reading A detailed report on the OpenAIRE Research Graph Data Model can be found on [Zenodo](https://zenodo.org/record/2643199). ::: - diff --git a/docs/data-model/entities/community.md b/docs/data-model/entities/community.md index 11c3bcc..3c1eda5 100644 --- a/docs/data-model/entities/community.md +++ b/docs/data-model/entities/community.md @@ -1,5 +1,5 @@ --- -sidebar_position: 7 +sidebar_position: 6 --- diff --git a/docs/data-model/entities/funder.md b/docs/data-model/entities/funder.md deleted file mode 100644 index 0c0a8ba..0000000 --- a/docs/data-model/entities/funder.md +++ /dev/null @@ -1,8 +0,0 @@ ---- -sidebar_position: 5 ---- - -# Funder -TODO - - diff --git a/docs/data-model/entities/funding-stream.md b/docs/data-model/entities/funding-stream.md deleted file mode 100644 index fa946d7..0000000 --- a/docs/data-model/entities/funding-stream.md +++ /dev/null @@ -1,8 +0,0 @@ ---- -sidebar_position: 6 ---- - -# Funding stream -TODO - - diff --git a/docs/data-model/entities/other.md b/docs/data-model/entities/other.md index c75ad4e..a0a5fa1 100644 --- a/docs/data-model/entities/other.md +++ b/docs/data-model/entities/other.md @@ -1,5 +1,5 @@ --- -sidebar_position: 6 +sidebar_position: 7 --- # Other helper objects diff --git a/docs/data-model/entities/result.md b/docs/data-model/entities/result.md index 7b913c0..92890c1 100644 --- a/docs/data-model/entities/result.md +++ b/docs/data-model/entities/result.md @@ -2,7 +2,7 @@ sidebar_position: 1 --- -# Result (Research Product) +# Result Results are intended as digital objects, described by metadata, resulting from a scientific process. In this page, we descibe the properties of the `Result` object. diff --git a/docusaurus.config.js b/docusaurus.config.js index d4c318d..a8e42de 100644 --- a/docusaurus.config.js +++ b/docusaurus.config.js @@ -105,7 +105,7 @@ const config = { items: [ { label: 'Research Graph', - to: '/docs/intro', + to: '/', }, ], }, diff --git a/docs/data-model/assets/data-model.png b/static/img/docs/data-model.png similarity index 100% rename from docs/data-model/assets/data-model.png rename to static/img/docs/data-model.png