{"repo":"userbradley/documentation.breadnet.co.uk","free":true,"listed":false,"github":"https://github.com/userbradley/documentation.breadnet.co.uk","clone":"git clone https://github.com/userbradley/documentation.breadnet.co.uk.git","description":"Documentation on everything, freely available. Maintained by @userbradley. ISSN: 2755-8169","language":"HTML","stars":11,"topics":["documentation","markdown","mkdocs","aws","gcp","kubernetes","breadnet","gke","google-kubernetes","mkdocs-material"],"license":"AGPL-3.0","category":"docs-static-sites","readme_excerpt":"breadNET Documentation ISSN: 2755-8169 This repo houses all the public documentation that I have created over the years, recently migrated to mkdocs You can access it at documentation.breadnet.co.uk What is the tech stack This site runs on fly.io and is built using GitHub actions Why mkdocs I used to run Bookstack for my documentation when I used to live at my parents house (because electricity was basically free) but since moving out I was unable to take my 48U server rack with me. Thanks Tory Government. Mkdocs is simple and flexible where I need it to be, but has very little attack surface. In fact, if you can breach the website and prove a reverse shell I will pay you. Mkdocs uses markdown files making it easy to use, as most engineers know how to write markdown Why Migrate I used to run bookstack, but since moving I found it was becoming annoying to run and maintain the server. MKdocs runs as a docker container on anywhere that runs docker, or allows static content to be hosted. How to Contribute If you see an issue with a page or something isn't right, please contribute changes back. You can also message me on matrix if you spot an issue Software you need installed to contribute 1. Podman or Docker 2. Pre-commit Make a fork of this repo to your account, make the changes then run the below Or if you are using Docker: Navigate to http://localhost:8080 where you will see the site rendered. Pre commit We use pre-commit on this repo to keep bad things out This will install t","default_branch":null,"files":null,"tree":[],"storefront":"/r/userbradley","claimed":false,"request_supported":{"post":"https://gitbuyer.com/r/userbradley/documentation.breadnet.co.uk/request-supported","requests":0},"note":"indexed from public GitHub; nothing is for sale on this page. Clone it from GitHub. Paid listings live at /search."}