Add changelog.md; add version in navbar; update readme

pull/3/head
Serafeim Chatzopoulos 2 years ago
parent cb0e7a921a
commit 3410ca7dc0

@ -2,30 +2,41 @@
This website is built using [Docusaurus 2](https://docusaurus.io/); please check [here](https://docusaurus.io/docs/installation#requirements) the requirements to run the project.
### Clone repository
## Clone repository
```
$ git clone https://code-repo.d4science.org/D-Net/openaire-graph-docs.git
```
### Installation
## Local installation and deployment
To install the required packages use:
```
$ npm install
```
### Local Development
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
```
This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.
### Build and deploy
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
```
This command generates static content into the `build` directory and can be served using any static contents hosting service.
## Deployment using Docker
TODO
## Documentation versioning
The versioning documentation of Docusaurus can be found [here](https://docusaurus.io/docs/versioning).
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`.

@ -0,0 +1,6 @@
---
sidebar_position: 12
---
# Changelog
<span className="todo">TODO</span>

@ -4,7 +4,7 @@ id: intro
sidebar_position: 1
---
# Welcome!
# Overview
The OpenAIRE Research Graph is one of the largest open scholarly record collections worldwide, key in fostering Open Science and establishing its practices in the daily research activities.
Conceived as a public and transparent good, populated out of data sources trusted by scientists, the Graph aims at bringing discovery, monitoring, and assessment of science back in the hands of the scientific community.

@ -91,15 +91,19 @@ const config = {
type: 'doc',
docId: 'intro',
position: 'left',
label: 'Research graph',
label: 'Research graph v5.0',
},
//
// documentation version in the navbar
// {
// type: 'doc',
// docId: 'intro',
// position: 'left',
// label: 'docs',
// type: 'docsVersionDropdown',
// position: 'right'
// },
//
// link to blog, the blog must be enabled first
// {to: '/blog', label: 'Blog', position: 'left'},
//
// link to github repo
// {
// href: 'https://github.com/facebook/docusaurus',
// label: 'GitHub',

@ -108,6 +108,10 @@ const sidebars = {
type: 'doc',
id: 'license'
},
{
type: 'doc',
id: 'changelog'
},
]
};

Loading…
Cancel
Save