Skip to content

Milestones

List view

  • When the main repository is updated I want to a git action to create the changelog and update the documentation. A release should be created on both the primary and documentation repositories. ## Resources - [Creating a docker action](https://docs.github.com/en/actions/creating-actions/creating-a-docker-container-action) - [Github Changelog Generator](https://github.com/github-changelog-generator/github-changelog-generator) - [Github Official Changlog](https://github.blog/changelog/) ## Todo Explore Githubs automated release notes https://docs.github.com/en/repositories/releasing-projects-on-github/automatically-generated-release-notes

    No due date
  • Designed to monitor and manage the health of each node. The status system will throttle the ELB through the use of a status.php file running on its own port using the [built-in webserver](https://www.php.net/manual/en/features.commandline.webserver.php) All status information would be sent and caught by something like cachet and saved into the db. The idea is to have a single source of truth (a db) that can report on the status of the individual nodes.

    No due date
  • Jekyll is the most mature documentation system in existence. With great themes and native github support you really can't go wrong. Jekyll handles the changelogs, documentation and the developer blog nicely. When managing a private repository it's necessary to deploy a secondary PUBLIC repository for the sole purpose of managing tickets and documentation. ## Protocol docs:init <new-repo.git> <local-dir> This command should clone down our templated documentation repository, install jekyll, and deploy the [initial gitpages](https://docs.github.com/en/pages/setting-up-a-github-pages-site-with-jekyll/creating-a-github-pages-site-with-jekyll). ## Themes - https://github.com/topics/jekyll-theme - * https://github.com/wowthemesnet/mundana-theme-jekyll - https://github.com/mmistakes/minimal-mistakes - https://github.com/just-the-docs/just-the-docs # The jekyll website Yes we want the blog functionality provided by jekyll. We also want solid documentation, the [github documentation](https://docs.github.com/en) theme is the three column style we want to mimick. The left column is the overall sections, middle column is the current page and right column is the table of contents for the current page. Finally we want a public roadmap that the community can follow. Let's take a note from github on this one and mimick what they're doing in their [public roadmap repo](https://github.com/github/roadmap) and [discussions](https://github.com/github/feedback/discussions)

    No due date