Chore/docs and housekeeping - #169
Merged
Merged
Conversation
- Remove the outdated Setup section from the README (lerna bootstrap was removed in Lerna v7; stale frontend .env instruction) and replace the dead INSTALLATION.de.md link (deleted in the Caddy migration) with a Documentation section linking the published User Guide and the new guide. - Translate the funding section heading and add an English gloss; keep the German acknowledgment verbatim. - Add INSTALLATION.md: a general self-hosting guide for the single-server Docker Compose + Caddy setup (not tied to any specific cloud), including the deployment.sh assumptions (passwordless sudo, fixed .env.production filename, default branch, hard-reset caveat).
lerna bootstrap was removed in Lerna v7 (repo runs 8.x) and now errors. npm workspaces already link packages on npm install/npm ci, so the script had no purpose and was referenced nowhere (CI, deployment.sh, docs).
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
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
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.
Housekeeping for the docs and a dead npm script.
docs: refresh README, add Caddy install guide
The README's Setup section was stale and had a broken link:
lerna bootstrapwas removed in Lerna v7 (repo runs 8.x)[Installation Guide](INSTALLATION.de.md)link was dead.envinstruction no longer matched how config is loaded.Changes:
published User Guide and the new
installation guide.
INSTALLATION.md— a general, self-hosting guide for the single-serverDocker Compose + Caddy setup: prerequisites,
DNS/firewall,
.env.production, OIDC callback registration, deploy/verify/update,backups, and appendices for data migration and the Docker-MTU-on-overlay caveat.
Documents
deployment.sh's assumptions (passwordlesssudo, fixed.env.productionfilename, defaultproductionbranch, hard-reset behaviour).the German acknowledgment text is kept verbatim.
chore: remove dead lerna bootstrap npm script
"bootstrap": "lerna bootstrap"errors under Lerna 8, is referenced nowhere(CI,
deployment.sh, docs), and is redundant — npm workspaces link the packageson
npm install/npm ci. Removed. Lerna stays (still used aslerna run …).