Re: Proposal: require DESCRIPTION, USAGE label for images

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

 



*Bump*

Sans feedback, I'm going to assume that everyone approves of this pretty
soon ...


On 12/13/2016 01:24 PM, Josh Berkus wrote:
> Folks,
> 
> Looking at the new FDLIBS, I'm noticing that there's not a narrative
> description of the image required or provided anywhere that I can find.
> Clearly one is needed for users.  So, here's a proposal:
> 
> New Required LABELs:
> 
> 	USAGE: single command line giving usage example
>              for invoking the container; will be "N/A" for
>              some containers.
> 
> 	DESCRIPTION: Narrative description incuding:
>           * What service/software it provides
>           * What specific purpose it fulfills, if required
>           * Notes on how to use it, if not covered by USAGE,
>             such as how to supply configuration files
>           * Depedencies on other images (e.g. "requires a database")
>           * Links to documentation for the Software, if any
> 


-- 
--
Josh Berkus
Project Atomic
Red Hat OSAS
_______________________________________________
cloud mailing list -- cloud@xxxxxxxxxxxxxxxxxxxxxxx
To unsubscribe send an email to cloud-leave@xxxxxxxxxxxxxxxxxxxxxxx




[Index of Archives]     [Fedora General Discussion]     [Older Fedora Users Archive]     [Fedora Advisory Board]     [Fedora Security]     [Fedora Devel Java]     [Fedora Legacy]     [Fedora Desktop]     [ATA RAID]     [Fedora Marketing]     [Fedora Mentors]     [Fedora Package Announce]     [Fedora Package Review]     [Fedora Music]     [Fedora Packaging]     [Centos]     [Fedora SELinux]     [Coolkey]     [Yum Users]     [Big List of Linux Books]     [Yosemite News]     [Linux Apps]     [KDE Users]     [Fedora Art]     [Fedora Docs]     [Asterisk PBX]

  Powered by Linux