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 天 22 小时
- 30 天内合并 PR
- 128
环境准备
- 提供 Dockerfile 或 Docker Compose 文件
- 有 Pull Request 模板
- 阅读贡献指南
从这里开始
- 先读完整个 Issue，再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库，在一个分支上完成修改。
- 提交 Pull Request，并在描述里引用这个 Issue 编号。
docker/docs 的其他 Issue
-
status/triage
难度 2/5 1-3 小时 新手友好度 70/100
维护者通常 1 天内回复
-
[docs-scanner] Container proxy table misleadingly presents nested properties as separate parameters可能已有人在做 @dave123981 于 3 天前认领。 未关闭
难度 1/5 1 小时以内 新手友好度 88/100
维护者通常 1 天内回复
-
[docs-scanner] Conflicting WSL version requirements between ECI pages可能已有人在做 @dave123981 于 4 天前认领。 未关闭
难度 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可能重新可做 关联的 PR 已关闭且未合并。 未关闭
难度 1/5 1 小时以内 新手友好度 92/100
维护者通常 1 天内回复