Merge pull request #572 from infosiftr/break-all-the-things

Remove excessive complexity from update.sh

.template-helpers/user-feedback.md

@@ -4,7 +4,7 @@ Documentation for this image is stored in the [`%%REPO%%/` directory](https://gi
 
 ## Issues
 
-If you have any problems with or questions about this image, please contact us %%MAILING-LIST%% through a [GitHub issue](%%GITHUB-REPO%%/issues). If the issue is related to a CVE, please check for [a `cve-tracker` issue on the `official-images` repository first](https://github.com/docker-library/official-images/issues?q=label%3Acve-tracker).
+If you have any problems with or questions about this image, please contact us through a [GitHub issue](%%GITHUB-REPO%%/issues). If the issue is related to a CVE, please check for [a `cve-tracker` issue on the `official-images` repository first](https://github.com/docker-library/official-images/issues?q=label%3Acve-tracker).
 
 You can also reach many of the official image maintainers via the `#docker-library` IRC channel on [Freenode](https://freenode.net).
 
@@ -12,4 +12,4 @@ You can also reach many of the official image maintainers via the `#docker-libra
 
 You are invited to contribute new features, fixes, or updates, large or small; we are always thrilled to receive pull requests, and do our best to process them as fast as we can.
 
-Before you start to code, we recommend discussing your plans %%MAILING-LIST%% through a [GitHub issue](%%GITHUB-REPO%%/issues), especially for more ambitious contributions. This gives other contributors a chance to point you in the right direction, give you feedback on your design, and help you find out if someone else is working on the same thing.
+Before you start to code, we recommend discussing your plans through a [GitHub issue](%%GITHUB-REPO%%/issues), especially for more ambitious contributions. This gives other contributors a chance to point you in the right direction, give you feedback on your design, and help you find out if someone else is working on the same thing.

.travis.yml

@@ -39,6 +39,16 @@ script:
       echo >&2 "Too long (or too many lines):$failed";
       exit 1;
     fi
+  - failed='';
+    for repo in */; do
+      if [ ! -e "$repo/github-repo" ]; then
+        failed+=" $repo";
+      fi
+    done;
+    if [ "$failed" ]; then
+    echo >&2 "Missing github-repo for:$failed";
+      exit 1;
+    fi
   - if [ "$TRAVIS_PULL_REQUEST" != 'false' ]; then
       if [ "$(git diff --numstat "$TRAVIS_COMMIT_RANGE" -- '*/README.md')" ]; then
         echo >&2 'Error:'' at least one repo README.md has changed';

README.md

@@ -12,16 +12,23 @@ All Markdown files here are run through [tianon's fork of `markdownfmt`](https:/
 -	create a `README-short.txt` (required, 100 char max)
 -	create a `content.md` (required)
 -	create a `license.md` (required)
+-	create a `github-repo` (required)
 -	add a `logo.png` (recommended)
--	edit `update.sh` as needed (see below)
--	run `./markdownfmt.sh -l myimage` to verify that the format of your markdown files is compliant with `tianon/markdownfmt`. In case you see any file names, markdownfmt detected some issues, which might result in a failed build during continuous integration.
--	optionally run `./update.sh myimage` to generate `myimage/README.md` for review. **Note:** do not actually commit the `README.md` file; it is automatically generated/committed before being uploaded to DockerHub.
+
+Optionally:
+
+-	run `./update.sh myimage` to generate `myimage/README.md` for your review. **Note:** do not actually commit the `README.md` file; it is automatically generated/committed before being uploaded to Docker Hub.
+-	run `./markdownfmt.sh -l myimage` to verify whether format of your markdown files is compliant to `tianon/markdownfmt`. In case you see any file names, markdownfmt detected some issues, which might result in a failed build during continuous integration. run `./markdownfmt.sh -d myimage` to see a diff of changes required to pass.
+
+# How do I update an image's docs
+
+To update `README.md` for a specific image do not edit `README.md` directly. Please edit `content.md` or another appropriate file within the folder. To see the changes, run `./update.sh myimage` from the repo root, but do not add the `README.md` changes to your pull request. See also `markdownfmt.sh` point [above](#how-do-i-add-a-new-images-docs).
 
 # What are all these files?
 
 ## `update.sh`
 
-This is the main script used to generate the `README.md` files for each image. When a new image is added that is not under the `docker-library` namespace on GitHub, a new entry must be added to the `otherRepos` array in this script. Accepted arguments are which image(s) you want to update and no arguments to update all of them.
+This is the main script used to generate the `README.md` files for each image. The generated file is committed along with the files used to generate it (see below on what customizations are available). Accepted arguments are which image(s) you want to update or no arguments to update all of them.
 
 ## `generate-repo-stub-readme.sh`
 
@@ -82,17 +89,17 @@ This file should contain a link to the license for the main software in the imag
 View [license information](http://golang.org/LICENSE) for the software contained in this image.
 ```
 
-## `<image name>/user-feedback.md`
+## `<image name>/github-repo`
 
-This file is an optional override of the default `user-feedback.md` for those repositories with different issue and contributing policies.
+This file should contain the URL to the GitHub repository for the Dockerfiles that become the images. The file should be in a single line ending in a newline with no extraneous whitespace. Only one GitHub repo per image repository is supported. It is used in generating links. Here is an example for `golang`:
 
-## `<image name>/mailing-list.md`
+```text
+https://github.com/docker-library/golang
+```
 
-This file is snippet that gets inserted into the user feedback section to provide and extra way to get help, like a mailing list. Here is an example from the Postgres image:
+## `<image name>/user-feedback.md`
 
-```markdown
-on the [mailing list](http://www.postgresql.org/community/lists/subscribe/) or
-```
+This file is an optional override of the default `user-feedback.md` for those repositories with different issue and contributing policies.
 
 # Issues and Contributing
 

aerospike/github-repo

@@ -0,0 +1 @@
+https://github.com/aerospike/aerospike-server.docker

aerospike/mailing-list.md

@@ -1 +0,0 @@
-on the [Aerospike Forums](https://discuss.aerospike.com) or

aerospike/user-feedback.md

@@ -0,0 +1,15 @@
+## Documentation
+
+Documentation for this image is stored in the [`%%REPO%%/` directory](https://github.com/docker-library/docs/tree/master/%%REPO%%) of the [`docker-library/docs` GitHub repo](https://github.com/docker-library/docs). Be sure to familiarize yourself with the [repository's `README.md` file](https://github.com/docker-library/docs/blob/master/README.md) before attempting a pull request.
+
+## Issues
+
+If you have any problems with or questions about this image, please contact us on the [Aerospike Forums](https://discuss.aerospike.com) or through a [GitHub issue](%%GITHUB-REPO%%/issues). If the issue is related to a CVE, please check for [a `cve-tracker` issue on the `official-images` repository first](https://github.com/docker-library/official-images/issues?q=label%3Acve-tracker).
+
+You can also reach many of the official image maintainers via the `#docker-library` IRC channel on [Freenode](https://freenode.net).
+
+## Contributing
+
+You are invited to contribute new features, fixes, or updates, large or small; we are always thrilled to receive pull requests, and do our best to process them as fast as we can.
+
+Before you start to code, we recommend discussing your plans on the [Aerospike Forums](https://discuss.aerospike.com) or through a [GitHub issue](%%GITHUB-REPO%%/issues), especially for more ambitious contributions. This gives other contributors a chance to point you in the right direction, give you feedback on your design, and help you find out if someone else is working on the same thing.

alpine/github-repo

@@ -0,0 +1 @@
+https://github.com/gliderlabs/docker-alpine

arangodb/github-repo

@@ -0,0 +1 @@
+https://github.com/arangodb/arangodb-docker

backdrop/github-repo

@@ -0,0 +1 @@
+https://github.com/backdrop-ops/backdrop-docker

bonita/github-repo

@@ -0,0 +1 @@
+https://github.com/Bonitasoft-Community/docker_bonita

buildpack-deps/github-repo

@@ -0,0 +1 @@
+https://github.com/docker-library/buildpack-deps

busybox/github-repo

@@ -0,0 +1 @@
+https://github.com/docker-library/busybox

cassandra/github-repo

@@ -0,0 +1 @@
+https://github.com/docker-library/cassandra

celery/github-repo

@@ -0,0 +1 @@
+https://github.com/docker-library/celery

centos/github-repo

@@ -0,0 +1 @@
+https://github.com/CentOS/sig-cloud-instance-images

centos/mailing-list.md

@@ -1 +0,0 @@
-by submitting a ticket at [https://bugs.centos.org](https://bugs.centos.org) or

centos/user-feedback.md

@@ -0,0 +1,15 @@
+## Documentation
+
+Documentation for this image is stored in the [`%%REPO%%/` directory](https://github.com/docker-library/docs/tree/master/%%REPO%%) of the [`docker-library/docs` GitHub repo](https://github.com/docker-library/docs). Be sure to familiarize yourself with the [repository's `README.md` file](https://github.com/docker-library/docs/blob/master/README.md) before attempting a pull request.
+
+## Issues
+
+If you have any problems with or questions about this image, please contact us by submitting a ticket at [https://bugs.centos.org](https://bugs.centos.org) or through a [GitHub issue](%%GITHUB-REPO%%/issues). If the issue is related to a CVE, please check for [a `cve-tracker` issue on the `official-images` repository first](https://github.com/docker-library/official-images/issues?q=label%3Acve-tracker).
+
+You can also reach many of the official image maintainers via the `#docker-library` IRC channel on [Freenode](https://freenode.net).
+
+## Contributing
+
+You are invited to contribute new features, fixes, or updates, large or small; we are always thrilled to receive pull requests, and do our best to process them as fast as we can.
+
+Before you start to code, we recommend discussing your plans by submitting a ticket at [https://bugs.centos.org](https://bugs.centos.org) or through a [GitHub issue](%%GITHUB-REPO%%/issues), especially for more ambitious contributions. This gives other contributors a chance to point you in the right direction, give you feedback on your design, and help you find out if someone else is working on the same thing.

chronograf/github-repo

@@ -0,0 +1 @@
+https://github.com/influxdata/chronograf-docker

cirros/github-repo

@@ -0,0 +1 @@
+https://github.com/ewindisch/docker-cirros

clojure/github-repo

@@ -0,0 +1 @@
+https://github.com/Quantisan/docker-clojure

consul/github-repo

@@ -0,0 +1 @@
+https://github.com/hashicorp/docker-consul

couchbase/github-repo

@@ -0,0 +1 @@
+https://github.com/couchbase/docker

couchdb/github-repo

@@ -0,0 +1 @@
+https://github.com/klaemo/docker-couchdb

crate/github-repo

@@ -0,0 +1 @@
+https://github.com/crate/docker-crate

crux/github-repo

@@ -0,0 +1 @@
+https://github.com/therealprologic/docker-crux

debian/github-repo

@@ -0,0 +1 @@
+https://github.com/tianon/docker-brew-debian

django/github-repo

@@ -0,0 +1 @@
+https://github.com/docker-library/django

docker-dev/github-repo

@@ -0,0 +1 @@
+https://github.com/docker/docker

docker/github-repo

@@ -0,0 +1 @@
+https://github.com/docker-library/docker

drupal/github-repo

@@ -0,0 +1 @@
+https://github.com/docker-library/drupal

elasticsearch/github-repo

@@ -0,0 +1 @@
+https://github.com/docker-library/elasticsearch

elixir/github-repo

@@ -0,0 +1 @@
+https://github.com/c0b/docker-elixir

erlang/github-repo

@@ -0,0 +1 @@
+https://github.com/c0b/docker-erlang-otp

fedora/github-repo

@@ -0,0 +1 @@
+https://github.com/lsm5/docker-brew-fedora

fedora/mailing-list.md

@@ -1 +0,0 @@
-by filing a bug on [Fedora's bugzilla page](https://bugzilla.redhat.com/enter_bug.cgi?product=Fedora) (choose `docker` as component and include details about image problems in the description) or

fedora/user-feedback.md

@@ -0,0 +1,15 @@
+## Documentation
+
+Documentation for this image is stored in the [`%%REPO%%/` directory](https://github.com/docker-library/docs/tree/master/%%REPO%%) of the [`docker-library/docs` GitHub repo](https://github.com/docker-library/docs). Be sure to familiarize yourself with the [repository's `README.md` file](https://github.com/docker-library/docs/blob/master/README.md) before attempting a pull request.
+
+## Issues
+
+If you have any problems with or questions about this image, please contact us by filing a bug on [Fedora's bugzilla page](https://bugzilla.redhat.com/enter_bug.cgi?product=Fedora) (choose `docker` as component and include details about image problems in the description) or through a [GitHub issue](%%GITHUB-REPO%%/issues). If the issue is related to a CVE, please check for [a `cve-tracker` issue on the `official-images` repository first](https://github.com/docker-library/official-images/issues?q=label%3Acve-tracker).
+
+You can also reach many of the official image maintainers via the `#docker-library` IRC channel on [Freenode](https://freenode.net).
+
+## Contributing
+
+You are invited to contribute new features, fixes, or updates, large or small; we are always thrilled to receive pull requests, and do our best to process them as fast as we can.
+
+Before you start to code, we recommend discussing your plans by filing a bug on [Fedora's bugzilla page](https://bugzilla.redhat.com/enter_bug.cgi?product=Fedora) (choose `docker` as component and include details about image problems in the description) or through a [GitHub issue](%%GITHUB-REPO%%/issues), especially for more ambitious contributions. This gives other contributors a chance to point you in the right direction, give you feedback on your design, and help you find out if someone else is working on the same thing.

gazebo/github-repo

@@ -0,0 +1 @@
+https://github.com/osrf/docker_images

gcc/github-repo

@@ -0,0 +1 @@
+https://github.com/docker-library/gcc

ghost/github-repo

@@ -0,0 +1 @@
+https://github.com/docker-library/ghost

glassfish/github-repo

@@ -0,0 +1 @@
+https://github.com/aws/aws-eb-glassfish

golang/github-repo

@@ -0,0 +1 @@
+https://github.com/docker-library/golang

haproxy/github-repo

@@ -0,0 +1 @@
+https://github.com/docker-library/haproxy

haskell/github-repo

@@ -0,0 +1 @@
+https://github.com/freebroccolo/docker-haskell

hello-world/github-repo

@@ -0,0 +1 @@
+https://github.com/docker-library/hello-world

hipache/github-repo

@@ -0,0 +1 @@
+https://github.com/dotcloud/hipache

httpd/github-repo

@@ -0,0 +1 @@
+https://github.com/docker-library/httpd

hylang/github-repo

@@ -0,0 +1 @@
+https://github.com/hylang/hy

influxdb/github-repo

@@ -0,0 +1 @@
+https://github.com/influxdata/influxdb-docker

iojs/github-repo

@@ -0,0 +1 @@
+https://github.com/nodejs/docker-iojs

irssi/github-repo

@@ -0,0 +1 @@
+https://github.com/jfrazelle/irssi

java/github-repo

@@ -0,0 +1 @@
+https://github.com/docker-library/java

jenkins/github-repo

@@ -0,0 +1 @@
+https://github.com/cloudbees/jenkins-ci.org-docker

jetty/github-repo

@@ -0,0 +1 @@
+https://github.com/appropriate/docker-jetty

joomla/github-repo

@@ -0,0 +1 @@
+https://github.com/joomla/docker-joomla

jruby/github-repo

@@ -0,0 +1 @@
+https://github.com/cpuguy83/docker-jruby

julia/github-repo

@@ -0,0 +1 @@
+https://github.com/docker-library/julia

kaazing-gateway/github-repo

@@ -0,0 +1 @@
+https://github.com/kaazing/gateway.docker

kapacitor/github-repo

@@ -0,0 +1 @@
+https://github.com/influxdata/kapacitor-docker

kibana/github-repo

@@ -0,0 +1 @@
+https://github.com/docker-library/kibana

lightstreamer/github-repo

@@ -0,0 +1 @@
+https://github.com/Lightstreamer/Docker

logstash/github-repo

@@ -0,0 +1 @@
+https://github.com/docker-library/logstash

mageia/github-repo

@@ -0,0 +1 @@
+https://github.com/juanluisbaptiste/docker-brew-mageia

mariadb/github-repo

@@ -0,0 +1 @@
+https://github.com/docker-library/mariadb

maven/github-repo

@@ -0,0 +1 @@
+https://github.com/carlossg/docker-maven

memcached/github-repo

@@ -0,0 +1 @@
+https://github.com/docker-library/memcached

mongo-express/github-repo

@@ -0,0 +1 @@
+https://github.com/mongo-express/mongo-express-docker

mongo/github-repo

@@ -0,0 +1 @@
+https://github.com/docker-library/mongo

mono/github-repo

@@ -0,0 +1 @@
+https://github.com/mono/docker

mysql/github-repo

@@ -0,0 +1 @@
+https://github.com/docker-library/mysql

nats/github-repo

@@ -0,0 +1 @@
+https://github.com/nats-io/nats-docker

neo4j/github-repo

@@ -0,0 +1 @@
+https://github.com/neo4j/docker-neo4j

neurodebian/github-repo

@@ -0,0 +1 @@
+https://github.com/neurodebian/dockerfiles

nginx/github-repo

@@ -0,0 +1 @@
+https://github.com/nginxinc/docker-nginx

node/github-repo

@@ -0,0 +1 @@
+https://github.com/nodejs/docker-node

notary/github-repo

@@ -0,0 +1 @@
+https://github.com/docker/notary-official-images

nuxeo/github-repo

@@ -0,0 +1 @@
+https://github.com/nuxeo/docker-nuxeo

odoo/github-repo

@@ -0,0 +1 @@
+https://github.com/odoo/docker

opensuse/github-repo

@@ -0,0 +1 @@
+https://github.com/openSUSE/docker-containers-build

oraclelinux/github-repo

@@ -0,0 +1 @@
+https://github.com/oracle/docker

orientdb/github-repo

@@ -0,0 +1 @@
+https://github.com/orientechnologies/orientdb-docker

owncloud/github-repo

@@ -0,0 +1 @@
+https://github.com/docker-library/owncloud

percona/github-repo

@@ -0,0 +1 @@
+https://github.com/docker-library/percona

perl/github-repo

@@ -0,0 +1 @@
+https://github.com/Perl/docker-perl

photon/github-repo

@@ -0,0 +1 @@
+https://github.com/frapposelli/photon-docker-image

php-zendserver/github-repo

@@ -0,0 +1 @@
+https://github.com/zendtech/php-zendserver-docker

php/github-repo

@@ -0,0 +1 @@
+https://github.com/docker-library/php

piwik/github-repo

@@ -0,0 +1 @@
+https://github.com/piwik/docker-piwik

postgres/github-repo

@@ -0,0 +1 @@
+https://github.com/docker-library/postgres

postgres/mailing-list.md

@@ -1 +0,0 @@
-on the [mailing list](http://www.postgresql.org/community/lists/subscribe/) or

postgres/user-feedback.md

@@ -0,0 +1,15 @@
+## Documentation
+
+Documentation for this image is stored in the [`%%REPO%%/` directory](https://github.com/docker-library/docs/tree/master/%%REPO%%) of the [`docker-library/docs` GitHub repo](https://github.com/docker-library/docs). Be sure to familiarize yourself with the [repository's `README.md` file](https://github.com/docker-library/docs/blob/master/README.md) before attempting a pull request.
+
+## Issues
+
+If you have any problems with or questions about this image, please contact us on the [mailing list](http://www.postgresql.org/community/lists/subscribe/) or through a [GitHub issue](%%GITHUB-REPO%%/issues). If the issue is related to a CVE, please check for [a `cve-tracker` issue on the `official-images` repository first](https://github.com/docker-library/official-images/issues?q=label%3Acve-tracker).
+
+You can also reach many of the official image maintainers via the `#docker-library` IRC channel on [Freenode](https://freenode.net).
+
+## Contributing
+
+You are invited to contribute new features, fixes, or updates, large or small; we are always thrilled to receive pull requests, and do our best to process them as fast as we can.
+
+Before you start to code, we recommend discussing your plans on the [mailing list](http://www.postgresql.org/community/lists/subscribe/) or through a [GitHub issue](%%GITHUB-REPO%%/issues), especially for more ambitious contributions. This gives other contributors a chance to point you in the right direction, give you feedback on your design, and help you find out if someone else is working on the same thing.

pypy/github-repo

@@ -0,0 +1 @@
+https://github.com/docker-library/pypy

python/github-repo

@@ -0,0 +1 @@
+https://github.com/docker-library/python

r-base/github-repo

@@ -0,0 +1 @@
+https://github.com/rocker-org/rocker

rabbitmq/github-repo

@@ -0,0 +1 @@
+https://github.com/docker-library/rabbitmq

rails/github-repo

@@ -0,0 +1 @@
+https://github.com/docker-library/rails

rakudo-star/github-repo

@@ -0,0 +1 @@
+https://github.com/perl6/docker

redis/github-repo

@@ -0,0 +1 @@
+https://github.com/docker-library/redis

redmine/github-repo

@@ -0,0 +1 @@
+https://github.com/docker-library/redmine

registry/github-repo

@@ -0,0 +1 @@
+https://github.com/docker/docker-registry

rethinkdb/github-repo

@@ -0,0 +1 @@
+https://github.com/stuartpb/rethinkdb-dockerfiles