Commit c3e862d9 authored by RieksJ's avatar RieksJ
Browse files

Merge branch 'master' into terminology-rieks

parents ff505d0d 7715fe78
Pipeline #43091 failed with stage
in 1 minute and 21 seconds
name: framework
on:
pull_request:
branches: [master]
push:
branches: [master]
jobs:
checks:
if: github.event_name != 'push'
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v1
- uses: actions/setup-node@v1
with:
node-version: 15
- name: Test Build
run: |
yarn install --frozen-lockfile
yarn docusaurus parse
yarn docusaurus glossary
yarn build
mv build public
gh-release:
if: github.event_name != 'pull_request'
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v1
- uses: actions/setup-node@v1
with:
node-version: 15
- uses: webfactory/ssh-agent@v0.5.0
with:
ssh-private-key: ${{ secrets.GH_PAGES_DEPLOY }}
- name: Release to GitHub Pages
env:
USE_SSH: true
GIT_USER: "MarIliadi"
run: |
git config --global user.email "miliadi@admin.grnet.gr"
git config --global user.name "MarIliadi"
yarn install --frozen-lockfile
yarn docusaurus parse
yarn docusaurus glossary
yarn build
mv build public
yarn deploy
......@@ -4,15 +4,13 @@ stages:
- build
- deploy
before_script:
- node -v
cache:
untracked: true
paths:
- node_modules/
before_script:
- node -v
- yarn
build:
......@@ -34,4 +32,4 @@ pages:
paths:
- public
only:
- master
- main
# eSSIF-Lab Framework
This repo contains files that are used to generate the the [eSSIF-Lab framework](https://essif-lab.pages.grnet.gr/framework/) website, which includes the eSSIF-Lab vision, functional architecture, terminology and other relevant topics.
This repo contains files that are used to generate the the [eSSIF-Lab framework](https://essif-lab.github.io/framework) website, which includes the eSSIF-Lab vision, functional architecture, terminology and other relevant topics.
This website is generated using [Docusaurus 2](https://v2.docusaurus.io/) (and a custom plugin developed by [GRNET](https://grnet.gr/en/) for handling terminology).
## Writing Docusaurus Documents
Docusaurs requires documentation content to appear in `.md` files inside the `docs` folder.
Docusaurus requires documentation content to 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
......@@ -17,7 +17,7 @@ Documentation on these and other header fields can be found [here](https://v2.do
The Terminology Engine plugin of GRNET uses additional header fields. These are (or will be) defined [here](./docs/terminology-contributions).
The `sidebars.js` file contains the basic mechanism for [distributing content among sections](https://v2.docusaurus.io/docs/docs-introduction#sidebar) and is self-explanatory (compare with the sidebar appearing [here](https://essif-lab.pages.grnet.gr/essif-lab/docs/essifLab-project)). 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)).
The `sidebars.js` file contains the basic mechanism for [distributing content among sections](https://v2.docusaurus.io/docs/docs-introduction#sidebar) and is self-explanatory (compare with the sidebar appearing [here](https://essif-lab.github.io/framework/docs/essifLab-project)). 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)).
## Inserting Images in docs
<!-- **DEPRECATED** Images must be put inside the directory `static/images` and developers must refer to them using _relative_ urls.
......@@ -66,7 +66,7 @@ This command generates static content into the `build` directory and can be serv
### Deployment
Just push your changes to the `master` branch and they will be automatically deployed at https://essif-lab.pages.grnet.gr/framework/
Just push your changes to the `master` branch and they will be automatically deployed at https://essif-lab.github.io/framework/ and https://essif-lab.github.io/framework/.
## Terminology/Glossary plugin usage
......
......@@ -2,11 +2,11 @@ const path = require('path');
module.exports = {
title: 'eSSIF-Lab',
tagline: 'eSSIF-Lab Framework',
url: 'https://essif-lab.pages.grnet.gr/framework',
baseUrl: process.env.STAGING && process.env.STAGING === 'true' ? '/framework/' : '/',
url: 'https://essif-lab.github.io',
baseUrl: '/framework/',
favicon: 'images/favicon.ico',
organizationName: 'grnet',
projectName: 'essif-lab',
organizationName: 'essif-lab',
projectName: 'framework',
onBrokenLinks: 'log',
scripts: [
{
......@@ -28,8 +28,8 @@ module.exports = {
{to: 'docs/essifLab-pattern-list', label: 'Mental Models', position: 'left'},
{to: 'docs/ssi-standards', label: 'SSI Standardization', position: 'right'},
{
href: 'https://gitlab.grnet.gr/essif-lab/framework',
label: 'Gitlab',
href: 'https://github.com/essif-lab/framework',
label: 'Github',
position: 'right',
},
],
......
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