azaroth42
commented
6 years ago For Linked.Art, we use the following setup:
- The web page data is stored in github to allow distributed editing and management. It's stored as markdown files to allow for ease of editing and reading.
- Non web page text (such as the JSON-LD examples, CSS and images) are stored in different directories, with different processing rules.
- We use Netlify as a hosting platform. This is free for non-commercial, open source style sites.
- A static site generator is run automatically by netlify triggered by any change to the repository. We use the python clone of Jekyll (a ruby site generator) called Hyde, with some custom extensions to be able to write python code in the markdown that then generates all of the example documents as JSON-LD and Turtle and embeds a syntax highlighted version of the JSON-LD in the HTML, rather than having to keep them all in sync manually or with external scripts.
- A second pass builds an index of the terms used in the examples.
- Changes can be previewed on netlify per PR or per branch.
It's quite lightweight and allows the use of the familiar github UI for managing discussions, plus CI/CD tools to automatically publish to a human readable site. It does not give any search functionality, but an equivalent indexer could be written for a static index of the ARM models.
For discussion of options regarding a short-term/initial repository for the content that the ARM WG creates.