alanorth/iseal-core
1
0
Fork 0
mirror of https://github.com/ISEAL-Community/iseal-core.git synced 2024-06-25 23:53:48 +02:00
Code Issues Projects Releases Wiki Activity
e202cbe3de
iseal-core/README-dev.md
Alan Orth e202cbe3de
Add README-dev.md 
I need to start collecting and organizing documentation for various
technical workflows here. For example:

- Adding a new schema element
- Adding a new schema extension
- Updating controlled vocabularies
- Updating the documentation site layout

Etc...
2022-01-29 17:15:51 +03:00

734 B
Raw Blame History

Technical Documentation

This document provides technical information about various workflows related to updating and editing the schema and documentation site.

General Requirements

  • Python 3.7+
  • Node.js 12+ and NPM

Python Setup

Create a Python 3 (3.7+) virtual environment and install the requirements:

$ python3 -m venv virtualenv
$ source virtualenv/bin/activate
$ pip install -r requirements.txt

Then run the utility scripts to parse the schemas:

$ ./util/generate-hugo-content.py -i ./data/iseal-core.csv --clean -d
$ ./util/generate-hugo-content.py -i data/fsc.csv -d

Node.js Setup

To generate the HTML documentation site:

$ cd site
$ npm install
$ npm run build