Data2Services project documentation

The documentation website at d2s.semanticscience.org is automatically updated by a GitHub Action at each push to this master branch.

Edit documentation pages

Editing a documentation file is as easy as going to https://github.com/MaastrichtU-IDS/d2s-docs/edit/master/docs/start-introduction.md.

Edit a page by login with an account that has edit permissions.
Otherwise fork the repository and modify the files you want. Pull requests are welcome!

Browse all documentation pages here.

We recommend using Typora to edit markdown files on your computer.

Files locations

Add new docs pages to website/sidebars.json.
Main parameters of the website can be found in website/siteConfig.js.
Static content (any resource to download, images, css, js) can be provided in website/static
HTML pages (other than docs markdown) are in website/pages/en

Run for development

To run in the /website directory.

cd website
yarn install
yarn start

Run with Docker

docker-compose up

Access at http://localhost:3000/

Deploy on server

Using jwilder's nginx-proxy

Set environment VIRTUAL_HOST and VIRTUAL_PORT in docker-compose.yml.

docker-compose up -d

Access at https://d2s.semanticscience.org

Deploy to GitHub pages

To run in /website directory. Make sure the /website/build directory has been generated before deploying.

yarn install
yarn build
GIT_USER=MaastrichtU-IDS CURRENT_BRANCH=master USE_SSH=true yarn run publish-gh-pages

Install Docusaurus boostrap tool

sudo npm install --global yarn
sudo npm install --global docusaurus-init

npx docusaurus-init

Acknowledgments

Documentation website generated using Docusaurus.

Logo created with Inkscape and https://weareoutman.github.io/rounded-polygon/.

Diagrams created with drawio.

Screencast recorded using asciinema.

# Failing to convert to gif
docker run --rm -v $PWD:/data asciinema/asciicast2gif -t solarized-dark -h 25 -s 2.5 https://asciinema.org/a/309866.json d2s_demo.gif

RTXteam/d2s-docs