From Fedora Project Wiki

Revision as of 10:45, 13 March 2017 by Jhogarth (talk | contribs) (→‎DESCRIPTION of container: new section)

Do we have docs that correspond to the list of links at the top of That is,

   Learning to create packages
   Becoming a package maintainer
   Submitting package updates
   Adding a new package to the repository as an existing maintainer
   adding a new release branch to an existing package 


Mattdm (talk) 14:55, 14 October 2016 (UTC)

We do, it's still in Draft and needs some clean up. Maxamillion (talk) 20:50, 18 October 2016 (UTC)

DESCRIPTION of container


The container MUST have a file next to the Dockerfile called README.

This file MUST contain the following:

A brief description of what service/software the container has A brief example line of running the container

If it is possible to configure the contained service the file MUST contain directions on how to do so.

If the container has any dependencies on other services (for example a database) the file MUST detail these.

If the container uses any volumes the file MUST detail what each one is for, see VOLUMES guidelines for more detail.

The Dockerfile MUST have a label HELP which can either be a couple of lines detailing how to run the container or in the case of a more complex container with dependencies MUST be the URL to the README file (and once approved this should point to the README in dist-git.

The Dockerfile MUST copy the README to /README in the container so that it is available locally after the container is pulled.