jberkus added a new comment to an issue you are following:
``
Ref issues #243 #267
New requirements:
1. Every image is required to have a "description" label, which will be 1-3 lines of human-readable text on what the image is for. This description is meant to be searchable by skopeo.
2. Images are required to have either a "help" label or a "help" file, the latter being preferred. They should not have both.
3. The Help file can be named "help.1" or "README.md". It must be COPYd into the image and reside in the root directory.
4. If the maintainer prefers a "help" label, the label should include an executable command which displays a help page in some reasonable text format. Minimally, this could be as simple as "echo 'How to use this image'".
5. For users who don't use the Atomic CLI, we will offer simple instructions on how to display the help ("docker run --rm some:image /bin/cat help1.txt && /bin/cat README.md").
6. We will do nothing with URLs for the time being. Instead, we will implement a HELPURL system at some later date when we have the resources to do so completely automatically. In the meantime, help files are browseable on dist-git.
Does this work for everyone? In this case, the only required change to "atomic help" is supporting README.md. The reason we want that, btw, is for Github user friendliness.
``
To reply, visit the link below or just reply to this email
https://pagure.io/atomic-wg/issue/256
_______________________________________________
cloud mailing list -- cloud@xxxxxxxxxxxxxxxxxxxxxxx
To unsubscribe send an email to cloud-leave@xxxxxxxxxxxxxxxxxxxxxxx
