Fix the remaining stale items in the Docker volume docs

Đang mở Phù hợp với người mới
  • Có gì không ổn?
#467 0 bình luận 0 reaction 0 người được giao Xem trên GitHub

Maintainer thường phản hồi trong vòng 1 ngày

Chưa có ai nhận issue này.

Đánh giá

Độ khó
2/5
Thời gian dự kiến
1-3 giờ
Mức phù hợp với người mới
67/100
Loại issue
Tài liệu
Độ rõ ràng
Đặc tả rõ ràng
Mức độ hoạt động
Sôi nổi
Công nghệ
csharp, docker, docker-compose
Lĩnh vực
documentation

Hướng nghiên cứu

Đọc docs/DOCKER_CONFIGURATION.md, docs/VOLUMES.md và docs/VOLUME_TESTING.md trên main sau #466; trước tiên kiểm tra Test 2 để xem tiêu đề của mục này đã có chưa. Chỉ cập nhật các tài liệu đó để mô tả các volume được đặt tên và thư mục gốc của repository, ghi rõ seq-data là <project>_seq-data và thêm các cảnh báo mất dữ liệu được chỉ định. Đối chiếu từng khối lệnh được liệt kê với các tiêu chí nghiệm thu; không áp dụng kiểm thử vì đây là thay đổi tài liệu.

Do mô hình lập chỉ mục viết ra từ nội dung của issue.

Mô tả

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.
Ngôn ngữ chính
C#
Star
1
Fork
0
Merge trung bình
2 giờ 28 phút
Pull request đã merge (30 ngày)
107

Chuẩn bị môi trường

Bắt đầu từ đâu

  1. Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
  2. Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
  3. Fork repository và làm thay đổi trên một nhánh.
  4. Mở pull request có tham chiếu số hiệu của issue.

Issue khác của nevridge/TaskFlow

Tất cả issue của nevridge/TaskFlow

Issue tương tự

Thêm issue về C#

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.