From 812c9241bdb21db53eb9a16ee637fb635e10e2f6 Mon Sep 17 00:00:00 2001 From: Alan Orth Date: Sun, 30 Jan 2022 19:41:45 +0300 Subject: [PATCH] README-dev.md: start working on docs --- README-dev.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/README-dev.md b/README-dev.md index 08d4953c..989c0a06 100644 --- a/README-dev.md +++ b/README-dev.md @@ -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 FSC® 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™ 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+ -- Node.js 12+ and NPM +- Python 3.8+ — to parse the CSV schema and generate the RDF and documentation site +- Node.js 12+ and NPM — to generate the documentation site -## Python Setup +### Python Setup Create a Python virtual environment and install the requirements: ```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 ``` -## Node.js Setup +### Node.js Setup To generate the HTML documentation site: ```console