Commit 08f0bf5f authored by fmerg's avatar fmerg

Expand README

parent fabc0a46
Pipeline #3301 passed with stages
in 2 minutes and 21 seconds
# Website
This website is built using [Docusaurus 2](https://v2.docusaurus.io/), a modern static website generator.
This website is built using [Docusaurus 2](https://v2.docusaurus.io/), a modern
static website generator.
### Writing docs
Documentation content must appear in `.md` files inside the `docs` folder.
Each file defines the following attributes at its very beginning:
- `id`, by which the file is referred to across the project
- `title`, appearing at the top of the file's display
- `sidebar_label`, the file's name appearing in the sidebar
The `sidebars.js` file contains the basic mechanism for distributing content
among sections and is self-explanatory (compare with the sidebar appearing [here](https://essif-lab.pages.grnet.gr/essif-lab/docs/introduction)). Subsections within the `.md` file
(that is, tagged with `##`) will appear at the right part of the page
(see for example [here](https://essif-lab.pages.grnet.gr/essif-lab/docs/infrastructure)).
Images must be put inside `static` and referred to with their _relative_ urls.
### Installation
......@@ -8,6 +26,11 @@ This website is built using [Docusaurus 2](https://v2.docusaurus.io/), a modern
$ yarn
```
When starting the local develoment server (see below), if you face an error
similar to `ERROR: There are no scenarios; must have at least one`,
refer [here](https://github.com/yarnpkg/yarn/issues/2821) for a correct
re-installation of `yarn`.
### Local Development
```
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment