Skip to content

docs: document Martyrology as the fifth umbrella property - #24

Merged
JohnRDOrazio merged 1 commit into
mainfrom
docs/add-martyrology-umbrella-property
Aug 4, 2026
Merged

docs: document Martyrology as the fifth umbrella property#24
JohnRDOrazio merged 1 commit into
mainfrom
docs/add-martyrology-umbrella-property

Conversation

@JohnRDOrazio

@JohnRDOrazio JohnRDOrazio commented Aug 4, 2026

Copy link
Copy Markdown
Member

README.md and docs/SYSADMIN.md both 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.md and the setup scripts were already correct). This brings the two top-level docs back in line with the scripts.

README.md

  • Adds Martyrology API (CatholicOS/martyrology-api) to the property list, and Martyrology to the per-property Org list.
  • The "Phase 1 wiring: LiturgicalCalendarAPI only" line was stale on two counts — cdcf-website and Martyrology are both wired now. Matches auth/README.md.

docs/SYSADMIN.md

  • Property lists and Org counts: four → five (§ header, §1, §4).
  • Component inventory: adds the Martyrology authz model + .tuples.json.
  • §4.7--all ran 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 their client_secret exactly once and a re-run cannot recover it.
  • §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 (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.
  • §4.8 — was LitCal-only; now covers both stores, tuples-file seeding (structural tuples only, never deletes, drift reported), and the generic --create-store / --seed-tuples actions.
  • §4.9 — covers all three handoffs, and notes a handoff may deliberately keep its <populated on first run> placeholders, with canonical values in the on-VPS provisioning log.

auth/setup-zitadel.sh

  • Same four/five drift in the --create-orgs header comment. usage() was already correct.

Docs only — no script behaviour changes.

🤖 Generated with Claude Code

Summary by CodeRabbit

  • Documentation
    • Updated project documentation to include Martyrology as a fifth CDCF property.
    • Documented authentication, provisioning, frontend applications, and access-control setup for Martyrology and the CDCF Website.
    • Clarified user-renaming procedures and administrative handoff steps.
  • Chores
    • Updated setup guidance to reflect creation of five umbrella organizations.

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>
@coderabbitai

coderabbitai Bot commented Aug 4, 2026

Copy link
Copy Markdown

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro Plus

Run ID: 16d7453c-8f36-4f54-a723-0077c8ee0959

📥 Commits

Reviewing files that changed from the base of the PR and between eca6718 and 8e39c53.

📒 Files selected for processing (3)
  • README.md
  • auth/setup-zitadel.sh
  • docs/SYSADMIN.md

📝 Walkthrough

Walkthrough

The 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.

Changes

Martyrology Phase 1

Layer / File(s) Summary
Platform scope and component inventory
README.md, docs/SYSADMIN.md
The documented CDCF property count increases to five. Phase 1 wiring, component inventory, shared infrastructure, and completion criteria now include Martyrology.
Provisioning and handoff procedures
auth/setup-zitadel.sh, docs/SYSADMIN.md
Provisioning guidance covers five umbrella Orgs, CDCF Website and Martyrology applications, OpenFGA stores and models, tuple seeding, client secrets, and handoff procedures.
User-renaming endpoint guidance
docs/SYSADMIN.md
The handbook states that provisioning uses the v2 PATCH endpoint and documents the legacy endpoint for manual use.

Estimated code review effort: 2 (Simple) | ~10 minutes

Possibly related PRs

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly summarizes the primary documentation change: adding Martyrology as the fifth umbrella property.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches
📝 Generate docstrings
  • Create stacked PR
  • Commit on current branch
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/add-martyrology-umbrella-property

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.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@JohnRDOrazio
JohnRDOrazio merged commit 6b9fe65 into main Aug 4, 2026
1 check passed
@JohnRDOrazio
JohnRDOrazio deleted the docs/add-martyrology-umbrella-property branch August 4, 2026 09:08
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant