Go to file
Serafeim Chatzopoulos b9bdda24b7 Merge pull request 'Fixes images path when using a BASE_URL = "/docs"' (#33) from fix-image-links into main
Reviewed-on: #33
2022-12-21 18:15:19 +01:00
blog initial commit 2022-09-01 10:26:04 +03:00
docs Merge with main 2022-12-21 19:13:15 +02:00
src Change footer 2022-12-20 15:20:50 +02:00
static Merge with main 2022-12-21 19:13:15 +02:00
.env Restructure data provision section 2022-12-20 17:55:04 +02:00
.gitignore more git ignores 2022-11-08 09:36:35 +01:00
Dockerfile Add deployment with docker 2022-10-13 20:52:52 +03:00
README.md Update 'README.md' 2022-12-14 14:23:22 +01:00
babel.config.js initial commit 2022-09-01 10:26:04 +03:00
docusaurus.config.js Change footer 2022-12-20 15:20:50 +02:00
package-lock.json Add support for ENV variables 2022-12-12 09:35:53 +02:00
package.json Add support for ENV variables 2022-12-12 09:35:53 +02:00
release.properties Update 'release.properties' 2022-12-20 15:16:23 +01:00
sidebars.js Move text from finalisation to cleaning; minor changes in mining; fix typo in sidebar 2022-12-21 17:03:44 +02: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

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

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.