[docs-scanner] Inconsistent information about what gets deleted when Docker Offload v1 session ends
メンテナーはふだん 1 日以内に返信
まだ誰も着手していません。
評価
- 難易度
- 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時間
- マージ済み PR（30日）
- 133
環境構築
- Dockerfile または Docker Compose ファイルあり
- プルリクエストのテンプレートあり
- コントリビューションガイドを読む
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- 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 日以内に返信