Multi-platform builds and containerd image store sections are ambiguous, overlap, and missing info
メンテナーはふだん 1 日以内に返信
@dvdksn がすでに取り組んでいます。
2024年9月24日 から。
評価
この issue はまだ評価されていません。
説明
Is this a docs issue?
- My issue is about the documentation content or website
Type of issue
Information is incorrect
Description
The "Multi-platform builds" section is confusing, and has some parts that are ambiguous;
- It outlines prerequisites
- But due to how they are presented, are easy to be interpreted as "you must enable the containerd image store" AND "create a custom builder"
That's incorrect, because creating a custom builder is only needed if the containerd image-store is NOT enabled. There's information in the first paragraphs, but the "make sure that your builder and Docker Engine support multi-platform build" makes it easy to interpret it as "I need to configure both to make this work".
There's duplicate content as well;
- the "multi-platform images" page has a short form of switching to the containerd image-store, but doesn't mention all the details; https://docs.docker.com/build/building/multi-platform/#enable-the-containerd-image-store
- the containerd image-store section in desktop has more details for desktop https://docs.docker.com/desktop/containerd/
- and there's a third section in the engine section; https://docs.docker.com/engine/storage/containerd/
Missing information
QEMU as prerequisite
As an important use of the containerd image-store is to facilitate multi-platform builds, we should also consider;
- Adding steps to enable the QEMU userland-emulation in the install steps
- ☝️ this could cross-reference the https://docs.docker.com/build/building/multi-platform/#qemu section
- ☝️ probably make it more clear in that section that its NOT needed when running Docker Desktop
Storage drivers
Given that the containerd image-store uses different drivers than graphdrivers, we may want to mention this, and perhaps include an example that specifies the default driver to use, e.g.;
{
"features": {
"containerd-snapshotter": true
},
"storage-driver": "overlayfs"
}
- Perhaps the storage-drivers section should also include information about snapshotters
- Mention which pages do NOT apply to the containerd image-store
Location
https://docs.docker.com/build/building/multi-platform/#prerequisites
Suggestion
See above
- 主要言語
- Markdown
- スター
- 4.7k
- フォーク
- 8.5k
- 平均マージ
- 1日 21時間
- マージ済み PR（30日）
- 127
環境構築
- Dockerfile または Docker Compose ファイルあり
- プルリクエストのテンプレートあり
- コントリビューションガイドを読む
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
docker/docs のほかの issue
-
[docs-scanner] Container proxy table misleadingly presents nested properties as separate parameters対応中かも @dave123981 が 2 日前に担当しました。 オープン
難易度 1/5 1時間未満 初心者へのやさしさ 88/100
メンテナーはふだん 1 日以内に返信
-
[docs-scanner] Conflicting WSL version requirements between ECI pages対応中かも @dave123981 が 3 日前に担当しました。 オープン
難易度 1/5 1〜3時間 初心者へのやさしさ 90/100
メンテナーはふだん 1 日以内に返信
-
難易度 2/5 1〜3時間 初心者へのやさしさ 75/100
メンテナーはふだん 1 日以内に返信
-
[docs-scanner] Ambiguous version qualifier for MSI all-users installation requirement再び着手できるかも このイシューのプルリクエストはマージされずにクローズされました。 オープン
難易度 1/5 1時間未満 初心者へのやさしさ 92/100
メンテナーはふだん 1 日以内に返信
-
[docs-scanner] Unclear relationship between sandbox:use PAT permission and granular account permissions対応中かも @dave123981 が 5 日前に担当しました。 オープン
難易度 1/5 1時間未満 初心者へのやさしさ 88/100
docker/docs#26225 · コメント 1 件 ·
メンテナーはふだん 1 日以内に返信