[docs-scanner] Conflicting guidance on when to use overlay2 vs containerd
まだ誰も着手していません。
評価
- 難易度
- 2/5
- 見積もり時間
- 1〜3時間
- 初心者へのやさしさ
- 75/100
- issue の種類
- ドキュメント
- 明瞭さ
- 明確に書かれている
- 活発さ
- 活発
調査の方向性
この issue は、2 つの特定のファイルを指しています: content/manuals/engine/storage/drivers/select-storage-driver.md と content/manuals/engine/storage/drivers/overlayfs-driver.md です。まず、これらのファイルを読んで、現在の矛盾するガイダンスを理解してください。次に、select-storage-driver ページに、overlay2 と containerd のどちらを使用するかの明確な決定セクションを草案し、overlayfs-driver ページを更新してその記述を明確にします。変更をローカルでドキュメントをビルドするか、レンダリングされた出力を確認して検証してください。
索引モデルが issue の本文から書いたものです。
説明
Files:
content/manuals/engine/storage/drivers/select-storage-driver.mdcontent/manuals/engine/storage/drivers/overlayfs-driver.md
Issue
The select-storage-driver page says:
For systems using classic storage drivers,
overlay2provides broad compatibility across Linux distributions. Use Docker volumes for write-heavy workloads instead of relying on writing data to the container's writable layer.
This guidance presents overlay2 as a recommended choice "for systems using classic storage drivers," but doesn't explain when or why a user would choose to use classic storage drivers instead of the containerd image store (the default for 29.0+).
Meanwhile, overlayfs-driver.md says:
In most cases you should use the
overlay2storage driver - it's not required to use thebtrfsstorage driver simply because your system uses Btrfs as its root filesystem.
But then immediately contradicts this with:
Docker Engine 29.0 and later uses the containerd image store by default. The
overlay2driver is a legacy storage driver that is superseded by theoverlayfscontainerd snapshotter.
Why this matters
A reader following these pages will be confused about whether they should be using overlay2 or the containerd image store. The guidance says "in most cases you should use overlay2" but then says it's "legacy" and "superseded." There's no clear decision tree for when to use which system.
Suggested fix
Add a clear decision section to select-storage-driver.md that explains:
- Docker Engine 29.0+ uses containerd image store by default for fresh installations (recommended)
- Classic storage drivers (including overlay2) are still available for:
- Systems upgraded from earlier versions that haven't migrated
- Specific compatibility requirements (list them if any exist)
- How to determine which system you're currently using
- When and why you might need to stay on classic storage drivers vs migrating to containerd
Remove or update the "in most cases you should use overlay2" statement in overlayfs-driver.md to clarify it only applies to users who must use classic storage drivers.
Found by nightly documentation quality scanner
- 主要言語
- Markdown
- スター
- 4.7k
- フォーク
- 8.5k
- 平均マージ
- 2日 18時間
- マージ済み PR(30日)
- 121
コントリビューションガイド
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
docker/docs のほかの issue
-
status/triage
難易度 1/5 1時間未満 初心者へのやさしさ 85/100
-
難易度 1/5 1時間未満 初心者へのやさしさ 85/100
-
難易度 1/5 1時間未満 初心者へのやさしさ 90/100
-
難易度 1/5 1時間未満 初心者へのやさしさ 95/100
-
難易度 1/5 1時間未満 初心者へのやさしさ 92/100
似ている issue
-
rules
難易度 1/5 1時間未満 初心者へのやさしさ 92/100
-
difficulty/starter 🚀 good first issue kind/consumer-experience kind/documentation platform/ios 🍎 platform/wasm 🌐 project/documentation 📖 project/non-ui ⚙️ triage/untriaged
難易度 1/5 1時間未満 初心者へのやさしさ 95/100
unoplatform/uno#24649 ·
-
sync-en
難易度 2/5 1〜3時間 初心者へのやさしさ 88/100
-
sync-en
難易度 2/5 1〜3時間 初心者へのやさしさ 84/100
-
Перевод устарел
難易度 2/5 1〜3時間 初心者へのやさしさ 78/100