Fix the remaining stale items in the Docker volume docs

オープン 初心者向け
  • 何か問題がありますか？
#467 コメント 0 件 リアクション 0 件 担当者 0 名 GitHub で見る

メンテナーはふだん 1 日以内に返信

まだ誰も着手していません。

評価

難易度
2/5
見積もり時間
1〜3時間
初心者へのやさしさ
67/100
issue の種類
ドキュメント
明瞭さ
明確に書かれている
活発さ
活発
技術スタック
csharp, docker, docker-compose
領域
documentation

調査の方向性

#466 の後の main で docs/DOCKER_CONFIGURATION.md、docs/VOLUMES.md、docs/VOLUME_TESTING.md を読み、まず Test 2 の見出しがすでにあるか確認してください。これらのドキュメントのみを更新し、名前付きボリュームとリポジトリのルートを説明してください。seq-data を <project>_seq-data として記載し、指定されたデータ損失の警告を追加してください。列挙された各コマンドブロックを受け入れ基準に照らして確認してください。ドキュメントの変更であるため、テストは該当しません。

索引モデルが issue の本文から書いたものです。

説明

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.
主要言語
C#
スター
1
フォーク
0
平均マージ
2時間 28分
マージ済み PR（30日）
107

環境構築

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

nevridge/TaskFlow のほかの issue

nevridge/TaskFlow の issue をすべて見る

似ている issue

C# の issue をもっと見る

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。