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...
This commit is contained in:
Alan Orth 2022-01-29 17:15:42 +03:00
parent 6a1a99fb2a
commit e202cbe3de
Signed by: alanorth
GPG Key ID: 0FB860CC9C45B1B9

32
README-dev.md Normal file
View File

@ -0,0 +1,32 @@
# 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:
```console
$ python3 -m venv virtualenv
$ source virtualenv/bin/activate
$ pip install -r requirements.txt
```
Then run the utility scripts to parse the schemas:
```console
$ ./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:
```console
$ cd site
$ npm install
$ npm run build
```