docs: document Martyrology as the fifth umbrella property - #24
Merged
Conversation
Both top-level docs still described a four-property umbrella, though
Martyrology's Org, Project, API + frontend OIDC apps, OpenFGA store and
handoff have all landed in the scripts and auth/README.md.
README.md:
- Add Martyrology API (CatholicOS/martyrology-api) to the property list,
and Martyrology to the per-property Org list.
- Phase 1 wiring line said "LiturgicalCalendarAPI only"; it is now
LitCal + CDCF Website + Martyrology, with BibleGet and OntoKit still
pre-provisioned stubs.
docs/SYSADMIN.md:
- Property lists and Org counts: four -> five.
- Component inventory: add the Martyrology authz model + tuples file.
- 4.7: --all ran three actions when this was written and now runs seven
(setup-zitadel.sh:125). Describe the four added actions, including the
Martyrology frontend's staging skip, plus a warning that the three
confidential apps print their client_secret exactly once.
- 4.7 / 10.2: the rename step cited PUT /management/v1/users/{id}/username,
but the script only ever calls PATCH /v2/users/{id} with the empty
`human` discriminator (setup-zitadel.sh:294-299), which is what 9.6
already documented. All three references now agree; the v1 endpoint is
kept in 10.2 as a manual one-off only.
- 4.8: was LitCal-only. Now covers both stores, tuples-file seeding
(structural tuples only, no deletes, drift reported), and the generic
--create-store / --seed-tuples actions.
- 4.9: covers all three handoffs, and notes that a handoff may keep its
placeholders deliberately, with canonical values in the VPS
provisioning log.
auth/setup-zitadel.sh:
- Same four/five drift in the --create-orgs header comment; usage() was
already correct.
Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Pro Plus Run ID: 📒 Files selected for processing (3)
📝 WalkthroughWalkthroughThe documentation now defines Martyrology as the fifth CDCF property. It updates Phase 1 wiring, Zitadel and OpenFGA provisioning, application handoff procedures, and user-renaming endpoint guidance. ChangesMartyrology Phase 1
Estimated code review effort: 2 (Simple) | ~10 minutes Possibly related PRs
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches📝 Generate docstrings
🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
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
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.
README.mdanddocs/SYSADMIN.mdboth still described a four-property umbrella, even though Martyrology's Org, Project, API + frontend OIDC apps, OpenFGA store and handoff doc have all landed (auth/README.mdand the setup scripts were already correct). This brings the two top-level docs back in line with the scripts.README.md
CatholicOS/martyrology-api) to the property list, andMartyrologyto the per-property Org list.auth/README.md.docs/SYSADMIN.md
.tuples.json.--allran three actions when this was written and now runs seven (auth/setup-zitadel.sh:125). Documents the four added actions, including the Martyrology frontend's staging skip, plus a warning that the three confidential apps print theirclient_secretexactly once and a re-run cannot recover it.PUT /management/v1/users/{id}/username, but the script only ever callsPATCH /v2/users/{id}with the emptyhumandiscriminator (auth/setup-zitadel.sh:294-299), which is what §9.6 already said. All three references now agree; the v1 endpoint stays in §10.2 as a manual one-off only.--create-store/--seed-tuplesactions.<populated on first run>placeholders, with canonical values in the on-VPS provisioning log.auth/setup-zitadel.sh
--create-orgsheader comment.usage()was already correct.Docs only — no script behaviour changes.
🤖 Generated with Claude Code
Summary by CodeRabbit