optimize(doc): add resources/templates/README.md.tpl + DEPLOY.md.tpl + reference (d6 target)

This commit is contained in:
bastien
2026-05-06 18:32:16 +02:00
parent 8df5f2c6ca
commit b26a94d779
3 changed files with 97 additions and 0 deletions
@@ -0,0 +1,49 @@
# Deploy
Stack: {{STACK}}
Target: {{DEPLOY_TARGET}}<!-- e.g. Vercel, fly.io, Docker on VPS, k8s -->
## Prerequisites
- {{REQUIRED_TOOLS}}<!-- gh, fly, docker, kubectl, etc. -->
- Environment variables set in {{ENV_LOCATION}}<!-- .env / Vercel dashboard / GH secrets -->
## Build
```bash
{{BUILD_CMD}}
```
Verify the build artifact at `{{BUILD_OUTPUT_DIR}}` is non-empty before proceeding.
## Deploy
```bash
{{DEPLOY_CMD}}
```
## Verify
```bash
{{HEALTH_CHECK_CMD}}<!-- curl /healthz or equivalent -->
```
Expected response: `{{EXPECTED_RESPONSE}}`.
## Rollback
```bash
{{ROLLBACK_CMD}}<!-- e.g. fly releases rollback <id>, kubectl rollout undo, vercel rollback -->
```
## Common failures
| Symptom | Cause | Fix |
|---|---|---|
| {{SYMPTOM_1}} | {{CAUSE_1}} | {{FIX_1}} |
| Build fails on `{{COMMON_BUILD_ERR}}` | Likely env var missing | Check {{ENV_LOCATION}} has {{REQUIRED_VARS}} |
## Logs / monitoring
- Logs: `{{LOG_CMD}}`
- Monitoring: {{MONITORING_URL}}<!-- Grafana / Sentry / Vercel analytics -->