[docs-scanner] Inconsistent information about what gets deleted when Docker Offload v1 session ends
維護者通常 1 天內回覆
還沒有人認領這個 Issue。
評估
- 難度
- 1/5
- 預估耗時
- 1-3 小時
- 新手友好度
- 88/100
- Issue 類型
- 文件
- 描述清晰度
- 描述清楚
- 活躍度
- 活躍
研究方向
閱讀 content/manuals/offload/v1/quickstart.md 和 content/manuals/offload/v1/core-concepts.md，比較它們對工作階段停止或閒置逾時時會移除哪些內容的描述。更新快速入門中的措辭，使其符合 core-concepts 中描述的完整刪除行為，接著確認兩個檔案都一致地提及容器、映像和磁碟區。
由索引模型根據 Issue 內容生成。
描述
Files:
content/manuals/offload/v1/quickstart.mdcontent/manuals/offload/v1/core-concepts.md
Issue
The two files provide inconsistent information about what gets deleted when a Docker Offload v1 session ends or goes idle.
In core-concepts.md:
If the idle period exceeds 5 minutes without activity, the session is terminated. Docker Offload v1 environments are ephemeral, so the remote environment and any containers, images, or volumes in it are deleted.
In quickstart.md:
When you stop Docker Offload v1, the cloud environment is terminated and all running containers and images are removed. When Docker Offload v1 has been idle for 5 minutes, the environment is also terminated and all running containers and images are removed.
Why this matters
-
Missing volumes: The quickstart doesn't mention that volumes are deleted, which could lead to unexpected data loss for users who only read the quickstart.
-
"Running" vs all containers: The quickstart says "running containers" while core-concepts says "containers" (implying all containers, not just running ones). This creates ambiguity about whether stopped containers are also deleted.
-
Data loss risk: Users following the quickstart might not realize they need to back up volume data before their session ends, since volumes aren't mentioned in the deletion warning.
Suggested fix
Make the deletion behavior consistent across both files. The quickstart should match the more complete information in core-concepts:
In quickstart.md, change:
When you stop Docker Offload v1, the cloud environment is terminated and all running containers and images are removed. When Docker Offload v1 has been idle for 5 minutes, the environment is also terminated and all running containers and images are removed.
To:
When you stop Docker Offload v1, the cloud environment is terminated and all containers, images, and volumes are removed. When Docker Offload v1 has been idle for 5 minutes, the environment is also terminated and all containers, images, and volumes are removed.
Or add a note in the quickstart that references the core-concepts page for complete information about what gets deleted.
Found by nightly documentation quality scanner
- 主要語言
- Markdown
- 星號
- 4.7k
- 分支
- 8.5k
- 平均合併
- 2 天 8 小時
- 30 天內合併 PR
- 133
環境準備
- 提供 Dockerfile 或 Docker Compose 檔案
- 有 Pull Request 範本
- 閱讀貢獻指南
從這裡開始
- 先讀完整個 Issue，再讀專案的貢獻指南。
- 在 Issue 下留言說明你要接手 —— 這能避免兩個人做同樣的事。
- Fork 儲存庫，在一個分支上完成修改。
- 送出 Pull Request，並在描述裡引用這個 Issue 編號。
docker/docs 的其他 Issue
-
status/triage
難度 1/5 1 小時以內 新手友好度 92/100
維護者通常 1 天內回覆
-
[docs-scanner] Confusing explanation of approval-required outcome vs permit in MCP policy可能已有人在做 @dave123981 於 1 天前認領。 未關閉
難度 1/5 1 小時以內 新手友好度 88/100
維護者通常 1 天內回覆
-
[docs-scanner] Contradictory information about MCP approval fields in audit records可能已有人在做 @dave123981 於 1 天前認領。 未關閉
難度 1/5 1-3 小時 新手友好度 88/100
維護者通常 1 天內回覆
-
status/triage
難度 1/5 1 小時以內 新手友好度 68/100
維護者通常 1 天內回覆
-
[docs-scanner] Unclear policy change timing in organization policies overview可能已有人在做 @Mhdomer 於 1 天前認領。 未關閉
難度 1/5 1-3 小時 新手友好度 89/100
維護者通常 1 天內回覆
相似的 Issue
-
Document and enforce pull request review guidelines可能已有人在做 @dashorst 今天認領。 未關閉
難度 2/5 1-3 小時 新手友好度 76/100
維護者通常 1 天內回覆
-
agent-butler-finding chore
難度 1/5 1 小時以內 新手友好度 88/100
jordansmall/spindrift#6695 ·
維護者通常 1 天內回覆
-
難度 2/5 1-3 小時 新手友好度 74/100
juandresrodca/AdminForge#54 ·
-
Update Atari link on Gymnasium docs page可能已有人在做 @qwist1233-cpu 今天認領。 未關閉help wanted
難度 2/5 1-3 小時 新手友好度 66/100
Farama-Foundation/Gymnasium#1845 ·
維護者通常 1 天內回覆
-
hermes-queue
難度 1/5 1 小時以內 新手友好度 72/100
chrisalunlloyd2-sudo/mindpalace#349 ·
維護者通常 1 天內回覆