docs: use one volume-naming rule across the Docker volume docs
维护者通常 1 天内回复
还没有人认领这个 Issue。
评估
- 难度
- 2/5
- 预计耗时
- 1-3 小时
- 新手友好度
- 68/100
- Issue 类型
- 文档
- 描述清晰度
- 描述清楚
- 活跃度
- 活跃
- 技术栈
- docker, docker-compose
调研方向
阅读列出的三个文件:docs/DOCKER_CONFIGURATION.md、docs/VOLUMES.md 和 docs/VOLUME_TESTING.md,然后将其中的卷名称与 docker-compose.yml、docker-compose.prod.yml 和 docker-compose.test.yml 进行比较。只更新这些文档,确保将 Compose 键标识为键,Docker 命令使用带项目名前缀的卷名称,包含有关备份和恢复的警告,并修正过时的示例名称和日期。这只是文档修改,不需要进行测试。
由索引模型根据 Issue 内容生成。
描述
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.
docs/DOCKER_CONFIGURATION.md, "Volume Mounts" (about line 127). "Both environments use named Docker volumes" liststaskflow-dataandtaskflow-logs. The local prod harness (docker-compose.prod.yml) uses the keystaskflow-data-prodandtaskflow-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.docs/VOLUMES.mdmixes three naming schemes.- Bare keys (
taskflow-data,taskflow-logs) indocker volume inspectanddocker volume rm(about lines 140, 250, 257). - Hand-made
taskflow-prod-dataandtaskflow-prod-logsin the manual prod example (about lines 175-214). taskflow-data-prodandtaskflow-logs-prodfor 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-datathis command silently mounts a new empty volume. A backup would contain nothing, and a restore would write into a stray volume.
- Bare keys (
docs/VOLUME_TESTING.md. The sampledocker volume inspectoutput has aCreatedAtof2024-11-02T...(stale), and its commands hard-code the owner's project nametaskflowapi_(about lines 34-55, 349 and 368). #444 chose to name no machine-specific project inDOCKER_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 ...ordocker run -v ...command, use<project>_<key>with<project>as a placeholder, and point to the "Compose Project Name" section anddocker volume ls --filter name=taskflowfor finding the real name. - Name the prod harness keys correctly (
taskflow-data-prod,taskflow-logs-prod). For the manualdocker volume createexample, 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
CreatedAtsample, and replace the hard-codedtaskflowapi_inVOLUME_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.ymlanddocker-compose.test.yml(read-only;docker compose config --volumesis fine). Do not run any command that removes or creates a volume.
Acceptance criteria
- The "Volume Mounts" table in
DOCKER_CONFIGURATION.mdno longer presents bare keys as the Docker volume names, and names the prod harness keys correctly. VOLUMES.mduses one consistent naming rule; its inspect, remove, backup and restore commands use the project-prefixed name, with the backup and restore warning.VOLUME_TESTING.mdhas no stale2024-11-02sample and no hard-codedtaskflowapi_.- No compose file,
.envor volume changes, and nothing suggests deleting a volume. The owner's decision on #444 stands: thetaskflow_*volumes are kept. - 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 (
8081in the doc,8080in the gitignored local override) and the baredocker compose up/down -vinci.yml, which is safe today because the runner has no.env. - The test-stack text already fixed in #459.
- 主要语言
- C#
- 星标
- 1
- 派生
- 0
- 平均合并
- 2 小时 2 分钟
- 30 天内合并 PR
- 98
环境准备
- 提供 Dockerfile 或 Docker Compose 文件
- 没有 Pull Request 模板
- 阅读贡献指南
从这里开始
- 先读完整个 Issue,再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库,在一个分支上完成修改。
- 提交 Pull Request,并在描述里引用这个 Issue 编号。
nevridge/TaskFlow 的其他 Issue
-
难度 2/5 1-3 小时 新手友好度 78/100
维护者通常 1 天内回复
-
难度 2/5 1-3 小时 新手友好度 78/100
维护者通常 1 天内回复
-
bug
难度 2/5 1-3 小时 新手友好度 65/100
维护者通常 1 天内回复
-
tech-debt
难度 2/5 1-3 小时 新手友好度 78/100
维护者通常 1 天内回复
-
难度 2/5 1-3 小时 新手友好度 77/100
维护者通常 1 天内回复
查看 nevridge/TaskFlow 的全部 Issue
相似的 Issue
-
难度 2/5 1-3 小时 新手友好度 74/100
juandresrodca/AdminForge#54 ·
-
要トリアージ 辞書
难度 1/5 1-3 小时 新手友好度 86/100
yksr-melt/Meltype#1625 · 1 个 reaction ·
维护者通常 1 天内回复
-
Docs typo未关闭
难度 1/5 1 小时以内 新手友好度 78/100
MonoGame/docs.monogame.github.io#328 · 1 条评论 ·
-
难度 2/5 1-3 小时 新手友好度 70/100
space-wizards/RobustToolbox#7197 ·
维护者通常 1 天内回复
-
documentation high priority
难度 2/5 1-3 小时 新手友好度 76/100
lachydotmcg/capri-desktop#201 ·
维护者通常 1 天内回复