Каков рекомендуемый способ добавления документации в образы докеров? - PullRequest
0 голосов
/ 09 января 2019

Кажется, что есть два способа добавить документацию в образ докера:

Вы можете добавить readme.md в корневую папку (где находится ваш файл Docker), и это должно быть проанализировано автоматической системой сборки dockerhub.

Второй способ - использование манифеста https://docs.docker.com/docker-hub/publish/publish/#prepare-your-image-manifest-materials Но документация не очень хорошо объясняет, как аннотировать файл манифеста для изображения. Также похоже, что команда manifest считается экспериментальной.

Каков рекомендуемый способ документирования образа докера?

Лично я предпочитаю не добавлять документацию при сборке контейнера, я бы предпочел файл в системе контроля версий. Однако метод md file, похоже, имеет минимальную поддержку.

Добро пожаловать на сайт PullRequest, где вы можете задавать вопросы и получать ответы от других членов сообщества.
...