Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

5000 character limit on descriptions #238

Closed
yosifkit opened this issue Aug 10, 2015 · 28 comments
Closed

5000 character limit on descriptions #238

yosifkit opened this issue Aug 10, 2015 · 28 comments

Comments

@yosifkit
Copy link

There was not a limit on the previous hub and some of the Official Images are beyond that.

Can we remove or greatly increase the limit?

As a workaround we'll probably just cut all the official image descriptions on the hub to a minimal set and link back to github.

@ChristopherBiscardi
Copy link
Contributor

For easy reference, the Official Images listed come in at approx 5300, 8500 and 5300 chars respectively.

Ping @rrarunan @kencochrane I think it makes sense to bump this limit considerably

@tianon
Copy link

tianon commented Aug 11, 2015

Some more interesting byte counts:

$ wc -c */README.md | sort -n
   631 scratch/README.md
  2157 cirros/README.md
  2231 ubuntu-upstart/README.md
  2650 hipache/README.md
  2727 celery/README.md
  2774 julia/README.md
  2841 opensuse/README.md
  2958 thrift/README.md
  2979 glassfish/README.md
  3055 ubuntu-debootstrap/README.md
  3095 docker-dev/README.md
  3148 ghost/README.md
  3275 registry/README.md
  3333 hylang/README.md
  3373 rakudo-star/README.md
  3386 hello-world/README.md
  3422 logstash/README.md
  3496 mageia/README.md
  3509 memcached/README.md
  3555 perl/README.md
  3561 sonarqube/README.md
  3637 owncloud/README.md
  3663 irssi/README.md
  3695 kibana/README.md
  3720 oraclelinux/README.md
  3760 haproxy/README.md
  3823 crux/README.md
  3896 jenkins/README.md
  3910 fedora/README.md
  3947 alpine/README.md
  4187 kaazing-gateway/README.md
  4254 elasticsearch/README.md
  4307 gcc/README.md
  4382 nginx/README.md
  4493 clojure/README.md
  4511 sentry/README.md
  4535 busybox/README.md
  4719 httpd/README.md
  4862 swarm/README.md
  4865 neurodebian/README.md
  4923 r-base/README.md
  4970 jruby/README.md
  4975 tomcat/README.md
  5087 crate/README.md
  5276 percona/README.md
  5343 ros/README.md
  5357 ubuntu/README.md
  5404 mono/README.md
  5493 redis/README.md
  5543 jetty/README.md
  5579 rethinkdb/README.md
  5678 debian/README.md
  5684 odoo/README.md
  5697 maven/README.md
  5734 mariadb/README.md
  5916 rails/README.md
  5917 drupal/README.md
  5999 php-zendserver/README.md
  6057 joomla/README.md
  6092 haskell/README.md
  6283 wordpress/README.md
  6410 django/README.md
  6421 java/README.md
  6540 rabbitmq/README.md
  6619 aerospike/README.md
  7114 iojs/README.md
  7271 pypy/README.md
  7322 php/README.md
  7339 mongo/README.md
  7429 websphere-liberty/README.md
  7570 buildpack-deps/README.md
  7616 ruby/README.md
  7652 centos/README.md
  7966 postgres/README.md
  8224 arangodb/README.md
  8380 node/README.md
  8416 golang/README.md
  8602 redmine/README.md
  9631 python/README.md
 10887 mysql/README.md
 11584 gazebo/README.md
 12062 cassandra/README.md
 20088 couchbase/README.md

@ChristopherBiscardi
Copy link
Contributor

thanks @tianon That's really helpful 😄

@kencochrane
Copy link
Contributor

So what do we want for a limit? 20k seems really high does it need to be that high? Higher, lower? Honestly I don't care what it is I just don't want to make the change 5 times.

/cc @fxdgear

@yosifkit
Copy link
Author

My opinion would be to put it at least at 100k characters. That is only 100-400 kB of storage and can easily be gzipped.

@tianon
Copy link

tianon commented Aug 11, 2015

I'm definitely curious why this particular limit was chosen during the switch -- knowing why the limit was set to 5000 would be helpful for picking a new limit, I'd imagine.

@kencochrane
Copy link
Contributor

@tianon I can't remember why, but I'm pretty sure everyone was involved, because this has a major case of de ja vu if not. :)

IIRC we didn't want it too big since everything is coming across in the API responses and it would make them much bigger, and realistically how many repos need more then 5000 characters?

I personally think 100k is way too big. having to pass that around in the API would really suck. maybe 25k?

@rrarunan
Copy link

@tianon @kencochrane I agree with the 25K cap. Especially, after looking at the data showing only one official repo with around 20K characters. (couchbase)

@nhsiehgit
Copy link

@kencochrane @ChristopherBiscardi has this fix been deployed?

@rrarunan rrarunan self-assigned this Aug 19, 2015
@fxdgear
Copy link

fxdgear commented Aug 20, 2015

@nhsiehgit Not yet. There's a PR under review for it.

@psftw
Copy link

psftw commented Sep 2, 2015

Confirmed the fix is deployed and allows 25,000 characters or less. 🐈

cc @tianon @yosifkit

tianon added a commit to docker-library/docs that referenced this issue Sep 2, 2015
nghiant2710 pushed a commit to nghiant2710/docs that referenced this issue Sep 8, 2015
@yosifkit
Copy link
Author

Will there be an update to the page to let users know the new limit? It still says "Limit 5000 Characters", even though the limit is 25k.

@kristiehoward
Copy link

Yes, @yosifkit we will be updating the repo description page with the new limit shortly

ckeyer added a commit to ckeyer/docker-library-docs that referenced this issue Jan 6, 2016
explain the default db for postgres

Script + resources for generating README.md with "Issues and Contributing" section

Run gen-docs for postgres

logos for all the things

pulled descriptions from registry.hub

gcc 'what is' and short

Added 'How to use this Image' to the appropriate README files.

Clarified phrasing on gcc image, and made example more clear

Added template for hylang documentation

Cleaned up language in the gcc documentation

Added basic documentation for the go container. More advanced usage to come.

Added hylang logo

Found and destroyed an incomplete sentence in the gcc readme.

Added documentation for basic golang usage.

Added custom redis.conf examples to the redis documentation.

Added hylang, perl, and python docs

specify tag for rails

Change rails short desc as per FredLifton

Java/Oracle legal stuff

Added Java README

Applied minor fixes to readme of golang and gcc

Minor fixes to several readmes, and fixed ruby readme to be consistent with the other scripting languages.

Shorter footer for issues and contrib

Extra short footer about issues and contrib

Added PHP README

Fix some spelling and specify a tag

Better hy description

Specified ruby:onbuild

Added minor spelling fix and tags to Dockerfile examples.

Need to specify apache, not cli

Added php short

Started on hylang

bug fix

Fix the golang link in the proper file, properly

Update the other golang README to match

Add golang:cross directions

Perl is special, it is hosted in upstream

node: remove CMD from Dockerfile example and list constraints

Finished documentation for Hylang

Quoted all instances of pwd and generated docs

Update magic gen-docs script to not mangle Perl repo links

Update hylang to use `.hy` instead of `.py` ;)

Add special case repo URL for "hylang"

Add Java title

Fix Java CMD

Run s/ADD/COPY/g as appropriate

Tweak MySQL in minor ways for consistency

Add question marks to question titles

Add question mark to question title

Added clojure docs

Add link to `lein` upstream and update `CMD` to use JSON syntax

Added an example of single line clojure usage.

Rename "gen-docs.sh" to "update.sh"

Update/fix hello-world description

Add a basic "buildpack-deps" description

Add simple script to auto-update the hello-world description

Update "update.sh" to run any available repo-specific "update.sh" scripts before generating README.md

Add script to autogenerate a "Tags and `Dockerfile` links" section for each repo

Update "update.sh" to run "generate-dockerfile-links-partial.sh" for each repo and add it to the beginning of each description

Add generated tags and Dockerfile links to the README.md files

Update "Tags and `Dockerfile` links" formatting to be easier to read and scan quickly

Special case another community contribution: Clojure

Mention Oracle ownership.

Add license file (Expat)

Revisions and edits to footer content.

Apply the footer update from fred

Reflow all the language stack `README-content.md` files to 80 columns and incorporate Fred's changes

This also includes Fred's updates to the `README-short.txt` files, and a bunch of very minor changes for consistency (using "PHP" instead of "php", ending sentences that describe and lead into a code block with a ":", using "Go" instead of "Golang" and "Hy" instead of "Hylang" within prose, not using periods at the end of headlines, etc).

A really fun one included here is that Java mentioned both using GNU Make inside the container (and `java` doesn't include `make` presently), and some of the prose mentioned `go build` after we ran `javac`, which was extra neat.

Run ./update.sh

Change "./update.sh" to be template-based instead of footer-based

This makes it slightly easier to manage and work with (especially if we want to change the order of things in the future).

Remove some unnecessary (and unimportant) extra whitespace from the "redis" README

Update "Tags" section to be labelled "Supported tags" instead, to make it clear that this isn't the full list of tags, but is instead the list of tags that are currently supported for active usage

Adds license.md

Adds license.md

Adds license.md

Adds license.md

Adds license.md

Adds license.md

Add license support to REAMDE-template.md and update.sh

run update.sh, ubuntu changes

Changed python documentation to use the onbuild example, similar to the ruby example.

Reflowed text to 80 columns

Run update.sh

Add more canonical "manifest line parsing" based on bashbrew scripts

Added a very basic how-to use this image, and a reminder to add a proper example.

Added license.md

Rename LICENSE -> license

Adds license.md

Update license.md

Adds license.md

Update license.md

move README-content.md to just content.md

run update.sh (for fred's license changes)

Add a script for pushing descriptions trivially via vimdiff

This is inspired by Gentoo's `dispatch-conf`, which I've got configured to use `vimdiff` on all my Gentoo boxen, and it's just about the greatest thing ever.

This has a nasty little `monkey_patch` to Mojo's `CookieJar` that needs more digging to figure out what's going on there, but otherwise it's pretty solid.

Add jruby docs

Wrap to 80col

Add generated JRuby README.md

Update ubuntu links

Change "other" git repo link handling to use an associative array in update.sh

Fix a few minor issues with the push script (especially UTF-8 compatibility)

Adding centos logo (removed whitespace to make it 200x200)

Fix NGINX data path

Fix a bunch of NGINX stuff to point to the right places :)

Update Perl logo

Add LOGO magic to many contents and update.sh

Run `update.sh`

Update hello-world ID again

busybox descriptions

Add busybox logo

Add a basic description for CentOS adapted from the existing description and some basic copy from Wikipedia

Tweak the IRC language slightly by making it a separate paragraph

This is especially useful for READMEs where %%MAILING_LIST%% is actually plugged in, making a three-part list that we can't easily add an Oxford comma to.

Also, this allows us to explain that not all the image maintainers will necessarily be in that IRC channel ("You can also reach _many_ ...").

Run `./update.sh`

Update ubuntu to match Hub description

Add fedora with content from Hub

Update jruby tags

Add example to generate Gemfile.lock for ruby bundler

Run update.sh, new tags for redis & golang

Add license link to gcc, java, node

Add initial Mageia documentation

Run update.sh for dockerfile links

Add mageia logo to README

Run ./update.sh

Run ./update.sh (just for golang)

Add logos for various images

Run ./update.sh

Added documentation for MySQL environment variables

Updated phrasing to satisfy tianon.

Updated phrasing to satisfy tianon.

Update a number of short descriptions to be 100 characters or less to reflect the new Hub length restriction

Add documenation of /docker-entrypoint-initdb.d

Add neurodebian logo

Run update.sh

Fix `centos:centos6` tag reference

Update neurodebian logo transparency

Add explicit error handling after we update a description (in case our short description is too long or something similar)

Add a bunch more content

Most of these are just synced down from what the Hub already has, but some of these I've updated here.

Run update.sh

Add a sentence with a link to the manifest file for reach repo

Add crate +logo, allow custom user-feedback section

Fix whitespace

Run update.sh for new goodness

Mostly tw=80, also a few dockerfile links from update.sh

Add a basic Dockerfile and fix some minor issues in push.pl

Zend initial commit

Updated README

Updated README

Updated docs to reflect ZS version tags

Reorganized for update.sh

Update content.md

Update content.md

Reorganized for update.sh

Run update.sh

Convert newlines to Unix (and end all content files with a single newline)

Fix spurious vimdiff showing up with identical files

Run update.sh

Add tomcat documentation

Run update.sh

Fixed two issues in the 'Start a Go instance in your app' section and added some content on the CMD instruction. Issue 24 @ https://github.com/docker-library/golang

Restored comma as suggested by the code style guide, thanks tianan

Restored comma as suggested by the code style guide, thanks tianan

Restored the CMD instruction to the Dockerfile and removed the CMD instruction explanation, this is a bit of a simplification but is a simplier explanation for a newbie

Revert "Restored the CMD instruction to the Dockerfile and removed the CMD instruction explanation, this is a bit of a simplification but is a simplier explanation for a newbie"

This reverts commit 9e53ea7.

Added extra qualification regarding when running the image with no arguments

edited license information

Conflicts:
	php-zendserver/license.md

Run update.sh

Add mono docs

Run update.sh

Cut mono short desc down to less than 100

Run update.sh

Add httpd docs

Add php.ini usage

Add maven docs

Add missing .

Add license for mongo and redis, docs link for mongo

add haskell docs

apply fixes based on feedback from tianon

Run update.sh

Fix missing COPY, update.sh supported versions

Mojo::DOM::val is deprecated :(

Fix haskell formatting

Run update.sh

Add sentry

Run update.sh

Clarify ubuntu-upstart support level

Add script to generate stub README for docker-library repos

Run update.sh

Add a notice for behavior on database initialization

Add postgres docs for environment variables

Add note for clarification

Run update.sh

Fix a number of "too-specific" versions

MariaDB docs

Run update.sh for mariadb

Get rid of .keep files since we have stuff in the folders

Run update.sh

extended multicast section in crate readme

Fix some minor markdown formatting and wrap to 80 columns

Run update.sh

Add a README.md

Flow to 80 columns

boilerplate for r-base image documentation
Still needs a proper "how to use this image" section;
this just fills in the license, logo, wikipedia summary etc

one set of edits

add a few more realistic examples of use cases

use the new default CMD in the example use

update Dockerfile links

Add license link and correct CMD example as suggested by @tianon

Run update.sh, add r-base user-feedback override

Flow R docs to 80 columns

Run update.sh

Add section on generated README.md's

Update fedora docs Re: f21 release

fedora:latest now points to fedora:21 and is the official Fedora 21
docker image. fedora:20(and heisenbug) and fedora:rawhide are still
semi-official.

Signed-off-by: Lokesh Mandvekar <lsm5@fedoraproject.org>

Run update.sh

Remove --system from ruby's "bundle install"

Run update.sh

Switch template tags to use hyphens instead of underscores

Add "DOCKER-VERSIONS" section to each README.md

Replace "Docker Version Support" with "Supported Docker versions" to be more consistent

Run update.sh

Run update.sh

Docs for pypy

Run update.sh for pypy

Run update.sh, jruby mongo mysql php pypy

Run update.sh

/me whistles

Run update.sh

Add HAProxy documentation

Run update.sh

Add memcached docs

Add note about memcached SIGTERM

Swap memcached docker run flags

Add $(user -g) and whitespace

Add Django Documentation

Fix django docs to use django:onbuild rather than python:onbuild

Remove django/.keep dir and add one-liner example to django docs

Fix single-line example to include -w option

Fix minor issue (to be reflected in django image) and add bootstrap example

Add $(id -g) to the bootstrap example

Add initial rabbitmq docs

Run update.sh

Run update.sh

Add Oracle Linux documentation.

Fixed logo URL.

Added documentation about older version images being vulnerable to known security issues.

Remove OL6.5 references

Fix up image tags.

Fix formatting.

Updated doc file layout as per updated requirements and generated README.md  via update.sh

Signed-off-by: Avi Miller <avi.miller@oracle.com>

Fix minor whitespace issue in update.sh

Fix some minor markdown issues (that I'm not sure the Hub's renderer will handle properly) and remove an unused file

Run update.sh

Remove SIGTERM note from memcached docs

As of 1.4.22, it's FIXED UPSTREAM! 🎉

Run update.sh

Add thrift docs

Run update.sh

Documentation fix-up, add systemd docs

update via ./update.sh centos

Run update.sh

Run update.sh

[ADD] Odoo documentation

[ADD] Section on how to restore filestore in a new instance

[IMP] Update Odoo section

[FIX] POSTGRES_USER and POSTGRES_PASSWORD can be arbitrarily set

The run.sh script of odoo image now uses environment variables
DB_ENV_POSTGRES_USER and DB_ENV_POSTGRES_PASSWORD to configure odoo

[ADD] Run Odoo with a custom configuration

[ADD] Tag latest and section 'How to upgrade'

Run update.sh

Remove apt lists in our docs Dockerfile for consistency :)

Add https info to httpd

Run update.sh

Run update.sh

Realphabetize the otherRepos list in update.sh

Add official Node upstream repo to otherRepos in update.sh!

Run update.sh

Run update.sh

Run update.sh golang

Run update.sh debian ubuntu*

Add description for `docker-php-ext-install`

Make this more clear

Add backticks.

Make `Dockerfile` shorter and better

Add iojs

Run update.sh

Run update.sh

Add some documentation about where the line between the new variants of buildpack-deps is

Run update.sh buildpack-deps

Add WebSphere Liberty docs

Updates based on PR feedback

Swap back-ticks for indents

Run update.sh

Add irssi official image docs!

Docker-DCO-1.1-Signed-off-by: Jessica Frazelle <jess@docker.com> (github: jfrazelle)

Run update.sh

Run update.sh

Run update.sh

Fix minor typo

Run update.sh

Run update.sh

Run update.sh

Run update.sh

Run update.sh

Run update.sh

Run update.sh

Run update.sh

Run update.sh

Add docs for RethinkDB

Run update.sh

Run update.sh

Run update.sh

Replace `$(pwd)` with `$PWD`

Run update.sh

Run update.sh

Run update.sh

Run update.sh

Correct indentation

Run update.sh

Add documentation for `WORDPRESS_DB_HOST`

[wordpress] Document need for username/password with external db

Run update.sh

Run update.sh

Add elasticsearch documentation.

Add missing CMD argument in elasticsearch example

Use `-d` in example commands for elasticsearch

Document elasticsearch data volume

Update license information

Make english gooder

Update configuration File (php.ini) Path

The configuration File Path is not /usr/local/bin but /usr/local/etc/php

Update configuration File (php.ini) Path

Update content.md

Fix Python license....

Run update.sh

Add Jetty documentation

Point jetty at md5/docker-jetty

Shorten README-short.txt to under 100 characters

Shrink logo to fit in 200x200

Run update.sh

Fixed broken links to npm doc

Run update.sh

fix a typo (to enable jpeg support)

Run update.sh

update for nodocs, bold NO UPDATES for minor release

label rolling builds and minor tags in documentation

Run update.sh

Adding in Mac material. Tweaking copy a bit for practice.

Signed-off-by: Mary Anthony <mary.anthony@docker.com>

Whitespace adjustments and run update.sh

Run update.sh

Fix rails "onbuid" typo

Closes docker-library/rails#23

Add swarm

Signed-off-by: Andrea Luzzardi <aluzzardi@gmail.com>

Add swarm to update.sh

Signed-off-by: Andrea Luzzardi <aluzzardi@gmail.com>

Run update.sh swarm

Signed-off-by: Andrea Luzzardi <aluzzardi@gmail.com>

Run update.sh

Add markdownfmt .travis.yml to enforce more consistent Markdown formatting

FORMAT ALL THE THINGS

Run update.sh

Update documentation to mention canonical Markdown formatting

Add script for running markdownfmt easily

Run update.sh

Add reference to beta license

Run update.sh

Run update.sh

Run update.sh

Update push script for Mojo changes

 - http://mojolicio.us/perldoc/Mojo/UserAgent/CookieJar.txt

Use official image for push script and specify mojo version

Run update.sh

Update php:5.5 references to be php:5.6

Fixes docker-library#142

Reformat PHP's "more extensions" example to match our standard Dockerfile formatting

Add "build status" badge after paragraph describing Travis

Run update.sh

Unindent LICENSE

2015

Fix downloading older Mojolicious version

Turns out BackPAN doesn't have SSL, so we can't have fully secure `cpanm` _and_ have old versions of our dependencies. 😢

Run update.sh

Fix "Use of uninitialized value $val in concatenation (.) or string at ./push.pl line 82."

Run update.sh

Add GlassFish stub

Run update.sh

Add more GlassFish info, especially README-short.txt

Update Travis to check -short.txt lengths too

Move helper scripts and templates to a directory

Run update.sh

Run update.sh

Add some official docker-compose.yml scaffolding

This includes an example `docker-compose.yml` for WordPress.

Added aerospike

Tweak aerospike formatting for markdownfmt

Fix broken link

Drop "-t" in markdownfmt.sh so we can redirect output

Run update.sh

Run update.sh

Document use of `setuid` module and user `jetty`

Fix documentation of JETTY_STATE location

Run update.sh

Run update.sh

Run update.sh

Add percona based on maria, update some wording, and resync across the MySQL board

Add some basic initial ghost documentation

Add some basic initial celery documentation

Run update.sh

Run update.sh

Run update.sh

Run update.sh

Odoo - Custom configuration and mounted addons

Fix the path to filestore as well

Fix markdown formatting for odoo

Document changes to allow Jetty to run --read-only

Run update.sh jetty

Remove --verify to combat more BackPAN irritation 😢

Run update.sh

Run update.sh

Run update.sh

jetty 9.2.10

Run update.sh

docs for new Alpine Linux image

Run update.sh

Fix markdownfmt 👼

Updated update.sh for new Oracle Dockerfile location and rebuild README.md for Oracle Linux to include 7.1.

Run update.sh

Run update.sh

Run update.sh

Run update.sh

Run update.sh

Run update.sh

Add description how to use markdownfmt.sh

Describe how to add extensions into the wordpress image (see docker-library/wordpress#68)

Fixed typo

Run update.sh to update based on content.md

Format according to markdownfmt

Worsdsmith a bit of wordpress

Run update.sh

Add initial logstash documentation.

Run update.sh

Merge from the README.md of the mysql/mysql-server image.

Update to the current general-use MySQL logo.

Update

Regenerate

Update on how to view logs: MySQL logs go to stderr.

Tweak description of MYSQL_ALLOW_EMPTY_PASSWORD

Fix code formatting inside numbered list

Add missing end %% to a REPO reference

Fix formatting as required by markdownfmt

Adjust to pass markdownfmt

add back in code block indents.

Rewrite the custom config file section

Run update.sh

Point users from docker-dev to dockercore/docker for an up-to-date development environment

Run update.sh

Run update.sh

Add julia documentation

Run update.sh

Initial onbuild/slim description generation

Run update on all the things to generate onbuild docs

Detect if base image uses buildpack-deps

default `image-[version]` wording, and ran `update.sh`

Style changes and only process dockerfiles from github.com

Run update.sh

Add glassfish url

Add files for Rakudo Star

Fix rakudo-star/content.md according to markdownfmt

Add README for rakudo-star

Add rakudo star URL to update.sh

Run update.sh

Add info to postgres for locale setup

Run update.sh

MySQL custom config files must end in .cnf

Document that custom config files in /etc/mysql/conf.d must end in .cnf.
Otherwise, MySQL will ignore the files.

Update for jetty repository move

Run `update.sh jetty`

Run update.sh

Add documentation for where the docs live and how to update them

Run update.sh

Add trailing `/` for consistency

Run update.sh

Add info about Oracle Java

Run update.sh

Run update.sh

rename haskell repository and tweaks

Improve our Vim configuration for pushing descriptions

Run update.sh

More Vim improvements and adding my "push.sh" wrapper (especially to help remind that "-e TERM" is a Good Idea to get the most out of these changes)

Updating Oracle Linux docs to point to the right Freenode IRC channel.

3.5.8

Fix run command

fix docker run command

Remove extra dash from `-it` in example code

Reorganize "push.pl" to put the "vimdiff" logic in one place for cool dispatch-conf-alike behavior

Run update.sh

Add limited usage and upgrade information

markdownfmt websphere-liberty

document exposed ports

update elasticsearch content to include exposed ports

de-tab line between quote and paragraph

examples of volume mapping

expand data container example

improvements

Update content.md

Remove blank lines at the end of the doc

Run update.sh

Re-consistentize $PWD usage

Note that "FROM scratch" is now a special case

Add "quit" choice to push.pl

Run update.sh

Run update.sh

Run update.sh

Fix postgres quote formatting

Aerospike 3.5.9

Run update.sh

Update wordpress to use %%REPO%% more aggressively so sections can be reused without change more often

Add initial drupal documentation

Point out that wordpress's own Dockerfile has an "extra libraries" example

Run update.sh

Run update.sh

Update Dockerfile link to 0.6.2

Run update.sh

Run update.sh

Run update.sh

Run update.sh

Run update.sh

Add docs for cassandra

Run update.sh

Run update.sh

Relax repo 404 "die" to just "warn and next" (darn cassandra, still in-progress)

Run update.sh

Run update.sh

Run update.sh

Update Jetty docs to clarify webapp deployment

cf. appropriate/docker-jetty#9

Run update.sh

Run update.sh

Run update.sh

Update README.md

typo

Update user-feedback.md

typo

Run update.sh

Add a better long description for Ubuntu

Add better short descriptions for Debian and Ubuntu

Run update.sh

Minor updates to the debian description

Rearrange ubuntu-debootstrap sentence to work around markdownfmt bug

Run update.sh

Update "scratch" and "hello-world" to be more complimentary

Run update.sh

Run update.sh

Run update.sh

Run update.sh

Add SonarQube

Run update.sh

Update travis.yml to give diff of needed fixes

Run update.sh

Run update.sh

Add "-f" to curl invocations

Run update.sh

Run update.sh

Run update.sh

Added info about project fork/deprecation

Modified the 'Quick version' section

Run update.sh

Run update.sh

documenting multi-dc support

A little markdownfmting and some helpful links

Run update.sh

Add Couchbase Server Official Docker image

Updated based on PR comments

Improved discussion of volumes. Fixed to use Official Image couchbase name
rather than couchbase/server. Move all licensing info to license.md.

Re-run markdownfmt.sh and update.sh

Fix ".travis.yml" handling of "$files" 😇

Run update.sh

Run update.sh

Add "--batchmode" flag for automated docs updates (still displays all diffs)

Run update.sh

Run update.sh

Run update.sh

PIPEFAIL

MOAR PIPEFAIL

Add more explicit description for why "onbuild" variants exist and for when they're appropriate to use (and when it's time to "graduate")

Run update.sh

Support non-tty mode in push.sh

Run update.sh

Run update.sh

Run update.sh

Adding docs for ROS repo

Re-alphabetize

Run update.sh

Handle more failure edge cases in update.sh

Run update.sh

Run update.sh

Run update.sh

Add mongo docs for volume, storageEngine, mmap on vboxsf

Run update.sh

add note about daemon mode

Run update.sh

Run update.sh

Run update.sh

Run update.sh

Run update.sh

Run update.sh

Run update.sh

Run update.sh

Add some basic kibana docs

Run update.sh

Run update.sh

Run update.sh

Run update.sh

Run update.sh

Run update.sh

Run update.sh

Run update.sh

Run update.sh

Run update.sh

Run update.sh

Run update.sh

Run update.sh

Run update.sh

Run update.sh

Run update.sh

Run update.sh

Run update.sh

Run update.sh

Run update.sh

Run update.sh

Run update.sh

Run update.sh

Run update.sh

Run update.sh

Run update.sh

Run update.sh

Run update.sh

Run update.sh

Run update.sh

Filter out unnecessary garbage tags from the "hello-world" description

Add slightly better 'awk' condition

Run update.sh

Run update.sh

Run update.sh

Provide an example of how to set the memory usage

Add travis test to check for any <image>/README.md changes

 - the :'' is to ensure the yml parser doesn't think it is a mapped value

Run update.sh

Corrected onbuid typo to onbuild.

Correct tag misspelling

Fix some minor whitespace issues in jruby/content.md

Run update.sh

fix typo

Run update.sh

Adding docs for Kaazing-Gateway

Added kaazing image

Autogenerated README

Removed newline at end of file

In kaazing-gateway: Fixed typo, and update LOGO to pull using %LOGO

Added Kaazing Gateway

Generated kaazing-gateway README

Run update.sh

Run update.sh

Run update.sh

Run update.sh

typo

typo

Run update.sh

made tiny improvement to the wording

Run update.sh

update fedora/content.md about f20 going EOL

Signed-off-by: Lokesh Mandvekar <lsm5@fedoraproject.org>

Run update.sh

corrected example run command

Added "redis-server" into the example run command to use a custom config
file at launch
docker-library/official-images#858

Moved 2c41104 to content.md

Added "redis-server" into the example run command to use a custom config
file at launch
docker-library/official-images#858

Run update.sh

Remove RABBITMQ_NODENAME references

Add notes about the "Erlang Cookie" for RabbitMQ

Run update.sh

Run update.sh

Run update.sh

Run update.sh

Run update.sh

Run update.sh

kibana documentation : environnement variable

The official doc does not mention that you can pass the address of you elastic search instance with the `ELASTICSEARCH_URL` environment variable.

See https://github.com/docker-library/kibana/blob/master/4.1/docker-entrypoint.sh

Run update.sh

Run update.sh

Run update.sh

Run update.sh

Run update.sh

Run update.sh

Run update.sh

Run update.sh

Run update.sh

Run update.sh

Run update.sh

Run update.sh

Run update.sh

Add code highlighting to volume mount example

Double tab indentation required to add code in a list

Run update.sh

Run update.sh

Run update.sh

Run update.sh

Update variant.sh with a bit more flexibility (so we can have "variant override" files per-image)

Run update.sh

Run update.sh

Run update.sh

Add a blurb about redis:32bit

Run update.sh

Run update.sh

Run update.sh

Add documentation for how to use Celery and Redis together

Run update.sh

Run update.sh

Explain `PGDATA` env variable, which is useful when data volume is fs mount.

Run update.sh

Run update.sh

Run update.sh

Run update.sh

Add the documentation for arangodb docker image

Incooperate review results, markdownfmt changes, add way to override the config file.

Shorten README-short.txt

remove one last refenece of the now gone help=1

add missing url

Run update.sh

Run update.sh

Add new sentry setup

Add docs for owncloud

Run update.sh

Run update.sh

Add documentation for new postgres initdb logic

Run update.sh

Run update.sh

Run update.sh

Run update.sh

Run update.sh

Run update.sh

Add instructions on how to set default user and password

Include instructions on README showing how to use RABBITMQ_DEFAULT_USER and RABBITMQ_DEFAULT_PASS environmental variables

Moved instructions to content.md. Added vhost options

change space to tab and delete spaces on blank line

Adding Gazebo Docs

Adding notes on uses cases, ports and volumes

Adding notes on devices and volumes

Spellchecking

Adding deployment example

tweak wording

minor tweaks
as per @yosifkit suggestions

Adding notes on libgazebo-dev

Run update.sh

Run update.sh

Run update.sh

Fix for deprecated mojo function

Run update.sh

Run update.sh

Run update.sh

Run update.sh

Add note on use of boot2docker ip

Document move from IBM JRE to OpenJRE

Run update.sh

Run update.sh

Mesh Clustering

Run update.sh

Run update.sh

Adding docs for Joomla image

Run update.sh

Run update.sh

Remove Polls

Run update.sh

Run update.sh

Run update.sh

Run update.sh

Run update.sh

Update hello-world short description in minor way

Add simple .dockerignore

Update push.pl for the new v2 hub! 🎉

So much cleaner now! 🤘

Run update.sh

Handle failure in push.pl slightly better

Add redmine docs

Run update.sh

Run update.sh

Run update.sh

Run update.sh

Add in docs for NATS

Apply `markdownfmt.sh` pass on content.md for docker-library/docs PR

docker-library#306

Run update.sh

Run update.sh

Add some temporary description trimming

Update "hello-world" description

Adding Deployment suggestions to ROS docs

Adding note for experimental Docker

for future networking features.

Fixing typos

Tweeking version note

Run update.sh

Correction

docker network is still an experimental feature and is not yet in v1.8 :(

rm whitespace

Run update.sh

Run update.sh

Run update.sh

Use explicit-type code blocks in a lot of obvious places (now that the Hub actually renders these _better_ than the no-type versions)

Run update.sh

Support svg logos too

Adds rocket.chat

Run update.sh

[php] Fix php.ini COPY Documentation

Apparently COPY will expect a full target path nowadays:

```
Step 0 : FROM php:5.6-apache
 ---> 86db229ab259
Step 1 : COPY config/php.ini /usr/local/etc/php
stat /var/lib/docker/devicemapper/mnt/cb571a2599018afc008c08a509d201d4937eed74a22621efa94e3ef32bebc869/rootfs/usr/local/etc/php/php.ini: not a directory
```

Run update.sh

Run update.sh

Run update.sh

Run update.sh

Run update.sh

Run update.sh

Run update.sh

Run update.sh

Run update.sh

Run update.sh

Run update.sh

Add initial docker docs

Run update.sh

Run update.sh

Run update.sh

Run update.sh

Fix command for running custom storageEngine on mongodb

Shortened and fixed conf flag

Run update.sh

Run update.sh

Run update.sh

Run update.sh

Run update.sh

Run update.sh

Fixed typo in db-filter config

moved from docker-library#324

Run update.sh

Run update.sh

Document new websphere-liberty images

Add fenced code block for first example

Run update.sh

Expand documentation of postgres initdb logic

* Explain the execution order of initdb extension files
* Document that *.sql scripts are run as $POSTGRES_USER
* Recommend running psql commands inside *.sh scripts as $POSTGRES_USER

Break up the paragraphs in initdb explanation

Run update.sh

Run update.sh

Run update.sh

Run update.sh

Run update.sh

Run update.sh

Run update.sh

Run update.sh

Updated documentation for recent jetty image changes

Corrections from feedback from @md5

Appease markdownfmt

Adjust example Dockerfile for adding new modules

More markdownfmt appeasement

Run update.sh

Run update.sh

Added WORDPRESS_TABLE_PREFIX environment variable

Run update.sh

Run update.sh

Run update.sh

Update length limit to 25k

See docker/hub-feedback#238 (comment)

Run update.sh

Clarify slightly that the image is actually updated by making pull requests against the official-images repository

Run update.sh

Run update.sh

Run update.sh

Add a link to Jérôme's dind blog post to our "docker" image description

Run update.sh

Run update.sh

Run update.sh

Run update.sh

Run update.sh

Run update.sh

Add new "generate-tag-details" helper that creates detailed files with tag data

Rewrite "generate-tag-details.sh" in Perl for better correctness and cooler features

Fix silly UTF-8 Perl bug

Add some simple retries logic to generate-tag-details.pl for better stability

Skip repos that don't have official image tags in update-tag-details.sh

Run update-tag-details.sh

Run update.sh

Run update.sh

sentry: update to point to new repo

Run update.sh

Run update-tag-details.sh

Run update.sh

Run update-tag-details.sh

Run update.sh

Run update.sh

Run update-tag-details.sh

Run update-tag-details.sh

Run update.sh

Run update-tag-details.sh

Run update.sh

Run update.sh

Run update.sh

Run update-tag-details.sh

Run update-tag-details.sh

Run update-tag-details.sh

Run update.sh

Run update.sh

Run update-tag-details.sh

Run update.sh

Run update-tag-details.sh

Run update.sh

Run update-tag-details.sh

Run update.sh

Run update-tag-details.sh

Run update.sh

Run update.sh

Run update.sh

Run update-tag-details.sh

Add back "pull by digest" to the tag-details page...

Lost this when I ported to Perl, doh!

Run update-tag-details.sh

Run update.sh

Run update.sh

Run update-tag-details.sh

Run update.sh

Run update-tag-details.sh

Run update.sh

Run update.sh

Run update-tag-details.sh

Run update.sh

Run update-tag-details.sh

Sync the MySQL docs to MariaDB and Percona

Run update.sh

Run update.sh

Run update-tag-details.sh

Add note about DTR to registry description

Run update.sh

Run update-tag-details.sh

Run update.sh

Run update-tag-details.sh

Run update.sh

Run update-tag-details.sh

Run update-tag-details.sh

Run update-tag-details.sh

Run update.sh

Fix typo in README.md

Update README.md

Update content.md

Run update.sh

Run update.sh

Run update-tag-details.sh

Run update.sh

Run update-tag-details.sh

Run update-tag-details.sh

Run update-tag-details.sh

Use "jetty" in examples instead of "jetty:9"

Update wording of simple run examples

Demonstrate a port mapping for port 8443 to expose HTTPS.

Add a section heading for ENVIRONMENT

Document HTTP/2 support

Correct port mappings for Jetty docker run command

Run update.sh

Reflect that Couchbase Docker container is based on Ubuntu now

Run update.sh

Run update-tag-details.sh

celery workers also need the database connection

fixes md format

updates documentation by doing it more generic.

updates documentation by doing it more generic.

fixes tag names.

fixes tag names.

Updates documentation removing autogenerated sections.

Fixes last line to not empty line

Run update.sh

Run update-tag-details.sh

Run update.sh

Move the theoretical best-effort support line from Docker 1.0 up to Docker 1.6

Run update.sh

Run update-tag-details.sh

Run update.sh

Run update-tag-details.sh

Run update-tag-details.sh

Run update.sh

Run update-tag-details.sh

Run update.sh

Rails, no need to bundle install in the throw-away container

Run update.sh

Run update-tag-details.sh

Run update.sh

Run update-tag-details.sh

copied onbuild variant to python

Explain the Python onbuild variant

Run update.sh

Run update-tag-details.sh

Run update.sh

Run update.sh

Run update-tag-details.sh

Run update.sh

Run update-tag-details.sh

Run update.sh

Run update-tag-details.sh

Run update.sh

Run update.sh

Run update-tag-details.sh

Run update.sh

Run update-tag-details.sh

Revert websphere-liberty docs for IBM JRE

Run update.sh

Run update-tag-details.sh

Run update.sh

Run update-tag-details.sh

Run update.sh

Run update-tag-details.sh

Add Bonita BPM Official Docker image

update markdown format

fix markdown format

fix typo

explaining how to use the MySQL official container directly

fix typo

explaining how to use the PostgreSQL official container directly

update documentation links to 7.0.0 version

Describe environnement variables

add "How to extend this image"

add "Where to Store Data" and "Migrate from an earlier version of Bonita BPM"

fix ident

fix mistake

rephrase sentences and update the example of migration with 7.0.3

simplify pathes

Run update.sh

Run update.sh

add bonita in otherRepos

fix Bonita BPM logo link

Run update.sh

Run update.sh

Run update-tag-details.sh

Run update.sh

Run update-tag-details.sh

Run update.sh

add solr

Update solr to 5.3.1

use different example data to avoid warnings

remove Single-container SolrCloud example

update solr to latest Dockerfile

update solr to latest Dockerfile

Readme formatting

Use named container instead of capturing the container id
Use fenced code blocks with language

address markdownfmt.sh changes

update solr to latest Dockerfile

fix the official build link

Run update.sh

Run update-tag-details.sh

Run update-tag-details.sh

Adds a note about docker-entrypoint-initdb.d

refers to 14f1655

Signed-off-by: Frank Sachsenheim <funkyfuture@riseup.net>

Run update.sh

Resync mysql, mariadb, and percona descriptions

Run update.sh

Run update-tag-details.sh

add initial version for sourcemage official image docs

conform markdownfmt

conform markdownfmt 2.0

use official images' path

added upstream git repository to update.sh

dropped '--privileged' by default, replaced it with '--device /dev/fuse --cap-add SYS_ADMIN' in the notes; added security warning

Run update.sh

Run update-tag-details.sh

Run update-tag-details.sh

Add docs for new official Neo4j image

Run update.sh

Run update-tag-details.sh

Run update-tag-details.sh

Run update-tag-details.sh

Run update-tag-details.sh

Run update.sh

Run update-tag-details.sh

Run update.sh

Run update.sh

Reflow stub readme text and add Travis badge

Run update-tag-details.sh

Run update-tag-details.sh

Run update.sh

Run update-tag-details.sh

Run update.sh

Run update-tag-details.sh

Run update.sh

Run update-tag-details.sh

Run update-tag-details.sh

Run update-tag-details.sh

Run update-tag-details.sh

Run update-tag-details.sh

Run update-tag-details.sh

Run update-tag-details.sh

Run update-tag-details.sh

Run update-tag-details.sh

Run update-tag-details.sh

Run update-tag-details.sh

Run update-tag-details.sh

Run update-tag-details.sh

Run update-tag-details.sh

Run update-tag-details.sh

Run update-tag-details.sh

Run update-tag-details.sh

Run update.sh

Run update-tag-details.sh

Run update.sh

Run update-tag-details.sh

Run update.sh

Run update-tag-details.sh

Run update.sh

Run update-tag-details.sh

Use node:4 image for Node.js examples

Update io.js and Node.js repo links

Run update.sh

Run update-tag-details.sh

Run update.sh

Run update-tag-details.sh

Run update-tag-details.sh

reorder the databases section and warn about known issues with MySQL

Run update.sh

Run update.sh

Run update.sh

Run update-tag-details.sh

Run update.sh

Run update-tag-details.sh

Run update.sh

Run update.sh

Run update-tag-details.sh

Run update.sh

Run update.sh

Run update-tag-details.sh

Run update.sh

Link postgres as needed.

Celery workers need to be linked to postgres.

sentry: remove reference to vanilla celery image

This doesn't make sense and will never work.

See discussion on docker-library#376

Run update.sh

Run update-tag-details.sh

Run update.sh

Run update-tag-details.sh

Run update-tag-details.sh

Run update.sh

Run update-tag-details.sh

Run update.sh

Run update-tag-details.sh

Run update.sh

Run update-tag-details.sh

Run update-tag-details.sh

Run update.sh

Run update.sh

Run update.sh

Run update.sh

Run update.sh

docs for trying to be official docker images for Erlang OTP

Run update.sh

Run update-tag-details.sh

Run update-tag-details.sh

Run update-tag-details.sh

Run update.sh

Run update.sh

Run update.sh

Run update-tag-details.sh

Run update.sh

Run update-tag-details.sh

Run update.sh

Run update-tag-details.sh

Run update-tag-details.sh

Run update-tag-details.sh

Run update-tag-details.sh

Run update-tag-details.sh

Run update-tag-details.sh

Add text to explain "alpine" variants!

Run update.sh

Run update.sh

Updates to Neo4j documentation

Add new cassandra environment variables, point docs to 3.0

Run update.sh

Run update-tag-details.sh

Run update.sh

Run update-tag-details.sh

Run update-tag-details.sh

Run update-tag-details.sh

Run update-tag-details.sh

Run update-tag-details.sh

Run update-tag-details.sh

Run update-tag-details.sh

Run update-tag-details.sh

Run update-tag-details.sh

Run update-tag-details.sh

Run update-tag-details.sh

Run update-tag-details.sh

Run update-tag-details.sh

Run update-tag-details.sh

Run update-tag-details.sh

Run update-tag-details.sh

Run update-tag-details.sh

Run update-tag-details.sh

Run update-tag-details.sh

Run update-tag-details.sh

Run update-tag-details.sh

Run update-tag-details.sh

Run update-tag-details.sh

Run update-tag-details.sh

Run update-tag-details.sh

Run update-tag-details.sh

Run update-tag-details.sh

Run update-tag-details.sh

Run update-tag-details.sh

Run update-tag-details.sh

Run update-tag-details.sh

Run update-tag-details.sh

Run update-tag-details.sh

Run update-tag-details.sh

Run update-tag-details.sh

Run update-tag-details.sh

Run update-tag-details.sh

Run update-tag-details.sh

Run update-tag-details.sh

Run update-tag-details.sh

Run update-tag-details.sh

Run update-tag-details.sh

Run update-tag-details.sh

Run update-tag-details.sh

Run update-tag-details.sh

Run update-tag-details.sh

Run update-tag-details.sh

Run update-tag-details.sh

Run update-tag-details.sh

Run update-tag-details.sh

Run update-tag-details.sh

Run update-tag-details.sh

Run update-tag-details.sh

Run update-tag-details.sh

Run update-tag-details.sh

Run update-tag-details.sh

Run update-tag-details.sh

Run update-tag-details.sh

Run update-tag-details.sh

Run update-tag-details.sh

Run update-tag-details.sh

Run update-tag-details.sh

Run update-tag-details.sh

Run update-tag-details.sh

Run update-tag-details.sh

Run update-tag-details.sh

Run update-tag-details.sh

Run update.sh

Tweak the README.md stub verbiage to make it more clear first that these repos aren't necessarily "official" in the "upstream partner official" sense, and second that changes being merged here do not necessarily translate directly into updated images

Run update.sh

fix a typo

Run update.sh

Run update-tag-details.sh

Run update-tag-details.sh

Run update-tag-details.sh

Run update-tag-details.sh

Run update-tag-details.sh

Run update-tag-details.sh

Run update-tag-details.sh

Run update-tag-details.sh

Run update-tag-details.sh

Run update-tag-details.sh

Run update.sh

Run update-tag-details.sh

Run update.sh

Run update-tag-details.sh

Run update-tag-details.sh

Run update-tag-details.sh

Run update-tag-details.sh

Run update-tag-details.sh

Run update-tag-details.sh

Run update-tag-details.sh

Run update-tag-details.sh

Run update-tag-details.sh

Run update-tag-details.sh

Run update-tag-details.sh

Run update-tag-details.sh

Run update-tag-details.sh

Run update.sh

Run update-tag-details.sh

Run update-tag-details.sh

Run update.sh

Run update-tag-details.sh

Run update.sh

Run update-tag-details.sh

Run update-tag-details.sh

Run update-tag-details.sh

Run update-tag-details.sh

Run update-tag-details.sh

Run update-tag-details.sh

Run update-tag-details.sh

Run update-tag-details.sh

Run update-tag-details.sh

Run update-tag-details.sh

Run update-tag-details.sh

Run update-tag-details.sh

Run update-tag-details.sh

Run update-tag-details.sh

Run update-tag-details.sh

Run update-tag-details.sh

Run update-tag-details.sh

Run update-tag-details.sh

Run update-tag-details.sh

Run update-tag-details.sh

Run update-tag-details.sh

Run update-tag-details.sh

Fix a typo in clojure README

langauge -> language

Run update.sh

Run update-tag-details.sh

Run update-tag-details.sh

Run update-tag-details.sh

Run update-tag-details.sh

Run update-tag-details.sh

Run update.sh

Run update-tag-details.sh

Run update-tag-details.sh

Run update-tag-details.sh

Run update.sh

Run update-tag-details.sh

Run update-tag-details.sh

Run update-tag-details.sh

Run update-tag-details.sh

Run update-tag-details.sh

Run update-tag-details.sh

Update .travis.yml to account for Travis changes (especially now that Docker is no longer experimental 🎉)

Revert "Update .travis.yml to account for Travis changes (especially now that Docker is no longer experimental 🎉)"

This reverts commit 25ad65a.

Run update.sh

[jenkins] Align with image readme

Run update.sh

Run update.sh

Run update.sh

Update README-short.txt

Fix headline, add blank else ##foo  will leave the ## in the rendered text. It doesn't become a headline with 2 * # however.

Crate: updated logo and wording in readme

Run update.sh

Run update.sh

Run update.sh

Run update.sh

Fix golang:onbuild "COPY" path

Run update.sh

Fix cassandra volume path

Run update.sh

Run update.sh

Run update.sh

Run update.sh

Run update.sh

Run update.sh

Run update.sh

Run update.sh

Run update.sh

add mongo-cn
@tianon
Copy link

tianon commented Nov 1, 2017

Just for posterity / future reference, updated numbers for today's official images are as follows:

$ wc -c */README.md | sort -n
   1386 scratch/README.md
   2628 cirros/README.md
   3242 julia/README.md
   3428 thrift/README.md
   3515 clearlinux/README.md
   3621 registry/README.md
   3679 swipl/README.md
   3753 rakudo-star/README.md
   3910 rocket.chat/README.md
   3943 opensuse/README.md
   3971 fedora/README.md
   4020 fsharp/README.md
   4037 mageia/README.md
   4052 photon/README.md
   4068 hylang/README.md
   4133 eclipse-mosquitto/README.md
   4139 rethinkdb/README.md
   4221 piwik/README.md
   4328 znc/README.md
   4561 sourcemage/README.md
   4576 rust/README.md
   4606 known/README.md
   4649 crate/README.md
   4741 crux/README.md
   4749 hola-mundo/README.md
   4798 gcc/README.md
   4822 hello-seattle/README.md
   4954 hello-world/README.md
   4974 alpine/README.md
   5071 swarm/README.md
   5192 traefik/README.md
   5380 swift/README.md
   5416 r-base/README.md
   5614 mono/README.md
   5720 kaazing-gateway/README.md
   5726 busybox/README.md
   5752 kibana/README.md
   5842 amazonlinux/README.md
   6015 sonarqube/README.md
   6066 mongo-express/README.md
   6075 perl/README.md
   6101 plone/README.md
   6189 memcached/README.md
   6207 composer/README.md
   6211 irssi/README.md
   6282 bash/README.md
   6406 orientdb/README.md
   6529 backdrop/README.md
   6641 chronograf/README.md
   6783 haskell/README.md
   6950 adminer/README.md
   7071 spiped/README.md
   7087 eggdrop/README.md
   7110 oraclelinux/README.md
   7189 owncloud/README.md
   7192 gradle/README.md
   7462 neurodebian/README.md
   7490 storm/README.md
   7493 ubuntu/README.md
   7534 joomla/README.md
   7540 httpd/README.md
   7545 rapidoid/README.md
   7608 elixir/README.md
   7686 vault/README.md
   7796 pypy/README.md
   7814 logstash/README.md
   7996 redis/README.md
   8002 mediawiki/README.md
   8152 aerospike/README.md
   8168 notary/README.md
   8244 couchdb/README.md
   8298 lightstreamer/README.md
   8352 ghost/README.md
   8427 maven/README.md
   8610 erlang/README.md
   8620 sentry/README.md
   8725 kong/README.md
   8730 haproxy/README.md
   8735 convertigo/README.md
   8807 tomcat/README.md
   8849 buildpack-deps/README.md
   8989 centos/README.md
   9098 kapacitor/README.md
   9179 odoo/README.md
   9240 nats/README.md
   9254 clojure/README.md
   9295 jruby/README.md
   9355 telegraf/README.md
   9372 php-zendserver/README.md
   9777 zookeeper/README.md
   9863 elasticsearch/README.md
  10296 arangodb/README.md
  10547 jetty/README.md
  10726 nginx/README.md
  10816 nuxeo/README.md
  10825 geonetwork/README.md
  11090 groovy/README.md
  11135 tomee/README.md
  11432 jenkins/README.md
  11672 debian/README.md
  12062 node/README.md
  12108 haxe/README.md
  12314 golang/README.md
  12523 ruby/README.md
  12771 websphere-liberty/README.md
  12907 ibmjava/README.md
  12997 rabbitmq/README.md
  13118 drupal/README.md
  13119 wordpress/README.md
  13244 mongo/README.md
  13263 openjdk/README.md
  13312 influxdb/README.md
  13340 docker/README.md
  13414 gazebo/README.md
  13627 redmine/README.md
  14327 cassandra/README.md
  14827 flink/README.md
  15248 nats-streaming/README.md
  15842 solr/README.md
  15851 percona/README.md
  15865 mysql/README.md
  15876 xwiki/README.md
  16290 mariadb/README.md
  16832 couchbase/README.md
  17151 postgres/README.md
  17157 neo4j/README.md
  17526 silverpeas/README.md
  17947 python/README.md
  18463 php/README.md
  18872 nextcloud/README.md
  19504 bonita/README.md
  20353 ros/README.md
  21594 consul/README.md

(significantly more repos up near that 20k mark now)

@tianon
Copy link

tianon commented Jun 20, 2018

Here's an updated list (with PHP now over that 25k mark):

$ wc -c */README.md | sort -n | tail -n20
  15934 wordpress/README.md
  16445 percona/README.md
  16885 mariadb/README.md
  16927 mongo/README.md
  17005 mysql/README.md
  17674 couchbase/README.md
  18160 silverpeas/README.md
  18802 openjdk/README.md
  19765 nats-streaming/README.md
  19823 influxdb/README.md
  20239 ros/README.md
  20443 python/README.md
  21553 postgres/README.md
  21599 xwiki/README.md
  21842 nextcloud/README.md
  22025 bonita/README.md
  22385 consul/README.md
  24075 neo4j/README.md
  25868 php/README.md

@vijayant123
Copy link

PHP still shows an warning message at the top of its description field. I agree with @yosifkit that the limit should be over and above 100k characters.

@MichaelSimons
Copy link

We have started hitting this limit with the microsoft/dotnet repo. We are getting ready to release a preview version of the next release which puts us over the 25k limit. With the broad number of platforms/distros/multi-arch tags etc, the 25k limit seems pretty small.

@Djelibeybi
Copy link

We seem to have hit the limit on the official-library/openjdk image now as well.

@tianon
Copy link

tianon commented Apr 24, 2019

Yep, we've got ~13 official images over the limit now:

$ wc -c */README.md | sort -n | tail -n20
  17064 couchbase/README.md
  17240 percona/README.md
  17392 solr/README.md
  17523 rabbitmq/README.md
  18221 silverpeas/README.md
  18256 neo4j/README.md
  20792 nats-streaming/README.md
  20807 open-liberty/README.md
  21165 ros/README.md
  21793 influxdb/README.md
  21998 bonita/README.md
  22671 nextcloud/README.md
  22989 consul/README.md
  24085 python/README.md
  24602 mongo/README.md
  24610 openjdk/README.md
  24948 websphere-liberty/README.md
  25030 php/README.md
  25170 postgres/README.md

@thaJeztah
Copy link
Member

@cowsrule ^^

@thaJeztah
Copy link
Member

/cc @uday-shetty 😉

@aguibert
Copy link

aguibert commented Jun 6, 2019

@tianon can we revisit this please? I think the official images could display tags in a more concise way. The many combinations of tags is the main reason why the OpenLiberty description got so long, but the scheme is just:

[VERSION-]PROFILE[-JAVA_DIST]

    VERSION       the version of OpenLiberty (e.g. 19.0.0.4)
    PROFILE       the profile of OpenLiberty. Possible values: 
        - kernel
        - webProfile7
        - webProfile8
        - etc...
    JAVA_DIST    the distribution of Java used with OpenLiberty. Possible values: 
        - java8-openj9
        - java8-ibmsfj
        - java11-openj9
        - etc....

Perhaps we could allow a little bit of customization for how/which image labels are shown in the image description?

@tianon
Copy link

tianon commented Jun 6, 2019

The other issue is a more appropriate place to discuss the specific formatting we use; this issue is about the Hub's character limit which is only tangentially related.

@gdams
Copy link

gdams commented Jun 26, 2019

hmm https://hub.docker.com/_/adoptopenjdk seems way over the limit. Not sure what the best approach is here? I could make the tags expand like this but I don't have any control over the tags as they are autogenerated and I'm not sure that this would actually resolve the length issue because the file length would still be the same.

@thaJeztah
Copy link
Member

@cowsrule ^^

@manan-jadhav
Copy link

@tianon I can't remember why, but I'm pretty sure everyone was involved, because this has a major case of de ja vu if not. :)

IIRC we didn't want it too big since everything is coming across in the API responses and it would make them much bigger, and realistically how many repos need more then 5000 characters?

I personally think 100k is way too big. having to pass that around in the API would really suck. maybe 25k?

As for the comment that descriptions are included in API responses and having higher limits would cause bigger API responses, one solution I can think of, is to truncate the description fields by default and expose new endpoints for full descriptions.

@LukeCarrier
Copy link

Is it worth opening a new ticket for this issue? I'm not sure how likely Docker folks are to see comments in a closed ticket.

@mk-pmb
Copy link

mk-pmb commented Mar 15, 2022

I usually skim manuals for the relevant parts, so at first I missed the cut-off note on top. Can we please repeat that note directly below the actual cut-off? And can we give that note a box layout, at least a border?

Edit: I get the impression that the current implementation might be one where the hint eats into the character count available for the actual readme, and that a box markup would increase this cost. If so, I suggest we just add […] (see hint at start of readme) to the end.

We should ensure that if the cut-off happens inside an HTML comment, that comment is removed entirely. Due to the character limit, it would even seem useful to ensure we strip ALL comments upfront.

matthiasr added a commit to prometheus/statsd_exporter that referenced this issue Mar 22, 2024
I have no idea if it is even up to date. The README file was too large to fit
Docker Hub's limitations; this removal brings us just under the [25KB
limit](docker/hub-feedback#238).

Signed-off-by: Matthias Rampke <matthias@prometheus.io>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests