You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
Serafeim Chatzopoulos 3410ca7dc0 Add changelog.md; add version in navbar; update readme 5 days ago
blog initial commit 1 month ago
docs Add changelog.md; add version in navbar; update readme 5 days ago
src Serve docs in the landing page 2 weeks ago
static Static sidebar && add publications 2 weeks ago
.gitignore initial commit 1 month ago
README.md Add changelog.md; add version in navbar; update readme 5 days ago
babel.config.js initial commit 1 month ago
docusaurus.config.js Add changelog.md; add version in navbar; update readme 5 days ago
package-lock.json Add impact metrics and data model outline 1 month ago
package.json Add impact metrics and data model outline 1 month ago
sidebar-utils.js Add example to all fields in entities and relationshipds 2 weeks ago
sidebars.js Add changelog.md; add version in navbar; update readme 5 days ago

README.md

OpenAIRE Graph Documentation

This website is built using Docusaurus 2; please check here the requirements to run the project.

Clone repository

$ git clone https://code-repo.d4science.org/D-Net/openaire-graph-docs.git

Local installation and deployment

To install the required packages use:

$ npm install

The following command starts a local development server and opens up a browser window. Note that most changes are reflected live without having to restart the server.

$ npm run start

Generate the static content into the build directory using the command tha follows. Then this directory can be served using any static contents hosting service.

$ npm run build

Deployment using Docker

TODO

Documentation versioning

The versioning documentation of Docusaurus can be found here. Specifically, a new version can be created with the following command:

npm run docusaurus docs:version <versionName>

When tagging a new version, the document versioning mechanism will:

  • Copy the full docs/ folder contents into a new versioned_docs/version-<versionName>/ folder.
  • Create a versioned sidebars file based from your current sidebar configuration, saved as versioned_sidebars/version-<versionName>-sidebars.json.
  • Append the new version number to versions.json.