docs: consolidate documentation, add examples, and mdBook site#40
Merged
miguelgila merged 5 commits intomainfrom Mar 19, 2026
Merged
docs: consolidate documentation, add examples, and mdBook site#40miguelgila merged 5 commits intomainfrom
miguelgila merged 5 commits intomainfrom
Conversation
…ease mode - Remove deprecated example 10 (wren-job-api) - Add example 10-slurm-hpc (mixed runtimes: containerized scheduler + Reaper workers) - Add example 11-node-monitoring (Prometheus node_exporter via Reaper + Prometheus server) - Implement --release mode in setup-playground.sh (pull pre-built GHCR images) - Fix broken CI badges in README (test.yml/build.yml → ci.yml) - Restructure README (~200 lines): extract Pod Compatibility and Annotations to docs/ - Create docs/CONFIGURATION.md and docs/COMPATIBILITY.md - Set up mdBook documentation site (docs/book/) with include directives - Add GitHub Actions workflow for docs build and GitHub Pages deployment - Update docs/DEVELOPMENT.md CI section to reflect unified ci.yml Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Move raw Pod + runtimeClassName examples to the quick-start guide in the docs site. README now leads with ReaperPod CRD for all usage examples (run command, volumes, node selector). Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
No local mdbook install needed — uses peaceiris/mdbook container. - `make docs` builds the site to docs/book/book/ - `make docs-serve` serves with live-reload on http://localhost:3000 - `make clean` now also removes built docs Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Examples 10 and 11 now accept --release [VERSION] which is passed through to setup-playground.sh to use pre-built GHCR images instead of building from source. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #40 +/- ##
=======================================
Coverage 85.04% 85.04%
=======================================
Files 6 6
Lines 301 301
=======================================
Hits 256 256
Misses 45 45 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
- Use debian:12 for slurmctld and test-job (matches Kind node Slurm 22.05) - Run all Slurm daemons as root (overlay filters /etc/gshadow, see #41) - Add cgroup.conf with CgroupPlugin=cgroup/v1 (Kind lacks dbus/systemd) - Auto-detect node names and CPU count in setup.sh ConfigMap generation - Use --no-install-recommends and dpkg --fix-broken for robust apt installs - Pass -N $(hostname) to slurmd for dynamic node registration - Switch test job from srun to sbatch (avoids reverse connection issue) Tested: slurmctld running, 2 slurmd nodes registered and executing jobs. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
--releasemode insetup-playground.sh— pulls pre-built GHCR images instead of building locally (--releasefor latest,--release v0.2.14for specific version)test.yml/build.yml→ci.yml)docs/COMPATIBILITY.md, annotations/config todocs/CONFIGURATION.mddocs/book/) with{{#include}}directives to avoid content duplication.github/workflows/docs.yml) for building docs on PR and deploying to GitHub Pages on push to mainTest plan
cargo clippy --workspace --all-targets -- -D warnings— cleancargo test --workspace— 152 tests passscripts/test-examples.sh --skip-cluster— 32 YAML validations pass (including 5 new)bash -n scripts/setup-playground.sh— syntax OKsetup-playground.sh --helpshows--releaseoption{{#include}}paths verified to resolve correctlymdbook build docs/booksucceeds in CI (mdbook not installed locally)🤖 Generated with Claude Code