向Docker映像添加文档的推荐方式是什么

Question

似乎有两种向Docker映像添加文档的方法：

您可以在dockerfile所在的根文件夹中添加一个readme.md，这将由dockerhub自动构建系统进行解析。

第二种方法是使用清单 https://docs.docker.com/docker-hub/publish/publish/#prepare-your-image-manifest-materials 但是文档并没有很好地解释如何注释图像的清单文件。而且看来manifest命令被认为是实验性的。

记录Docker映像的推荐方式是什么？

个人而言，我更喜欢在构建容器时不必添加文档，我宁愿在源代码管理中添加文件。但是，md文件方法似乎几乎没有支持。

Answer 1

大多数现代容器注册表（如Dockerhub，Quay，Harbour）都有一个Web界面，可以以Markdown格式呈现和显示文档。当您从Github存储库在Dockerhub上进行自动构建时，git存储库的README.md可以自动同步到Docker Hub上的存储库。如果您在本地（或通过CI运行器）构建映像并将其推送到Docker Hub，则也可以使用docker-pushrm工具推送自述文件。除Dockerhub之外，它还支持其他容器注册表。