From adfd93e313332f3ec0df7980450ecb0f9469808e Mon Sep 17 00:00:00 2001 From: Joe Ferguson Date: Tue, 24 Feb 2015 15:23:17 -0800 Subject: [PATCH] Run update on all the things to generate onbuild docs --- django/README.md | 12 ++++++++++++ golang/README.md | 12 ++++++++++++ iojs/README.md | 16 ++++++++++++++++ maven/README.md | 12 ++++++++++++ mono/README.md | 12 ++++++++++++ node/README.md | 16 ++++++++++++++++ pypy/README.md | 16 ++++++++++++++++ rails/README.md | 12 ++++++++++++ ruby/README.md | 16 ++++++++++++++++ 9 files changed, 124 insertions(+) diff --git a/django/README.md b/django/README.md index ab5107671..ca70dfc5a 100644 --- a/django/README.md +++ b/django/README.md @@ -48,6 +48,18 @@ If you want to generate the scaffolding for a new Django project, you can do the This will create a sub-directory named `mysite` inside your current directory. +# Image Variants + +The `django` images come in many flavors, each designed for a specific use case. + +## `django:` + +This is the defacto image. If you are unsure about what your needs are, you probably want to use this one. It is designed to be used both as a throw away container (mount your source code and start the container to start your app), as well as the base to build other images off of. This tag is based off of [`buildpack-deps`](https://registry.hub.docker.com/_/buildpack-deps/). `buildpack-deps` is designed for the average user of docker who has many images on their system. It, by design, has a large number of extremely common Debian packages. This reduces the number of packages that images that derive from it need to install, thus reducing the overall size of all images on your system. + +## `django:onbuild` + +This image makes building derivitative images easier. For most use cases, creating a `Dockerfile` in the base of your project directory with the line `FROM django:onbuild` will be enough to create a stand-alone image for your project. + # License View [license information](https://github.com/django/django/blob/master/LICENSE) for the software contained in this image. diff --git a/golang/README.md b/golang/README.md index d77fc8946..809ed2921 100644 --- a/golang/README.md +++ b/golang/README.md @@ -62,6 +62,18 @@ Alternatively, you can build for multiple platforms at once: > done > done +# Image Variants + +The `golang` images come in many flavors, each designed for a specific use case. + +## `golang:` + +This is the defacto image. If you are unsure about what your needs are, you probably want to use this one. It is designed to be used both as a throw away container (mount your source code and start the container to start your app), as well as the base to build other images off of. This tag is based off of [`buildpack-deps`](https://registry.hub.docker.com/_/buildpack-deps/). `buildpack-deps` is designed for the average user of docker who has many images on their system. It, by design, has a large number of extremely common Debian packages. This reduces the number of packages that images that derive from it need to install, thus reducing the overall size of all images on your system. + +## `golang:onbuild` + +This image makes building derivitative images easier. For most use cases, creating a `Dockerfile` in the base of your project directory with the line `FROM golang:onbuild` will be enough to create a stand-alone image for your project. + # License View [license information](http://golang.org/LICENSE) for the software contained in this image. diff --git a/iojs/README.md b/iojs/README.md index 8fff0163f..d9d5d2756 100644 --- a/iojs/README.md +++ b/iojs/README.md @@ -37,6 +37,22 @@ To run a single script, you can mount it in a volume under `/usr/src/app`. From $ docker run -v ${PWD}:/usr/src/app -w /usr/src/app --it --rm iojs iojs index.js +# Image Variants + +The `iojs` images come in many flavors, each designed for a specific use case. + +## `iojs:` + +This is the defacto image. If you are unsure about what your needs are, you probably want to use this one. It is designed to be used both as a throw away container (mount your source code and start the container to start your app), as well as the base to build other images off of. This tag is based off of [`buildpack-deps`](https://registry.hub.docker.com/_/buildpack-deps/). `buildpack-deps` is designed for the average user of docker who has many images on their system. It, by design, has a large number of extremely common Debian packages. This reduces the number of packages that images that derive from it need to install, thus reducing the overall size of all images on your system. + +## `iojs:onbuild` + +This image makes building derivitative images easier. For most use cases, creating a `Dockerfile` in the base of your project directory with the line `FROM iojs:onbuild` will be enough to create a stand-alone image for your project. + +## `iojs:slim` + +This image does not contain the common packages contained in the default tag and only contains the minimal packages needed to run `iojs`. Unless you are working in an environment where *only* the iojs image will be deployed and you have space constraints, we highly recommend using the default image of this repository. + # License View [license information](https://github.com/iojs/io.js/blob/master/LICENSE) for the software contained in this image. diff --git a/maven/README.md b/maven/README.md index 2bf4a3a96..fd3442516 100644 --- a/maven/README.md +++ b/maven/README.md @@ -37,6 +37,18 @@ For many simple projects, you may find it inconvenient to write a complete `Dock docker run -it --rm --name my-maven-project -v "$PWD":/usr/src/mymaven -w /usr/src/mymaven maven:3.2-jdk-7 mvn clean install +# Image Variants + +The `maven` images come in many flavors, each designed for a specific use case. + +## `maven:` + +This is the defacto image. If you are unsure about what your needs are, you probably want to use this one. It is designed to be used both as a throw away container (mount your source code and start the container to start your app), as well as the base to build other images off of. This tag is based off of [`buildpack-deps`](https://registry.hub.docker.com/_/buildpack-deps/). `buildpack-deps` is designed for the average user of docker who has many images on their system. It, by design, has a large number of extremely common Debian packages. This reduces the number of packages that images that derive from it need to install, thus reducing the overall size of all images on your system. + +## `maven:onbuild` + +This image makes building derivitative images easier. For most use cases, creating a `Dockerfile` in the base of your project directory with the line `FROM maven:onbuild` will be enough to create a stand-alone image for your project. + # License View [license information](https://www.apache.org/licenses/) for the software contained in this image. diff --git a/mono/README.md b/mono/README.md index 7f5349ad0..54e17e560 100644 --- a/mono/README.md +++ b/mono/README.md @@ -46,6 +46,18 @@ This Docker image is provided by Xamarin, for users of the Mono Project. Thanks to [Michael Friis](http://friism.com/) for his preliminary work. +# Image Variants + +The `mono` images come in many flavors, each designed for a specific use case. + +## `mono:` + +This is the defacto image. If you are unsure about what your needs are, you probably want to use this one. It is designed to be used both as a throw away container (mount your source code and start the container to start your app), as well as the base to build other images off of. This tag is based off of [`buildpack-deps`](https://registry.hub.docker.com/_/buildpack-deps/). `buildpack-deps` is designed for the average user of docker who has many images on their system. It, by design, has a large number of extremely common Debian packages. This reduces the number of packages that images that derive from it need to install, thus reducing the overall size of all images on your system. + +## `mono:onbuild` + +This image makes building derivitative images easier. For most use cases, creating a `Dockerfile` in the base of your project directory with the line `FROM mono:onbuild` will be enough to create a stand-alone image for your project. + # License This Docker Image is licensed with the Expat License. See the [Mono Project licensing FAQ](http://www.mono-project.com/docs/faq/licensing/) for details on how Mono and associated libraries are licensed. diff --git a/node/README.md b/node/README.md index 204ddc187..aa5bcd3c0 100644 --- a/node/README.md +++ b/node/README.md @@ -50,6 +50,22 @@ For many simple, single file projects, you may find it inconvenient to write a c docker run -it --rm --name my-running-script -v "$PWD":/usr/src/myapp -w /usr/src/myapp node:0.10 node your-daemon-or-script.js +# Image Variants + +The `node` images come in many flavors, each designed for a specific use case. + +## `node:` + +This is the defacto image. If you are unsure about what your needs are, you probably want to use this one. It is designed to be used both as a throw away container (mount your source code and start the container to start your app), as well as the base to build other images off of. This tag is based off of [`buildpack-deps`](https://registry.hub.docker.com/_/buildpack-deps/). `buildpack-deps` is designed for the average user of docker who has many images on their system. It, by design, has a large number of extremely common Debian packages. This reduces the number of packages that images that derive from it need to install, thus reducing the overall size of all images on your system. + +## `node:onbuild` + +This image makes building derivitative images easier. For most use cases, creating a `Dockerfile` in the base of your project directory with the line `FROM node:onbuild` will be enough to create a stand-alone image for your project. + +## `node:slim` + +This image does not contain the common packages contained in the default tag and only contains the minimal packages needed to run `node`. Unless you are working in an environment where *only* the node image will be deployed and you have space constraints, we highly recommend using the default image of this repository. + # License View [license information](https://github.com/joyent/node/blob/master/LICENSE) for the software contained in this image. diff --git a/pypy/README.md b/pypy/README.md index c960bf648..639e21b97 100644 --- a/pypy/README.md +++ b/pypy/README.md @@ -48,6 +48,22 @@ or (again, if you need to use Python 2): docker run -it --rm --name my-running-script -v "$PWD":/usr/src/myapp -w /usr/src/myapp pypy:2 pypy your-daemon-or-script.py +# Image Variants + +The `pypy` images come in many flavors, each designed for a specific use case. + +## `pypy:` + +This is the defacto image. If you are unsure about what your needs are, you probably want to use this one. It is designed to be used both as a throw away container (mount your source code and start the container to start your app), as well as the base to build other images off of. This tag is based off of [`buildpack-deps`](https://registry.hub.docker.com/_/buildpack-deps/). `buildpack-deps` is designed for the average user of docker who has many images on their system. It, by design, has a large number of extremely common Debian packages. This reduces the number of packages that images that derive from it need to install, thus reducing the overall size of all images on your system. + +## `pypy:onbuild` + +This image makes building derivitative images easier. For most use cases, creating a `Dockerfile` in the base of your project directory with the line `FROM pypy:onbuild` will be enough to create a stand-alone image for your project. + +## `pypy:slim` + +This image does not contain the common packages contained in the default tag and only contains the minimal packages needed to run `pypy`. Unless you are working in an environment where *only* the pypy image will be deployed and you have space constraints, we highly recommend using the default image of this repository. + # License View [license information](https://bitbucket.org/pypy/pypy/src/c3ff0dd6252b6ba0d230f3624dbb4aab8973a1d0/LICENSE?at=default) for software contained in this image. diff --git a/rails/README.md b/rails/README.md index 0c53e12bd..3055e9260 100644 --- a/rails/README.md +++ b/rails/README.md @@ -49,6 +49,18 @@ If you want to generate the scaffolding for a new Rails project, you can do the This will create a sub-directory named `webapp` inside your current directory. +# Image Variants + +The `rails` images come in many flavors, each designed for a specific use case. + +## `rails:` + +This is the defacto image. If you are unsure about what your needs are, you probably want to use this one. It is designed to be used both as a throw away container (mount your source code and start the container to start your app), as well as the base to build other images off of. This tag is based off of [`buildpack-deps`](https://registry.hub.docker.com/_/buildpack-deps/). `buildpack-deps` is designed for the average user of docker who has many images on their system. It, by design, has a large number of extremely common Debian packages. This reduces the number of packages that images that derive from it need to install, thus reducing the overall size of all images on your system. + +## `rails:onbuild` + +This image makes building derivitative images easier. For most use cases, creating a `Dockerfile` in the base of your project directory with the line `FROM rails:onbuild` will be enough to create a stand-alone image for your project. + # License View [license information](https://github.com/rails/rails#license) for the software contained in this image. diff --git a/ruby/README.md b/ruby/README.md index b138bc928..19eb1619b 100644 --- a/ruby/README.md +++ b/ruby/README.md @@ -56,6 +56,22 @@ For many simple, single file projects, you may find it inconvenient to write a c docker run -it --rm --name my-running-script -v "$PWD":/usr/src/myapp -w /usr/src/myapp ruby:2.1 ruby your-daemon-or-script.rb +# Image Variants + +The `ruby` images come in many flavors, each designed for a specific use case. + +## `ruby:` + +This is the defacto image. If you are unsure about what your needs are, you probably want to use this one. It is designed to be used both as a throw away container (mount your source code and start the container to start your app), as well as the base to build other images off of. This tag is based off of [`buildpack-deps`](https://registry.hub.docker.com/_/buildpack-deps/). `buildpack-deps` is designed for the average user of docker who has many images on their system. It, by design, has a large number of extremely common Debian packages. This reduces the number of packages that images that derive from it need to install, thus reducing the overall size of all images on your system. + +## `ruby:onbuild` + +This image makes building derivitative images easier. For most use cases, creating a `Dockerfile` in the base of your project directory with the line `FROM ruby:onbuild` will be enough to create a stand-alone image for your project. + +## `ruby:slim` + +This image does not contain the common packages contained in the default tag and only contains the minimal packages needed to run `ruby`. Unless you are working in an environment where *only* the ruby image will be deployed and you have space constraints, we highly recommend using the default image of this repository. + # License View [license information](https://www.ruby-lang.org/en/about/license.txt) for the software contained in this image.