50 Commits

This Branch

This Branch

All Branches

Author	SHA1	Message	Date
Alan Orth	6169f92f6c	README.md: add more TODO	2021-12-06 21:31:03 +02:00
Alan Orth	c85a4690f3	.gitignore: ignore Python virtualenv	2021-12-06 21:29:22 +02:00
Alan Orth	aa7f27ae38	README.md: add more information ... Add a screenshot of the documentation website and more information about the Python/Node.js setup and usage.	2021-12-06 21:28:18 +02:00
Alan Orth	96df76b73d	Add requirements.txt ... Generated with poetry: $ poetry export -f requirements.txt > requirements.txt This is useful for people who don't have poetry.	2021-12-06 21:20:25 +02:00
Alan Orth	568fca6400	Update npm packages ... Version bump in package.json and then run `npm update` to generate a new package-lock.json.	2021-12-06 21:05:47 +02:00
Alan Orth	2b22f9b57d	poetry.lock: run poetry lock	2021-12-02 12:55:55 +02:00
Alan Orth	d092f83cda	pyproject.toml: adjust dependencies ... Remove pylode because Marie says she was only using it for the HTML docs, but I'm doing that differently now. This means we can have a direct dependency on rdflib now. Also, move isort and black to dev dependencies because nobody will need them except me. :)	2021-12-02 12:53:25 +02:00
Alan Orth	8e8aa2983c	site/docs: regenerate with hugo	2021-12-02 10:54:08 +02:00
Alan Orth	46b31f4585	site/layouts: add CC-BY-SA-4.0 text to footer	2021-12-02 10:51:12 +02:00
Alan Orth	b5d1b77fb8	Add license notice ... ISEAL confirmed that we can use CC-BY-SA-4.0 for website content, but this is not appropriate for the code in this repository. I will suggest that we use GPLv3.0 for that as it is comparable. Importing a copy of the GPLv3.0 license text from: https://www.gnu.org/licenses/gpl-3.0.txt	2021-12-02 10:40:49 +02:00
Alan Orth	26f33244d9	Regenerate site ... Use `npm run build` to regenerate the static CSS/JS assets and the HTML docs.	2021-12-01 15:16:09 +02:00
Alan Orth	f42227914f	layouts/_default/term.html: use code for element ... Use a monospace font for the element name so it is unambiguous.	2021-12-01 15:11:38 +02:00
Alan Orth	ac1b61d3dd	site/source/scss: use orange for code blocks	2021-12-01 15:08:02 +02:00
Alan Orth	69956024f7	site/source/scss: adapt more ISEAL branding ... Use tint colors from the ISEAL Branding Guidelines Version 3.0 and remove the dark and light blues that I gleaned from the ISEAL web- site.	2021-12-01 15:08:02 +02:00
Alan Orth	320ade7069	source/scss: use secondary green for code ... Experimenting with secondary colors.	2021-12-01 15:08:02 +02:00
Alan Orth	3598509499	site/assets: regenerate static assets ... Using the `npm run build` script.	2021-12-01 15:08:02 +02:00
Alan Orth	71bcd1092c	site: apply principles from ISEAL branding guidelines ... The ISEAL Branding Guidelines Version 3.0 (June 2021) say we should use Arial font for online material and it specifies the RGB values to use for headings, sub-headings, and body text. It also specifies four secondary colors to be used in support of the primary colors.	2021-12-01 15:08:02 +02:00
Alan Orth	8aef2a0a20	package.json: update dependencies	2021-12-01 15:07:42 +02:00
Alan Orth	77e62be66c	site/docs: regenerate with hugo	2021-12-01 12:00:16 +02:00
Alan Orth	a86e0dfc1f	site: fix grammar in intro	2021-12-01 11:59:42 +02:00
Alan Orth	39a281eb7c	README.md: Add introduction	2021-12-01 11:58:59 +02:00
Alan Orth	be19dc0489	site/docs: regenerate static website using Hugo ... For now it's manual: $ cd site $ rm -rf docs/* $ hugo I will explore making this automatic using a GitHub Action.	2021-11-26 12:07:48 +02:00
Alan Orth	8482294e3c	site/content: regenerate terms ... This is based on the new cluster/module re-organization by Peter last week: idss_schema_fields_new2.xlsx	2021-11-26 12:05:40 +02:00
Alan Orth	4847f50921	poetry.lock: run poetry update ... Updates dependencies	2021-11-26 12:03:12 +02:00
Alan Orth	10f24ad093	site: add clusters and modules ... Re-organize content and navigation around the concept of clusters and modules. Elements that have suggested field names are displayed prominently near the top of each cluster. I am still exploring how to present the clusters and modules better. Perhaps as a badge on each element?	2021-11-26 12:01:18 +02:00
Alan Orth	4827b2b0d4	site: align required badges with text	2021-11-26 12:00:31 +02:00
Alan Orth	2b27a79840	util/generate-hugo-content.py: update for clusters and modules ... Peter re-worked the schema to incorporate the concept of clusters and modules.	2021-11-26 11:58:06 +02:00
Alan Orth	5ecf1e597c	package.json: Fix path to hugo binary	2021-11-25 07:45:40 +02:00
Alan Orth	99d9c7cd94	util/generate-hugo-content.py: Update header	2021-11-17 17:16:22 +02:00
Alan Orth	a5aad2d9a9	util/generate-hugo-content.py: write module to content ... We need to write the IDSS module to the site content.	2021-11-11 15:05:18 +02:00
Alan Orth	6b2dcc9fc1	.gitignore: Ignore some build stuff in site	2021-11-11 14:56:24 +02:00
Alan Orth	392a49f854	Add hugo-installer to site package.json ... This installs a local copy of the Hugo binary that we need to build the site. Otherwise the user would have to install it via their sy- stem package manager. This also adds a new npm "build:site" script to build the site using our local version of Hugo. Note: this is slightly annoying, but after toying with "easier" op- tions like Hexo that integrate with the JavaScript ecosystem more naturally, I ended up preferring Hugo anyways. Hexo's not nearly as powerful or well documented as Hugo. Note note: there is also the `hugo-bin` package on NPM, but it is very out of date.	2021-11-11 14:55:40 +02:00
Alan Orth	29c91c4ed4	Regenerate public	2021-11-07 21:03:51 +02:00
Alan Orth	48d91378d1	layouts/_default/home.html: update intro blurb ... Use some text from the draft ISEAL Core proposal.	2021-11-07 21:02:31 +02:00
Alan Orth	292274b6ff	Regenerate docs	2021-11-07 16:16:27 +02:00
Alan Orth	a7140f3d3d	layouts: Use "element" instead of "field" ... ISEAL refers to these as elements instead of fields.	2021-11-07 16:16:00 +02:00
Alan Orth	7eac3b9f70	Regenerate docs	2021-11-03 21:58:58 +02:00
Alan Orth	32949819ac	Update name of project ... After discussing with ISEAL I see that the preferred name for this project is "ISEAL Core Metadata Set".	2021-11-03 21:58:10 +02:00
Alan Orth	4e65813180	Rename util/generate_docs.py to util/generate-hugo-content.py ... This script doesn't generate the docs itself. It actually only does the schema parsing to generate the metadata term content and vocabs. The docs site is generated by Hugo after running this.	2021-11-01 09:04:57 +02:00
Alan Orth	755ad75150	Regenerate website docs	2021-11-01 08:44:20 +02:00
Alan Orth	d2ee0b5770	.github/workflows/pages.yml: Deploy to site branch	2021-11-01 08:41:17 +02:00
Alan Orth	992fda8f85	Add GitHub workflow to publish to Pages ... It seems we can only enable GitHub Pages with subdirectories at the root of the project. Ours is in ./site/docs so I think we need to use an example like Hexo's to publish with a GitHub workflow. See: https://hexo.io/docs/github-pages	2021-11-01 08:38:05 +02:00
Alan Orth	fdf1c8ebcb	Add .gitignore ... For now only ignoring the site/node_modules directory.	2021-11-01 08:34:00 +02:00
Alan Orth	10dc377139	Add basic README.md	2021-11-01 08:33:36 +02:00
Alan Orth	286896486e	Add initial version of schema specification site ... After running the util/generate_docs.py script to parse and extract the metadata term specifications and their controlled vocabularies, we use Hugo to generate the HTML site. The HTML site uses Bootstrap with several ISEAL brand colors gleaned from the corporate website.	2021-11-01 08:27:41 +02:00
Alan Orth	30310e6db6	Add util/generate-docs.py ... This script parses the Excel schema file to produce term metadata and extract controlled vocabularies to the site content directory. After running this we can generate the site using Hugo.	2021-11-01 08:21:50 +02:00
Alan Orth	c7c0d0efcc	Add setup.cfg for isort ... This is for sorting Python imports and warning about unused ones.	2021-11-01 08:21:32 +02:00
Alan Orth	a0e6e417d4	Add poetry config ... Currently covers the dependencies used in Marie's Jupyter notebook and some extra dev tooling. Note that I had an issue using poetry to install pylode, so I added it to pyproject.toml manually.	2021-11-01 08:19:39 +02:00
Marie-Angélique Laporte	5b622e80e6	fixing domain and range namespace	2021-10-28 09:04:51 +02:00
Marie-Angélique Laporte	3e194e10c6	first attempt at creating the ontology file	2021-10-06 18:13:21 +02:00