Go to file

Paolo Manghi 0f29d7a919 Update 'docs/intro.md'		2023-01-16 13:46:37 +01:00
blog	initial commit	2022-09-01 10:26:04 +03:00
docs	Update 'docs/intro.md'	2023-01-16 13:46:37 +01:00
src	Serve docs in the landing page	2022-09-20 19:25:30 +03:00
static	Static sidebar && add publications	2022-09-23 19:00:46 +03:00
.gitignore	initial commit	2022-09-01 10:26:04 +03:00
README.md	Add changelog.md; add version in navbar; update readme	2022-09-29 19:00:42 +03:00
babel.config.js	initial commit	2022-09-01 10:26:04 +03:00
docusaurus.config.js	Add changelog.md; add version in navbar; update readme	2022-09-29 19:00:42 +03:00
package-lock.json	Add impact metrics and data model outline	2022-09-02 16:49:27 +03:00
package.json	Add impact metrics and data model outline	2022-09-02 16:49:27 +03:00
sidebar-utils.js	Add example to all fields in entities and relationshipds	2022-09-23 17:19:32 +03:00
sidebars.js	Add changelog.md; add version in navbar; update readme	2022-09-29 19:00:42 +03:00

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.