This repository contains opinionated documentation for deploying to the Ma'ayan Lab Kubernetes Cluster. Files are just markdown, and jupyter-book is used to turn them into a webpage.
While you can add new files to some of the directories, if you add new directories or new root-level files, they'll need to be added to _toc.yml.
# install python dependencies
pip install -r requirements.txt
# remove old build
rm -r src/_build
# generate table of contents
jupyter-book toc from-project src > src/_toc.yml
# build
jupyter-book build src
# the resulting book is in _build/html, the html can be viewed with any static web browser (including just opening _build/html/index.html in your browser)
npx http-server src/_build/htmlThis can be deployed directly to the Cluster, see deploy docs for that, but essentially it's just:
docker compose build
docker compose push
kube-compose up