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.
 
 
 
Go to file
Serafeim Chatzopoulos eb2364b8f4
Add missing enrichment files
2 months ago
blog initial commit 5 months ago
docs Add missing enrichment files 2 months ago
src Serve docs in the landing page 5 months ago
static merging with main 3 months ago
.gitignore more git ignores 3 months ago
Dockerfile Add deployment with docker 4 months ago
README.md Add deployment with docker 4 months ago
babel.config.js initial commit 5 months ago
docusaurus.config.js Add changelog.md; add version in navbar; update readme 4 months ago
package-lock.json Update to docusaurus v2.2.0 && npm audit fix 3 months ago
package.json Update to docusaurus v2.2.0 && npm audit fix 3 months ago
sidebar-utils.js Add example to all fields in entities and relationshipds 5 months ago
sidebars.js Merge pull request 'enrichment' (#20) from enrichment into main 2 months 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

Development

Build docker container for development and run on port 3000:

docker build --target development -t docs:dev .
sudo docker run -d -p 3000:3000 docs:dev

Production

Build docker container for production and run on port 80:

docker build -t docs:latest .
docker run -d -p 80:80 docs:latest

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.