steve
bb4ed3502d
P5-01 — Documentation site under docs/book/ rendered with mdBook
(downloaded via Makefile, same static-binary pattern as Tailwind).
Structured chapters: getting started, concepts, operations,
security, reference. `make docs` / `make docs-watch`. Generated
output gitignored.
P5-02 — CONTRIBUTING.md rewritten from placeholder to a full
guide. CODE_OF_CONDUCT.md adapted from Contributor Covenant for a
single-maintainer project. .gitea/issue_template/{bug,feature}.md
and PULL_REQUEST_TEMPLATE.md.
P5-04 — Six README screenshots captured live from a fresh server
bootstrap (login, empty dashboard, add-host, alerts, settings,
audit log). README rewritten to centre the screenshot grid and
link out to the docs site.
P5-05 — SECURITY.md with disclosure policy (3-day ack, 30-day
default window), scope in/out, threat-model summary, operator
hardening checklist. Mirrored as a docs-site chapter.
P5-06 — End-to-end test harness. e2e/compose.e2e.yml brings up
server + sibling Linux agent (alpine + restic) + restic/rest-server.
Agent uses announce-and-approve so Playwright can drive the full
operator flow: bootstrap → login → accept pending → backup →
verify terminal status. Second spec scrapes /metrics to assert
the P6-04 endpoint surface. .gitea/workflows/e2e.yml runs on every
PR; local how-to in docs/e2e.md.
33 lines
935 B
Markdown
33 lines
935 B
Markdown
<!--
|
|
Thanks for the PR! A few quick checks before submitting:
|
|
|
|
* Did you open an issue first for non-trivial changes?
|
|
* `make lint test` is green locally?
|
|
* Commits are focused (one logical change per commit)?
|
|
* No `Co-Authored-By` trailers (repo policy)?
|
|
* No new dependencies without a one-line justification below?
|
|
-->
|
|
|
|
## Summary
|
|
|
|
<!-- One paragraph: what changed and why. -->
|
|
|
|
## Test plan
|
|
|
|
<!-- Bullet list of what you actually ran. Be specific.
|
|
- `make test` → green
|
|
- Manually exercised the new flow at /hosts/{id}/foo
|
|
- Smoke env: enrolled a fresh host, ran a backup end-to-end
|
|
-->
|
|
|
|
## Notes for the reviewer
|
|
|
|
<!-- Anything the reviewer needs to know that isn't obvious from the
|
|
diff: related issue, follow-up work that's intentionally not
|
|
in this PR, deferred concerns, design alternatives considered
|
|
and rejected. -->
|
|
|
|
## Linked issues
|
|
|
|
<!-- "Closes #123" / "Refs #456" / "Part of P5-06" -->
|