README.md 2.36 KB
Newer Older
Rieks Joosten's avatar
Rieks Joosten committed
1 2
# eSSIF-Lab Framework

3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21
This repo contains the documents that describe the vision, architecture and other
topics that are relevant to the eSSIF-Lab Framework.

## Writing docs

This website is built using [Docusaurus 2](https://v2.docusaurus.io/).

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)).

22 23 24 25 26
Images must be put inside the directory `static/images` and developers must refer to them using _relative_ urls.
Example: ![eSSIF-Lab logo](../images/eSSIF-Lab%20logo.png)
Docusaurus knows that the `../images` directory is inside the `static` directory, and thus process correctly.
The deployment pipe will convert `../images/` in such links to their _*absolute*_ urls.
Of course, if you want to link to images on the web, you can still use absolute urls.
27 28 29 30 31 32 33 34 35 36 37 38 39 40 41

### Installation

You must be able to use `yarn` in order to run the local development server. 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

```
$ yarn
$ yarn start
```

fmerg's avatar
fmerg committed
42
The first command is for linking dependencies. The second starts a local development server and opens up a browser window.
43 44
Note that not all browsers work with this - for example, Microsoft Edge doesn't work. Chrome and FireFox however do.
When developing, most changes are reflected live without having to restart the server.
45 46 47 48 49 50 51 52 53 54 55

### Build

```
$ yarn build
```

This command generates static content into the `build` directory and can be served using any static contents hosting service.

### Deployment

fmerg's avatar
fmerg committed
56
Just push your changes to the `master` branch and they will be automatically deployed at https://essif-lab.pages.grnet.gr/framework/