Skip to content

Commit

Permalink
Refactor the way information (especially links) are presented
Browse files Browse the repository at this point in the history
This should make it much faster to find the right place to file issues, get help, find out whether upstream maintains an image, etc.

I've done my best to represent each `REPO/maintainer.md` file appropriately, but I might have missed some (or there might be something else a maintainer prefers be listed there, either more or less descriptive, for example), which would be welcome contributions following this change.
  • Loading branch information
tianon committed Apr 22, 2017
1 parent 078eaa5 commit 0c2b9dc
Show file tree
Hide file tree
Showing 184 changed files with 217 additions and 252 deletions.
1 change: 1 addition & 0 deletions .common-templates/maintainer-community.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
[the Docker Community](%%GITHUB-REPO%%)
1 change: 1 addition & 0 deletions .common-templates/maintainer-docker.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
[Docker, Inc.](%%GITHUB-REPO%%)
1 change: 1 addition & 0 deletions .common-templates/maintainer-hashicorp.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
[HashiCorp](%%GITHUB-REPO%%)
1 change: 1 addition & 0 deletions .common-templates/maintainer-influxdata.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
[InfluxData](%%GITHUB-REPO%%)
5 changes: 0 additions & 5 deletions .template-helpers/docker-versions.md

This file was deleted.

1 change: 1 addition & 0 deletions .template-helpers/get-help.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
[the Docker Community Forums](https://forums.docker.com/), [the Docker Community Slack](https://blog.docker.com/2016/11/introducing-docker-community-directory-docker-community-slack/), or [Stack Overflow](https://stackoverflow.com/search?tab=newest&q=docker)
1 change: 1 addition & 0 deletions .template-helpers/issues.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
[%%GITHUB-REPO%%/issues](%%GITHUB-REPO%%/issues)
27 changes: 20 additions & 7 deletions .template-helpers/template.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,16 +2,29 @@

%%TAGS%%

For detailed information about the published artifacts of each of the above supported tags (image metadata, transfer size, etc), please see [the `repos/%%REPO%%` directory](https://github.com/docker-library/repo-info/blob/master/repos/%%REPO%%) in [the `docker-library/repo-info` GitHub repo](https://github.com/docker-library/repo-info).
# Quick reference

For more information about this image and its history, please see [the relevant manifest file (`library/%%REPO%%`)](https://github.com/docker-library/official-images/blob/master/library/%%REPO%%). This image is updated via [pull requests to the `docker-library/official-images` GitHub repo](https://github.com/docker-library/official-images/pulls?q=label%3Alibrary%2F%%REPO%%).
- **Where to get help**:
%%GET-HELP%%

%%CONTENT%%%%VARIANT%%%%LICENSE%%
- **Where to file issues**:
%%ISSUES%%

- **Maintained by**:
%%MAINTAINER%%

# Supported Docker versions
- **Published image artifact details**:
[repo-info repo's `repos/%%REPO%%/` directory](https://github.com/docker-library/repo-info/blob/master/repos/%%REPO%%) ([history](https://github.com/docker-library/repo-info/commits/master/repos/%%REPO%%))
(image metadata, transfer size, etc)

%%DOCKER-VERSIONS%%
- **Image updates**:
[official-images PRs with label `library/%%REPO%%`](https://github.com/docker-library/official-images/pulls?q=label%3Alibrary%2F%%REPO%%)
[official-images repo's `library/%%REPO%%` file](https://github.com/docker-library/official-images/blob/master/library/%%REPO%%) ([history](https://github.com/docker-library/official-images/commits/master/library/%%REPO%%))

# User Feedback
- **Source of this description**:
[docs repo's `%%REPO%%/` directory](https://github.com/docker-library/docs/tree/master/%%REPO%%) ([history](https://github.com/docker-library/docs/commits/master/%%REPO%%))

%%USER-FEEDBACK%%
- **Supported Docker versions**:
[the latest release](https://github.com/docker/docker/releases/latest) (down to 1.6 on a best-effort basis)

%%CONTENT%%%%VARIANT%%%%LICENSE%%
15 changes: 0 additions & 15 deletions .template-helpers/user-feedback.md

This file was deleted.

1 change: 1 addition & 0 deletions .travis/check-required-files.sh
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ exitCode=0
for requiredFile in \
content.md \
github-repo \
maintainer.md \
; do
failed=''
for repo in */; do
Expand Down
1 change: 1 addition & 0 deletions adminer/maintainer.md
1 change: 1 addition & 0 deletions aerospike/issues.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
[the Aerospike Forums](https://discuss.aerospike.com) or [GitHub](%%GITHUB-REPO%%/issues)
1 change: 1 addition & 0 deletions aerospike/maintainer.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
[Aerospike, Inc.](%%GITHUB-REPO%%)
15 changes: 0 additions & 15 deletions aerospike/user-feedback.md

This file was deleted.

1 change: 1 addition & 0 deletions alpine/maintainer.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
[Glider Labs](%%GITHUB-REPO%%) (an Alpine community contributor)
1 change: 1 addition & 0 deletions amazonlinux/issues.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
[the Amazon Linux forums](https://forums.aws.amazon.com/forum.jspa?forumID=228)
1 change: 1 addition & 0 deletions amazonlinux/maintainer.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
[the Amazon Linux Team](%%GITHUB-REPO%%)
9 changes: 0 additions & 9 deletions amazonlinux/user-feedback.md

This file was deleted.

1 change: 1 addition & 0 deletions arangodb/maintainer.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
[ArangoDB](%%GITHUB-REPO%%)
1 change: 1 addition & 0 deletions backdrop/maintainer.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
[Backdrop Ops](%%GITHUB-REPO%%)
1 change: 1 addition & 0 deletions bash/maintainer.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
[Tianon (of the Docker Community)](%%GITHUB-REPO%%), [with Chet's support (from Bash upstream)](https://github.com/docker-library/official-images/pull/2217#issue-181031192)
1 change: 1 addition & 0 deletions bonita/maintainer.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
[Bonitasoft Community](%%GITHUB-REPO%%)
1 change: 1 addition & 0 deletions buildpack-deps/maintainer.md
1 change: 1 addition & 0 deletions busybox/maintainer.md
1 change: 1 addition & 0 deletions cassandra/maintainer.md
1 change: 1 addition & 0 deletions celery/maintainer.md
1 change: 1 addition & 0 deletions centos/issues.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
[https://bugs.centos.org](https://bugs.centos.org) or [GitHub](%%GITHUB-REPO%%/issues)
1 change: 1 addition & 0 deletions centos/maintainer.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
[The CentOS Project](%%GITHUB-REPO%%)
15 changes: 0 additions & 15 deletions centos/user-feedback.md

This file was deleted.

1 change: 1 addition & 0 deletions chronograf/maintainer.md
1 change: 1 addition & 0 deletions cirros/maintainer.md
1 change: 1 addition & 0 deletions clearlinux/maintainer.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
[Intel Corporation](%%GITHUB-REPO%%)
1 change: 1 addition & 0 deletions clojure/maintainer.md
1 change: 1 addition & 0 deletions composer/maintainer.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
[Composer](%%GITHUB-REPO%%)
15 changes: 0 additions & 15 deletions composer/user-feedback.md

This file was deleted.

1 change: 1 addition & 0 deletions consul/maintainer.md
1 change: 1 addition & 0 deletions convertigo/maintainer.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
[Convertigo](%%GITHUB-REPO%%)
1 change: 1 addition & 0 deletions couchbase/maintainer.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
[the Couchbase Docker Team](%%GITHUB-REPO%%)
1 change: 1 addition & 0 deletions couchdb/maintainer.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
[Apache CouchDB](%%GITHUB-REPO%%)
1 change: 1 addition & 0 deletions crate/get-help.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
[the public Crate community on Slack](https://crate.io/docs/support/slackin/)
1 change: 1 addition & 0 deletions crate/maintainer.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
[Crate.io](%%GITHUB-REPO%%)
17 changes: 0 additions & 17 deletions crate/user-feedback.md

This file was deleted.

1 change: 1 addition & 0 deletions crux/maintainer.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
currently unmainainted (see deprecation notice)
1 change: 1 addition & 0 deletions debian/maintainer.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Debian Developers [tianon](https://qa.debian.org/developer.php?login=tianon) and [paultag](https://qa.debian.org/developer.php?login=paultag)
1 change: 1 addition & 0 deletions django/maintainer.md
1 change: 1 addition & 0 deletions docker/maintainer.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
[Tianon (of the Docker Project)](%%GITHUB-REPO%%)
4 changes: 0 additions & 4 deletions drupal/content.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,10 +6,6 @@ Drupal is a free and open-source content-management framework written in PHP and
%%LOGO%%

# Who maintains this

This image is not maintained by the Drupal community or the Drupal Security Team. This image is maintained by the docker community.

# How to use this image

The basic pattern for starting a `%%REPO%%` instance is:
Expand Down
1 change: 1 addition & 0 deletions drupal/maintainer.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
[the Docker Community](%%GITHUB-REPO%%) (*not* the Drupal Community or the Drupal Security Team)
1 change: 1 addition & 0 deletions eclipse-mosquitto/maintainer.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
[the Eclipse Foundation](%%GITHUB-REPO%%)
1 change: 1 addition & 0 deletions eggdrop/maintainer.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
[Eggheads (the Eggdrop community)](%%GITHUB-REPO%%)
1 change: 1 addition & 0 deletions elasticsearch/maintainer.md
1 change: 1 addition & 0 deletions elixir/maintainer.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
[the Docker Community](%%GITHUB-REPO%%), [with Elixir's support](https://github.com/docker-library/official-images/pull/1398#issuecomment-180484549)
1 change: 1 addition & 0 deletions erlang/maintainer.md
2 changes: 1 addition & 1 deletion fedora/github-repo
Original file line number Diff line number Diff line change
@@ -1 +1 @@
https://github.com/lsm5/docker-brew-fedora
https://github.com/fedora-cloud/docker-brew-fedora
1 change: 1 addition & 0 deletions fedora/issues.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
[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 [GitHub](%%GITHUB-REPO%%/issues)
1 change: 1 addition & 0 deletions fedora/maintainer.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
[Fedora Release Engineering](%%GITHUB-REPO%%)
15 changes: 0 additions & 15 deletions fedora/user-feedback.md

This file was deleted.

1 change: 1 addition & 0 deletions fsharp/maintainer.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
[the F# Community](%%GITHUB-REPO%%)
1 change: 1 addition & 0 deletions gazebo/maintainer.md
1 change: 1 addition & 0 deletions gcc/maintainer.md
1 change: 1 addition & 0 deletions geonetwork/maintainer.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
[GeoNetwork opensource](%%GITHUB-REPO%%)
1 change: 1 addition & 0 deletions ghost/maintainer.md
1 change: 1 addition & 0 deletions golang/maintainer.md
1 change: 1 addition & 0 deletions gradle/maintainer.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
[Keegan Witt (of the Groovy Project)](%%GITHUB-REPO%%), [with the Gradle Project's approval](https://discuss.gradle.org/t/official-docker-images/21159/8)
1 change: 1 addition & 0 deletions groovy/maintainer.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
[the Apache Groovy project](%%GITHUB-REPO%%)
1 change: 1 addition & 0 deletions haproxy/maintainer.md
1 change: 1 addition & 0 deletions haskell/maintainer.md
1 change: 1 addition & 0 deletions haxe/maintainer.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
[the Haxe Foundation](%%GITHUB-REPO%%)
1 change: 1 addition & 0 deletions hello-seattle/maintainer.md
1 change: 1 addition & 0 deletions hello-world/maintainer.md
1 change: 1 addition & 0 deletions hola-mundo/maintainer.md
1 change: 1 addition & 0 deletions httpd/maintainer.md
1 change: 1 addition & 0 deletions hylang/maintainer.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
[Paul Tagliamonte, Hy BDFL](%%GITHUB-REPO%%)
1 change: 1 addition & 0 deletions ibmjava/get-help.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
[the developerWorks forum for IBM Java Runtimes and SDKs](https://www.ibm.com/developerworks/community/forums/html/forum?id=11111111-0000-0000-0000-000000000367)
1 change: 1 addition & 0 deletions ibmjava/issues.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
[GitHub](%%GITHUB-REPO%%/issues); for troubleshooting, see our [How Do I ...?](http://www.ibm.com/developerworks/java/jdk/howdoi/) page
1 change: 1 addition & 0 deletions ibmjava/maintainer.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
[IBM Runtime Technologies](%%GITHUB-REPO%%)
7 changes: 0 additions & 7 deletions ibmjava/user-feedback.md

This file was deleted.

1 change: 1 addition & 0 deletions influxdb/maintainer.md
1 change: 1 addition & 0 deletions irssi/maintainer.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
[Jessie and Tianon (of the Docker Community)](%%GITHUB-REPO%%), [with the appreciation of the Irssi Project](https://twitter.com/GeertHauwaerts/status/559131523145035776)
1 change: 1 addition & 0 deletions java/maintainer.md
1 change: 1 addition & 0 deletions jenkins/maintainer.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
[the Jenkins Project](%%GITHUB-REPO%%)
1 change: 1 addition & 0 deletions jetty/maintainer.md
1 change: 1 addition & 0 deletions joomla/maintainer.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
[Joomla!](%%GITHUB-REPO%%)
1 change: 1 addition & 0 deletions jruby/maintainer.md
1 change: 1 addition & 0 deletions julia/maintainer.md
1 change: 1 addition & 0 deletions kaazing-gateway/maintainer.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
[the Kaazing Docker Maintainers](%%GITHUB-REPO%%)
1 change: 1 addition & 0 deletions kapacitor/maintainer.md
1 change: 1 addition & 0 deletions kibana/maintainer.md
1 change: 1 addition & 0 deletions known/maintainer.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
[Known](%%GITHUB-REPO%%)
1 change: 1 addition & 0 deletions kong/maintainer.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
[the Mashape Docker Maintainers](%%GITHUB-REPO%%)
1 change: 1 addition & 0 deletions lightstreamer/maintainer.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
[the Lightstreamer Server Development Team](%%GITHUB-REPO%%)
1 change: 1 addition & 0 deletions logstash/maintainer.md
Loading

0 comments on commit 0c2b9dc

Please sign in to comment.