Skip to content
This repository was archived by the owner on Jul 20, 2018. It is now read-only.

Adding proposed tag descriptions from #28 #31

Closed
wants to merge 1 commit into from
Closed

Adding proposed tag descriptions from #28 #31

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 16 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,3 +41,19 @@ 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 Varients
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

"Variants" (spelling)


The `iojs` images come in three flavors, each designed for a specific use case.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

"The iojs Docker image comes in three flavors [...]"


`<version>`:

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.

`<version>-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.
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think it would be good to use something closer to the in #31 (comment) for this tag, as this one doesn't seem to make it entirely obvious that it'll run an app automatically. Pasting the description I meant below:
"These images include all the packages from the -tagged docker build, but will also install dependencies specified in a package.json file with npm and run npm start in the directory /usr/src/app, which it creates inside the container and copies a local directory you specify to."


`<version>-slim:`

The default tag is based off of `buildpack-deps`.`buildpack-deps` is designed for the average user of docker who has many images on thier 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 total size of all of your docker images on your system. 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.
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This description seems a bit too complex to explain that slim has less packages than the default tag. I would suggest adding most of it to the description of the default tag such as:
"This tag is based off of buildpack-deps.buildpack-deps is designed for the average user of docker who has many images on thier 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 total size of all of your docker images on your system."

and keeping the description for slim something like:
"This image does not contain the common packages contained in the default tag. If you are working in an environment where only the iojs image will be deployed and you have space constraints, you can use this image, otherwise we highly recommend using the default image of this repository."