-
Notifications
You must be signed in to change notification settings - Fork 0
Open
Labels
documentationImprovements or additions to documentationImprovements or additions to documentation
Description
Problem
examples/12-daemon-job/ is missing documentation and setup scripts that other examples have:
- No
README.md— examples 10 and 11 have detailed READMEs explaining prerequisites, usage, and expected output - No
setup.sh— some examples (e.g., 04-volumes) include setup scripts for one-command deployment - Not mentioned in quick start guide —
docs/book/src/getting-started/quick-start.mdshould reference ReaperDaemonJob - Not mentioned in documentation site —
docs/book/src/reference/crds.mdshould document the ReaperDaemonJob CRD alongside ReaperPod and ReaperOverlay
What's needed
-
Add
examples/12-daemon-job/README.mdwith:- Overview of ReaperDaemonJob concept
- Prerequisites (CRD installed, controller running)
- Step-by-step usage for both examples (simple + composable)
- Expected output and verification commands
-
Add
examples/12-daemon-job/setup.sh(optional) for one-command demo -
Update
docs/book/src/reference/crds.md:- Add ReaperDaemonJob CRD reference (spec fields, status fields, examples)
- Document
afterdependency ordering - Document
triggerOn,retryLimit,concurrencyPolicy
-
Update
docs/book/src/getting-started/quick-start.md:- Mention ReaperDaemonJob as a way to run node-wide configuration tasks
- Link to example 12
-
Update
examples/README.mdto include example 12 in the list
Reactions are currently unavailable
Metadata
Metadata
Assignees
Labels
documentationImprovements or additions to documentationImprovements or additions to documentation