diff --git a/README.md b/README.md index 171382e..90cc01b 100644 --- a/README.md +++ b/README.md @@ -9,6 +9,11 @@ $ git clone https://code-repo.d4science.org/D-Net/openaire-graph-docs.git ## Local installation and deployment +From https://docusaurus.io/docs/installation#requirements +> Node.js version 16.14 or above (which can be checked by running node -v) + + + To install the required packages use: ``` $ npm install diff --git a/docs/assets/openaire-badge-1.png b/docs/assets/openaire-badge-1.png new file mode 100644 index 0000000..c88ff30 Binary files /dev/null and b/docs/assets/openaire-badge-1.png differ diff --git a/docs/assets/openaire-badge-1.zip b/docs/assets/openaire-badge-1.zip new file mode 100644 index 0000000..c253811 Binary files /dev/null and b/docs/assets/openaire-badge-1.zip differ diff --git a/docs/assets/openaire-badge-2.png b/docs/assets/openaire-badge-2.png new file mode 100644 index 0000000..8be5e56 Binary files /dev/null and b/docs/assets/openaire-badge-2.png differ diff --git a/docs/assets/openaire-badge-2.zip b/docs/assets/openaire-badge-2.zip new file mode 100644 index 0000000..2858237 Binary files /dev/null and b/docs/assets/openaire-badge-2.zip differ diff --git a/docs/assets/openaire-badge-3.png b/docs/assets/openaire-badge-3.png new file mode 100644 index 0000000..3cda85f Binary files /dev/null and b/docs/assets/openaire-badge-3.png differ diff --git a/docs/assets/openaire-badge-3.zip b/docs/assets/openaire-badge-3.zip new file mode 100644 index 0000000..cf3541e Binary files /dev/null and b/docs/assets/openaire-badge-3.zip differ diff --git a/docs/assets/openaire-red-badge.png b/docs/assets/openaire-red-badge.png deleted file mode 100644 index e346dca..0000000 Binary files a/docs/assets/openaire-red-badge.png and /dev/null differ diff --git a/docs/downloads/full-graph.md b/docs/downloads/full-graph.md index 870629b..97ddbfa 100644 --- a/docs/downloads/full-graph.md +++ b/docs/downloads/full-graph.md @@ -26,10 +26,23 @@ Manghi P., Atzori C., Bardi A., Baglioni M., Schirrwagen J., Dimitropoulos H., L Please also consider citing [other relevant research products](/publications#relevant-research-products) that can be of interest. -Also consider adding one of the following badges to your service with the appropriate link to [our website](https://graph.openaire.eu): +Also consider adding one of the following badges to your service with the appropriate link to [our website](https://graph.openaire.eu); click on the badges below to download the respective badge image files. -

- - Openaire badge - -

+ +
+
+ + Openaire badge + +
+
+ + Openaire badge + +
+
+ + Openaire badge + +
+
diff --git a/docs/downloads/related-datasets.md b/docs/downloads/related-datasets.md index 93f112c..b342307 100644 --- a/docs/downloads/related-datasets.md +++ b/docs/downloads/related-datasets.md @@ -15,4 +15,16 @@ In this page, we list other related datasets; please refer to their respective s Schema (Scholix version 4): https://doi.org/10.5281/zenodo.6351557 This dataset is licensed under a CC0 1.0 Universal (CC0 1.0) Public Domain Dedication. -The dataset contains the GZ-compressed dump of the Scholix links exposed by the OpenAIRE ScholeXplorer service. \ No newline at end of file +The dataset contains the GZ-compressed dump of the Scholix links exposed by the OpenAIRE ScholeXplorer service. + +## The OpenAIRE LOD dump + +Dataset (RDF dump): https://doi.org/10.5281/zenodo.609943 + +LOD Ontology: http://lod.openaire.eu/vocab + +SPARQL Endpoint: http://lod.openaire.eu/sparql + + +The OpenAIRE Linked Open Data (LOD) Services and their integration with the OpenAIRE information space have been released as a beta version. The LOD exporting process started with a specification of the OpenAIRE data model as an RDF vocabulary, and then mapping of the OpenAIRE data to the graph-based RDF data model. To interlink the OpenAIRE data with related data on the Web, we have identified a list of potential datasets to interlinked with, including the DBpedia dataset extracted from Wikipedia and the publication databases DBLP and CiteSeer. +Please refer [here](http://lod.openaire.eu/documentation) for more details on the LOD documentation. \ No newline at end of file diff --git a/docusaurus.config.js b/docusaurus.config.js index d546833..5fc1466 100644 --- a/docusaurus.config.js +++ b/docusaurus.config.js @@ -5,7 +5,6 @@ const lightCodeTheme = require('prism-react-renderer/themes/github'); const darkCodeTheme = require('prism-react-renderer/themes/dracula'); const math = require('remark-math'); const katex = require('rehype-katex'); -const { filterItems } = require('./sidebar-utils'); const dotenv = require('dotenv'); // load env variables (see .env file) @@ -19,7 +18,7 @@ console.info(env.parsed); /** @type {import('@docusaurus/types').Config} */ const config = { - title: 'OpenAIRE Documentation', + title: 'OpenAIRE Research Graph Documentation', tagline: 'Open Access Infrastructure for Research in Europe', url: process.env.URL, baseUrl: process.env.BASE_URL, // serve the website at route @@ -47,18 +46,7 @@ const config = { ({ docs: { routeBasePath: '/', // serve the docs at the site's route - sidebarPath: require.resolve('./sidebars.js'), - async sidebarItemsGenerator({ defaultSidebarItemsGenerator, ...args }) { - const sidebarItems = await defaultSidebarItemsGenerator(args); - - const itemsToFilterOut = [ - 'data-model/entities/entity-identifiers', - 'data-model/entities/other' - ]; - - return filterItems(sidebarItems, itemsToFilterOut); - }, // Please change this to your repo. // Remove this to remove the "edit this page" links. // editUrl: @@ -74,7 +62,7 @@ const config = { theme: { customCss: require.resolve('./src/css/custom.css'), }, - sitemap: { + sitemap: { changefreq: 'monthly', priority: 0.5, ignorePatterns: ['/tags/**'], @@ -115,14 +103,14 @@ const config = { type: 'docsVersionDropdown', position: 'right' }, - // + // link to blog, the blog must be enabled first // {to: '/blog', label: 'Blog', position: 'left'}, - // + // link to github repo // { // href: 'https://github.com/facebook/docusaurus', - // label: 'GitHub', + // label: 'Issues', // position: 'right', // }, ], @@ -189,6 +177,11 @@ const config = { ], copyright: `Copyright © ${new Date().getFullYear()} OpenAIRE`, }, + colorMode: { + defaultMode: 'light', + disableSwitch: true, + respectPrefersColorScheme: false, + }, prism: { theme: lightCodeTheme, darkTheme: darkCodeTheme, diff --git a/release.properties b/release.properties new file mode 100644 index 0000000..1326652 --- /dev/null +++ b/release.properties @@ -0,0 +1,8 @@ +#The name of the tag +tag_name=1.0 +# A description of the tag +tag_description=1.0 is our 1st tag +#The release name +release_name=release-1.0 +#The release description +release_description=this is the release 1.0 \ No newline at end of file diff --git a/sidebar-utils.js b/sidebar-utils.js deleted file mode 100644 index ee69999..0000000 --- a/sidebar-utils.js +++ /dev/null @@ -1,18 +0,0 @@ -// filter out specific items from the sidebar -function filterItems(items, itemsToFilter) { - - // filter out items of categories - let result = items.map((item) => { - if (item.type === 'category') { - return {...item, items: filterItems(item.items, itemsToFilter)}; - } - return item; - }); - - // filter out items in current level - return result.filter( item => !itemsToFilter.includes(item.id) ); -} - -module.exports = { - filterItems -}; \ No newline at end of file diff --git a/src/css/custom.css b/src/css/custom.css index 220bb1a..14bc00e 100644 --- a/src/css/custom.css +++ b/src/css/custom.css @@ -39,4 +39,25 @@ .todo { background-color: yellow; -} \ No newline at end of file +} + +@media (min-width: 996px) { + + .left-badge { + padding-right: 5px; + } + + .mid-badge { + padding-left: 0; + padding-right: 5px; + } + + .right-badge { + padding-left: 0; + } +} + +.dark-badge { + background-color: #c6c6c6; +} + diff --git a/static/img/docusaurus.png b/static/img/docusaurus.png deleted file mode 100644 index f458149..0000000 Binary files a/static/img/docusaurus.png and /dev/null differ diff --git a/static/img/undraw_docusaurus_mountain.svg b/static/img/undraw_docusaurus_mountain.svg deleted file mode 100644 index af961c4..0000000 --- a/static/img/undraw_docusaurus_mountain.svg +++ /dev/null @@ -1,171 +0,0 @@ - - Easy to Use - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/static/img/undraw_docusaurus_react.svg b/static/img/undraw_docusaurus_react.svg deleted file mode 100644 index 94b5cf0..0000000 --- a/static/img/undraw_docusaurus_react.svg +++ /dev/null @@ -1,170 +0,0 @@ - - Powered by React - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/static/img/undraw_docusaurus_tree.svg b/static/img/undraw_docusaurus_tree.svg deleted file mode 100644 index d9161d3..0000000 --- a/static/img/undraw_docusaurus_tree.svg +++ /dev/null @@ -1,40 +0,0 @@ - - Focus on What Matters - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -