smilner added a new comment to an issue you are following:
``
## README.md
A quick description and general human helpful text. Similar to what would be in a repo
## help.md
### Original Help
[Container Guidelines: Help
File](https://fedoraproject.org/wiki/Container:Guidelines#Help_File)
Defined:
- Volumes: map of volume name: description
- Ports: map of port_number: description
- Documentation: Link to online documentation
- Requirements: Human friendly text describing what the container needs to run
- Configuration: Human friendly text describing information on how the container is
configured
### Stricter Help
Mimics ``man`` style:
- Header:
-- IMAGE_SHORT_NAME(1)
-- Person who wrote the document
-- Last updated
- Name: IMAGE_SHORT_NAME: IMAGE_SHORT_DESCRIPTION
- Description: IMAGE_LONG_DESCRIPTION
- Usage: Command(s) that can be used to install the container (IE: docker example, atomic
example)
- Environment Variables: Two width table listing available ``Variable Name`` and
``Description``
- Security Implications:
-- Ports: Ports opened/used by the container (maps to Original Help's Ports)
-- Volumes: Volumes used by the container (maps to Original Help's Volumes)
- See Also: Further reading (maps to Documentation of the Original Help)
### Example and Untested Template
```
- {{ IMAGE_NAME|upper }}(1) Container Image Pages
- {{ IMAGE_AUTHOR }}
- {{ IMAGE_DOC_DATE }}
# NAME
{{ IMAGE_NAME }} - {{ IMAGE_SHORT_DESCRIPTION}}
# DESCRIPTION
{{ IMAGE_LONG_DESCRIPTION }}
# USAGE
{{ IMAGE_USAGE }}
# ENVIRONMENT VARIABLES
The image recognizes the following environment variables that you can set
during initialization be passing `-e VAR=VALUE` to the Docker run command.
| Variable name | Description
|
| :----------------------- | -----------------------------------------------------------
|
{% for _name, _description in IMAGE_ENVIRONMENT_VARIABLES.iteritems() %}
| `{{ _name|upper }}` | {{ _description}} |
{% endfor %}
# SECURITY IMPLICATIONS
## Ports
| Port Container | Port Host | Description |
| :----------------- | -----------|-------------------------------|
{% for _ports, _description in IMAGE_PORTS %}
| {{ _port[0] }} | {{ _port[1] }} | {{ _description}} |
{% endfor %}
## Volumes
| Volume Container | Volume Host | Description |
| :----------------- | -----------|-------------------------------|
{% for _vols, _description in IMAGE_PORTS %}
| {{ _vols[0] }} | {{ _vols[1] }} | {{ _description}} |
{% endfor %}
# SEE ALSO
{{ IMAGE_SEE_ALSO }}
```
``
To reply, visit the link below or just reply to this email
https://pagure.io/atomic-wg/issue/354