alanorth/iseal-core
1
0
Fork 0
mirror of https://github.com/ISEAL-Community/iseal-core.git synced 2024-11-04 14:23:03 +01:00
Code Issues Projects Releases Wiki Activity

README-dev.md: start working on docs

Browse Source
This commit is contained in:
Alan Orth 2022-01-30 19:41:45 +03:00
parent 362c7f8779
commit 812c9241bd
Signed by: alanorth
GPG Key ID: 0FB860CC9C45B1B9
1 changed files with 6 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
README-dev.md
View File

@ -8,14 +8,14 @@ The ISEAL Core Metadata Set is maintained primarily in CSV format. This decision
- The ISEAL Core Metadata Set, which lives in `data/iseal-core.csv` - The ISEAL Core Metadata Set, which lives in `data/iseal-core.csv`
- The FSC<sup>®</sup> extension, which lives in `data/fsc.csv` - The FSC<sup>®</sup> extension, which lives in `data/fsc.csv`
From the CSV we use a series of Python scripts to create the RDF ([TTL](https://en.wikipedia.org/wiki/Turtle_(syntax))) representations of the schema as well as the HTML documentation site. All of this is automated using GitHub Actions (see `.github/workflows`) whenever there is a new commit in the repository. Everything should Just Work<sup>™</sup> so you should only need to follow the documentation here if you want to work on the workflow locally or make larger changes. In that case, continue reading... From the CSV we use a series of Python scripts to create the RDF ([TTL](https://en.wikipedia.org/wiki/Turtle_(syntax))) representations of the schema as well as the HTML documentation site. All of this is automated using GitHub Actions (see `.github/workflows`) whenever there is a new commit in the repository. You should only need to follow the documentation here if you want to work on the workflow locally or make larger changes. In that case, continue reading...
## General Requirements ## Technical Requirements
- Python 3.8+ - Python 3.8+ — to parse the CSV schema and generate the RDF and documentation site
- Node.js 12+ and NPM - Node.js 12+ and NPM — to generate the documentation site
## Python Setup ### Python Setup
Create a Python virtual environment and install the requirements: Create a Python virtual environment and install the requirements:
```console ```console
@ -31,7 +31,7 @@ $ ./util/generate-hugo-content.py -i ./data/iseal-core.csv --clean -d
$ ./util/generate-hugo-content.py -i data/fsc.csv -d $ ./util/generate-hugo-content.py -i data/fsc.csv -d
``` ```
## Node.js Setup ### Node.js Setup
To generate the HTML documentation site: To generate the HTML documentation site:
```console ```console