docs: use one volume-naming rule across the Docker volume docs

Aperta Adatta ai principianti
  • Qualcosa non va?
#460 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

I maintainer di solito rispondono entro 1 giorno

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
2/5
Tempo stimato
1-3 ore
Idoneità per principianti
68/100
Tipo di issue
Documentazione
Chiarezza
Specificata chiaramente
Stato di attività
Attiva
Stack tecnologico
docker, docker-compose
Ambito
documentation

Direzione di ricerca

Leggi i tre file indicati: docs/DOCKER_CONFIGURATION.md, docs/VOLUMES.md e docs/VOLUME_TESTING.md, poi confronta i nomi dei volumi con docker-compose.yml, docker-compose.prod.yml e docker-compose.test.yml. Aggiorna solo quei documenti, in modo che le chiavi Compose siano identificate come chiavi, i comandi Docker usino il nome del volume con il prefisso del progetto, sia presente l’avvertenza relativa al backup e al ripristino e vengano corretti i nomi e le date obsolete degli esempi. Non sono previsti test perché si tratta solo di documentazione.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

Follow-up to #444 (merged in #459). Part of #403. Docs only: branch from main and open the PR against main.

Problem

#444 documented that the real Docker volume names are <project>_<key> (for example taskflowapi_taskflow-data on the owner's machine). The other volume docs still use bare compose keys or hand-made names, so some commands in them do not match any real volume. The implementation notes on #444 listed three of these; checking them against main found more.

  1. docs/DOCKER_CONFIGURATION.md, "Volume Mounts" (about line 127). "Both environments use named Docker volumes" lists taskflow-data and taskflow-logs. The local prod harness (docker-compose.prod.yml) uses the keys taskflow-data-prod and taskflow-logs-prod, and every real name carries the project prefix. The new "Compose Project Name" section right after the table explains the prefix, so the table now sits above its own correction.
  2. docs/VOLUMES.md mixes three naming schemes.
    • Bare keys (taskflow-data, taskflow-logs) in docker volume inspect and docker volume rm (about lines 140, 250, 257).
    • Hand-made taskflow-prod-data and taskflow-prod-logs in the manual prod example (about lines 175-214).
    • taskflow-data-prod and taskflow-logs-prod for the compose harness (about line 231).
    • Data-safety point: the backup and restore commands (about lines 275-310) run docker run -v taskflow-data:/data .... Docker creates a named volume that does not exist, so on a machine where the real volume is <project>_taskflow-data this command silently mounts a new empty volume. A backup would contain nothing, and a restore would write into a stray volume.
  3. docs/VOLUME_TESTING.md. The sample docker volume inspect output has a CreatedAt of 2024-11-02T... (stale), and its commands hard-code the owner's project name taskflowapi_ (about lines 34-55, 349 and 368). #444 chose to name no machine-specific project in DOCKER_CONFIGURATION.md.

Change

Edit docs/DOCKER_CONFIGURATION.md, docs/VOLUMES.md and docs/VOLUME_TESTING.md only. One naming rule, applied everywhere:

  • When describing compose configuration, use the compose key (taskflow-data), and say it is a key.
  • In any docker volume ... or docker run -v ... command, use <project>_<key> with <project> as a placeholder, and point to the "Compose Project Name" section and docker volume ls --filter name=taskflow for finding the real name.
  • Name the prod harness keys correctly (taskflow-data-prod, taskflow-logs-prod). For the manual docker volume create example, either keep its own names with a sentence saying it is separate from the harness, or switch it to the harness names; pick one and say which.
  • Fix the stale CreatedAt sample, and replace the hard-coded taskflowapi_ in VOLUME_TESTING.md.
  • Put a one-line warning by the backup and restore commands: use the real, prefixed volume name, because a wrong name creates an empty volume.
  • Check each command against docker-compose.yml, docker-compose.prod.yml and docker-compose.test.yml (read-only; docker compose config --volumes is fine). Do not run any command that removes or creates a volume.

Acceptance criteria

  1. The "Volume Mounts" table in DOCKER_CONFIGURATION.md no longer presents bare keys as the Docker volume names, and names the prod harness keys correctly.
  2. VOLUMES.md uses one consistent naming rule; its inspect, remove, backup and restore commands use the project-prefixed name, with the backup and restore warning.
  3. VOLUME_TESTING.md has no stale 2024-11-02 sample and no hard-coded taskflowapi_.
  4. No compose file, .env or volume changes, and nothing suggests deleting a volume. The owner's decision on #444 stands: the taskflow_* volumes are kept.
  5. Only the three docs files change.

Tests

No tests apply (docs only). Say so in the PR body.

Out of scope

  • Adding name: to the compose files (a later option, documented in #459).
  • The live API port (8081 in the doc, 8080 in the gitignored local override) and the bare docker compose up/down -v in ci.yml, which is safe today because the runner has no .env.
  • The test-stack text already fixed in #459.
Lingua principale
C#
Stelle
1
Fork
0
Merge medio
2h 2m
PR unite (30g)
98

Preparare l'ambiente

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di nevridge/TaskFlow

Tutte le issue di nevridge/TaskFlow

Issue simili

Altre issue su C#

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.