From 6498c5b6d5e6c6cc427055c3fd63061758b6f614 Mon Sep 17 00:00:00 2001 From: disqualifier Date: Mon, 29 Jun 2026 23:50:42 -0400 Subject: [PATCH] rename path segment to , unify /srv paths MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Host paths now follow one shape: /srv//// across configs, logs, and mounts (mounts added as its own row; configs gains the workspace segment it was missing). - deploy.md: compose volumes, paths table, secrets path + rotation snippet all use ; add a yellow (warning) admonition ABOVE the table explaining it — individual dev = lowercase username (ricky, xattam), shared/official project = workspace (bots, web, apis) — so it stands out from the all-blue palette and reads before the table. - index.md: placeholder example uses . Verified in-browser; mkdocs build --strict clean. Signed-off-by: disqualifier --- docs/deploy.md | 30 ++++++++++++++++++++---------- docs/index.md | 3 ++- 2 files changed, 22 insertions(+), 11 deletions(-) diff --git a/docs/deploy.md b/docs/deploy.md index 8d686d0..6f43045 100644 --- a/docs/deploy.md +++ b/docs/deploy.md @@ -48,9 +48,9 @@ services: environment: HOME: /tmp volumes: - - /srv/configs/:/app/config:ro # (2)! - - /srv/logs//:/app/logs # (3)! - - yourapp-data:/app/data # (4)! + - /srv/configs//:/app/config:ro # (2)! + - /srv/logs//:/app/logs # (3)! + - yourapp-data:/app/data # (4)! volumes: yourapp-data: @@ -65,10 +65,20 @@ volumes: ## Paths and mounts +Everything host-side follows one shape: `/srv////`. + +!!! warning "What `` is" + `` is the owning bucket for a project. + + - **An individual dev?** It's your **lowercase username** — `ricky`, `xattam`, … + - **A shared / official project?** It's the **workspace** it belongs to — + `bots`, `web`, `apis`, … + | What | Where | How | | --- | --- | --- | -| Configs | `/srv/configs//` | bind mount, host-managed, read-only | -| Logs | `/srv/logs///` | bind mount; live + rolled, scraped | +| Configs | `/srv/configs///` | bind mount, host-managed, read-only | +| Logs | `/srv/logs///` | bind mount; live + rolled, scraped | +| Mounts (other host-visible data) | `/srv/mounts///` | bind mount, host-managed | | Caches, profiles, scratch | named volume | Docker manages ownership | !!! note "If your service won't start or its logs aren't persisting" @@ -133,13 +143,13 @@ services: !!! warning "Secrets never go in the image" We do **not** commit secrets (usually, lol). They stay **gitignored**, live on - the host at `/srv/configs//`, and are bind-mounted **read-only** at - runtime. Add them to `.dockerignore` so a `COPY . .` can't sweep them into a - layer. + the host at `/srv/configs///`, and are bind-mounted + **read-only** at runtime. Add them to `.dockerignore` so a `COPY . .` can't + sweep them into a layer. Rotating a secret = edit the host file and restart. No rebuild. ```bash -vim /srv/configs//secrets.env # edit on the host -docker compose restart yourapp # pick up the change — no rebuild +vim /srv/configs///secrets.env # edit on the host +docker compose restart yourapp # pick up the change — no rebuild ``` diff --git a/docs/index.md b/docs/index.md index 9c8d63d..e361996 100644 --- a/docs/index.md +++ b/docs/index.md @@ -5,7 +5,8 @@ coding standards, and how to get a project deployed. This is a public site — it documents generic patterns and conventions. Real infrastructure specifics (hostnames, internal IPs, exact topology, secrets) stay -out of it; examples use placeholders like ``, ``, and `/srv/...`. +out of it; examples use placeholders like ``, ``, and +`/srv/...`. !!! tip "Point your coding agent here" Want your agent aware of our libraries, standards, and deploy rules before it