Go to file

Claudio Atzori 31e6f191ee Merge pull request 'dataset vs data' (#82 ) from dataset_vs_data into main Reviewed-on: D-Net/openaire-graph-docs#82		2024-11-04 14:06:50 +01:00
blog	initial commit	2022-09-01 10:26:04 +03:00
docs	Merge pull request 'dataset vs data' (#82 ) from dataset_vs_data into main	2024-11-04 14:06:50 +01:00
src	Add changes for version 6.1.0	2023-08-16 21:02:52 +03:00
static	Rename dump to dataset	2024-01-17 11:36:15 +02:00
versioned_docs	Use instead of when referring to research data	2024-11-04 14:05:01 +01:00
versioned_sidebars	renamed version 8.0.0 to 8.2.0 and version 9.0.0 to 8.0.0. Added enrichment by PID section. Adapted data model definitions to the latest public dataset model	2024-07-30 11:36:02 +02:00
.env	Fix links from impact measures page to specific properties/objects in the result	2022-12-27 21:22:30 +02:00
.gitignore	ignore intellij project file	2022-11-23 14:33:34 +01:00
Dockerfile	Add deployment with docker	2022-10-13 20:52:52 +03:00
README.md	Update 'README.md'	2023-04-19 14:39:27 +02:00
babel.config.js	initial commit	2022-09-01 10:26:04 +03:00
docusaurus.config.js	Add matomo tracking script	2023-07-20 17:07:00 +03:00
package-lock.json	Add matomo tracking script	2023-07-20 17:07:00 +03:00
package.json	Add matomo tracking script	2023-07-20 17:07:00 +03:00
release.properties	Update 'release.properties'	2022-12-20 15:16:23 +01:00
sidebars.js	FoS and SDG classification pages moved under the indicators ingestion section. Expanded SDG page with some details about the taxonomy	2024-07-30 12:45:00 +02:00
versions.json	renamed version 8.0.0 to 8.2.0 and version 9.0.0 to 8.0.0. Added enrichment by PID section. Adapted data model definitions to the latest public dataset model	2024-07-30 11:36:02 +02:00

README.md

OpenAIRE Graph Documentation

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

Local installation and development

From https://docusaurus.io/docs/installation#requirements

Node.js version 16.14 or above (which can be checked by running node -v)

Clone the repository:

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

NOTE: please use git branches for introducing new changes.

Install the required packages:

npm install

Start a local development server (opens in a new browser window).

npm run start

NOTE: most changes are reflected live without having to restart the server.

Before issuing a Pull Request, please ensure that the following command runs successfully:

npm run build

NOTE: This command generates the static content into the build directory. Then this output directory is issued to deploy the documentation website.

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.

Therefore, when previewing the compiled site locally with npm run start, ensure to visualise the Next version on the browser as it shows the changes under /docs. To change a version that was already versioned, the source files to be modified are in the versioned_docs/version-<versionName>/ folder.