Fix the remaining stale items in the Docker volume docs

Abierto Apto para principiantes
  • ¿Algo no está bien?
#467 0 comentarios 0 reacciones 0 asignados Ver en GitHub

Los mantenedores suelen responder en 1 día

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
2/5
Tiempo estimado
1-3 horas
Aptitud para principiantes
67/100
Tipo de issue
Documentación
Claridad
Bien especificado
Estado de actividad
Activo
Stack tecnológico
csharp, docker, docker-compose
Área
documentation

Línea de trabajo

Lee docs/DOCKER_CONFIGURATION.md, docs/VOLUMES.md y docs/VOLUME_TESTING.md en main después de #466; comprueba primero el Test 2 para ver si su encabezado ya está presente. Actualiza únicamente esos documentos para describir los volúmenes con nombre y la raíz del repositorio, documenta seq-data como <project>_seq-data y añade las advertencias especificadas sobre la pérdida de datos. Revisa cada bloque de comandos indicado según los criterios de aceptación; no corresponden pruebas porque se trata de un cambio en la documentación.

Escrito por el modelo de indexación a partir del texto del issue.

Descripción

Follow-up to #460 (merged in #466). Part of #403. Docs only: branch from main and open the PR against main. Not groomed: the Test 2 item below needs a look first. Line numbers are from main after #466.

Problem

The review of #466 deferred these items to keep that PR to the naming rule. Each is a small doc inaccuracy or a data-safety gap in the three Docker volume docs.

  1. docs/DOCKER_CONFIGURATION.md lines 545 and 574. Both still describe ./data and ./logs bind mounts (./data:/app/data, ./logs:/app/logs), while the compose files use named volumes.
  2. docs/VOLUME_TESTING.md lines 196-197. The script says "Change to your TaskFlow.Api repository directory" with the example cd ~/projects/TaskFlow.Api. The compose files are at the repo root. The same error was fixed at line 23 in #466.
  3. docs/VOLUME_TESTING.md, Test 2 (line 74). The implementation notes on #460 say a step heading is missing. Check Test 2 and add the heading, or drop this item if it is already complete.
  4. seq-data is not documented in docs/VOLUMES.md. docker-compose.yml defines it, and DOCKER_CONFIGURATION.md lists it in the dev row.
  5. Unwarned volume-deleting commands. #466 added a "this deletes your data permanently" warning only to the blocks it edited. These have none:
    • docker compose down -v: VOLUMES.md lines 161, 405 and 457; VOLUME_TESTING.md lines 204, 301 and 320.
    • VOLUMES.md line 124 and the docker volume rm and docker volume prune lines at 264 and 267 sit under the warning added in #466; check they are covered.

Change

Edit docs/DOCKER_CONFIGURATION.md, docs/VOLUMES.md and docs/VOLUME_TESTING.md only.

  • Fix items 1 and 2 to describe named volumes and the repo root.
  • Do item 3 only if the heading is really missing.
  • Add a short seq-data entry to VOLUMES.md, using the same naming rule as #460 (compose key seq-data, real name <project>_seq-data).
  • For item 5, put a one-line "this deletes your data permanently" warning by each bare down -v that is meant for users to run. In VOLUME_TESTING.md, a down -v inside the test script's cleanup (line 204) needs a comment saying it removes the project's volumes, not a user-facing warning. Do not add any new suggestion to delete a volume.
  • Do not run any command that creates or removes a volume. docker compose config --volumes is fine.

Acceptance criteria

  1. DOCKER_CONFIGURATION.md no longer describes ./data and ./logs bind mounts as the current setup.
  2. VOLUME_TESTING.md no longer tells the reader to change to a TaskFlow.Api directory for compose commands.
  3. VOLUMES.md documents seq-data with the #460 naming rule.
  4. Every user-facing down -v and docker volume rm or prune line in the three files has a data-loss warning within its block.
  5. No compose file, .env or volume changes; 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.
  • The live API port and the down -v in ci.yml.
  • Rewriting the test procedures beyond the items above.
Lenguaje dominante
C#
Estrellas
1
Forks
0
Merge medio
2 h 28 min
PR fusionados (30 d)
107

Preparar el entorno

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Más de nevridge/TaskFlow

Todos los issues de nevridge/TaskFlow

Issues similares

Más issues de C#

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.