zkotti / cosmos-tour Goto Github PK

Proposal

I propose that the website found under the mkdocs directory be moved to a separate repository (e.g. tplessas/cosmos-tour-website) and build automation be enabled.

Rationale

As so pointedly put in mkdocs/README.md, the website generated through the build process should not be located in this repo - it is a build artifact, not part of the source, and as such anyone can generate it at any time by simply going through the build process. Automating the build process on this repository would probably contribute more headaches to maintainers than value offered to the project.

Hosting static websites in GitHub repositories is officially supported by the service itself - anyone can create a *.github.io website using GitHub Pages, often used for project documentation and simple personal sites.

Currently the website is not updated when changes in guide.md take place - this should not happen in this repository for the reasons explained in the first paragraph of this section, resulting in the website being significantly behind the actual guide since only this afternoon.

Implementation

A new repo B will be created to host the website build. A GitHub Actions automation will be set up in this repo to dispatch an event to B whenever a push or a PR merge happens. Another automation on B will consume the event, fetch the files from repo A, and rebuild the website. The website will then be deployed on GitHub Pages, always up-to-date with the latest additions and fixes.

This tutorial on the aforementioned automation pattern could be used as a guide.

Call for help

I can take this issue, but would appreciate some help from one more contributor as well - we could split up implementation into its two logical parts (the two automation scripts).

Going by my personal motto: "You can do most things in life by yourself, but it's more fun with friends."