[atomic-wg] Issue #267: Label 'help' in the guidelines and in atomic tool

[Honza Horak]

hhorak reported a new issue against the project: `atomic-wg` that you are following:
``
One issue with the Fedora Containers Guidelines I've realized -- the 'help'
LABEL has different semantic in `atomic` tool than in the guidelines.

The description of the 'help' label in the container guidelines [1] is this:
"Provides a detailed narrative of how the container is meant to be used. In many
cases will be a link."

However, atomic tool [2] uses the 'help' label for specification of a command that
shows the man page. So, the only possible format that makes sense there is something
like:

    LABEL help="docker run IMAGE cat /help.1 | /usr/bin/groff -man -ETascii"

So, given the Container Guidelines in Fedora are much more recent than the 'atomic
help' implementation, I'd recommend to change the 'help' label in the
guidelines and also add the label into the general Atomic labels description [3].

I'd suggest this description for the 'help' label:
"""
Powers "atomic help" command. Usually required for containers which do not
contain the man page called help.1 in the root. If not specified, "atomic help"
command shows /help.1 using the `groff` tool on the host system.
"""

I also think that label 'usage' can server for the same purpose as the
'help' label is meant to be used currently in the Container Guidelines, so the
description of the 'usage' label may be:

"""
Human readable example of container execution. In many cases will be a link. 
"""

[1] https://fedoraproject.org/wiki/Container:Guidelines#LABELS
[2] https://github.com/projectatomic/atomic/blob/master/Atomic/help.py#L64
[3]
https://github.com/projectatomic/ContainerApplicationGenericLabels/blob/m...
``

To reply, visit the link below or just reply to this email
https://pagure.io/atomic-wg/issue/267

[Vadim Rutkovsky]

vrutkovs added a new comment to an issue you are following:
``
Atomic-reactor is able to convert a markdown file in a man-page, which would be readable
by `atomic help`. It uses `go-md2man`, which should be present inside the buildroot.

In order to use this plugin the help markdown file should have a predefined name (e.g.
`help.md`) - this is configured in Fedora's Layered Build Service settings.

[1] https://github.com/projectatomic/atomic-reactor/pull/613
[2]
https://github.com/projectatomic/atomic-reactor/blob/master/docs/plugins....
``

To reply, visit the link below or just reply to this email
https://pagure.io/atomic-wg/issue/267

[Honza Horak]

hhorak added a new comment to an issue you are following:
``
Cool, but I don't think it helps here, since the real problem is not during build time
(how to get the help.1 file into the image), but during run time, that help label is used
for two different things now.
``

To reply, visit the link below or just reply to this email
https://pagure.io/atomic-wg/issue/267

[Josh Berkus]

jberkus added a new comment to an issue you are following:
``
Basically the same issue as #256 
``

To reply, visit the link below or just reply to this email
https://pagure.io/atomic-wg/issue/267

[Dusty Mabe]

dustymabe added a new comment to an issue you are following:
``
marking as duplicate - please re-open if that is not the case. 
``

To reply, visit the link below or just reply to this email
https://pagure.io/atomic-wg/issue/267

[Dusty Mabe]

The status of the issue: `Label 'help' in the guidelines and in atomic tool` of
project: `atomic-wg` has been updated to: Closed as Duplicate by dustymabe.

https://pagure.io/atomic-wg/issue/267