Handbook: administration handbook, operator content moved out of the README #139
Labels
No milestone
No project
No assignees
1 participant
Notifications
Due date
No due date set.
Dependencies
No dependencies set.
Reference
MassiveDynamic/kataba#139
Loading…
Add table
Add a link
Reference in a new issue
No description provided.
Delete branch "%!s()"
Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?
Part of #137
Depends on #138.
What
Write the Administration handbook: operating a kataba instance and the admin area of the app. The operator content moves out of
README.md— the handbook becomes the single source.Scope
Operating an instance (moved from the README, then extended where thin):
viewer,author,admin)Admin area in the app:
Use the domain terms from
GLOSSARY.md.README
Afterwards the README keeps: About, Features, Tech stack, a short Docker Compose quickstart, Development, Architecture, Roadmap, Contributing, License — plus prominent links into the handbook. Remove the moved sections (Getting started in detail, Configuration, Authentik, Roles, Backup and restore) instead of duplicating them.
Acceptance criteria
https://pages.mike-ochmann.de/kataba/zensical build --strictpassesDone in #146: the administration handbook has one page per topic (categories, pages, menu, settings, import/restore of guides, backup/restore, installation, Docker, configuration, sign-in and roles, updating), and the README is slimmed down and links into the handbook.