Documentation updates #8
Open
Conversation
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
added 8 commits
January 1, 2026 16:30
New documentation sections: - Admin: OAuth configuration, schedule import (Frab/Pretalx) - Developer: architecture overview, database schema, CI/CD pipeline - API: authentication documentation - Shift coordinator: guide with shift management - User, supporter, bureaucrat guides expanded
- Add [languages] config for proper EN/DE separation - Remove duplicate H1 headers from 34 content files (title in front matter is sufficient for Relearn theme)
- Rewrite admin/_index.md with overview, prerequisites, quick links - Expand configuration.md from code dump to structured guide with scenarios - Expand installation.md with full K8s manifests, remove flake references - Expand translation.md with gettext details and examples - Expand developer/_index.md with dev setup guide and contribution workflow - Expand request-lifecycle.md with mermaid diagrams and debugging tips - Remove flake references from architecture.md, ci-cd.md, database.md
Replace thin role_management.md (103 lines) with comprehensive documentation (1,363 lines) covering: - All 8 current groups with complete privilege lists - All ~45 privileges with operations they enable - Security warnings for sensitive privileges - Group management instructions - Best practices section Split into two pages: - _index.md: Overview, groups reference, management guide - privileges.md: Complete privilege reference by category
Translates all missing German documentation files to sync with English versions: - Admin section: index, configuration, installation, translation - Role management: index and privileges reference - Developer section: index and request lifecycle Total: 8 files, 3,679 lines of German documentation.
- Fix homepage role table to list all 8 permission groups correctly - Clarify Supporter is a per-angel-type capability, not a system group - Add Role Management section explaining Supporter vs Groups New documentation sections: - Welcome Angel: check-in desk procedures and arrival management - Voucher Angel: voucher eligibility and distribution - Goodie Manager: t-shirt/merchandise distribution workflow Expanded existing sections: - User: messages, FAQ/Q&A, profile & certificates - Shift Coordinator: FAQ management, questions, worklogs, tags, certificates - Bureaucrat: angel types, locations, shift types All pages include German translations.
…docs - Remove "Required Permissions" sections (admin-focused, not user-facing) - Remove "Documentation" sections (Hugo handles navigation) - Remove "Related Topics" sections - Convert list fragments to complete sentences - Convert unnecessary bullet lists to prose paragraphs - Apply Genderstern in German translations (Koordinator*in, Benutzer*innen) - Use gender-neutral alternatives where possible
- Remove redundant "Documentation/Dokumentation" sections from _index files - Remove "Related Topics/Verwandte Themen" sections (Hugo handles navigation) - Remove "Required Privilege/Erforderliches Privileg" sections from role guides - Convert fragment lists to prose in news, angel-types, and shifts pages - Fix Genderstern: Benutzer→Benutzer*innen, Entwickler→Entwickler*innen
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.
No description provided.