search

elisa-tech / wg-osep

The Open-Source Engineering Process WG examines how software engineering processes can be used to facilitate the certification of safety-critical systems incorporating Linux and other FOSS.
Other
9 stars 5 forks source link

Can we publish documents using GitHub Pages? #39

Closed reiterative closed 2 weeks ago

reiterative commented 1 month ago

As described at https://pages.github.com, it is possible to publish web-based documentation generated from marked-up text (e.g. in markdown or ReStructuredText) from a GitHub project using a document generation tooling such as Material for mkdocs or ReadTheDocs.

As discussed at a previous workshop (in 2021), this approach would provide a good way for us to have 'official' published documentation from ELISA working groups, that can be readily linked to and accessed.

However, GitHub Pages currently seems to be disabled for the projects in the elisa-tech group. Resolving this may require work by the Linux Foundation team managing the ELISA GitHub organisation, to e.g. set up subdomains of elisa.tech and provision these in the GitHub Pages configuration.

reiterative commented 1 month ago

Kate mentioned on the TSC call that this is how other Linux Foundation projects (e.g. e.g. https://spdx.github.io/spdx-spec/v2.3-RC1/) and that an appropriate sub-domain (elisa-tech.github.io) could be configured to support this. Then, once peer-reviewed content releases have been published here by OSEP (and other working groups, if they choose) it could be referenced from the https://elisa.tech site.

reiterative commented 2 weeks ago

This is set up and configured for: osep.elisa.tech