docker-library
/
docs
mirror of https://github.com/docker-library/docs.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Update documentation to mention canonical Markdown formatting

This commit is contained in:
Tianon Gravi 2015-02-12 16:16:23 -07:00
parent 23e6d4ae7b
commit a4552932f2
1 changed files with 10 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
README.md
View File

@ -2,14 +2,19 @@
This repository contains the docs for each of the Docker official images. See [docker-library/official-images](https://github.com/docker-library/official-images) for the configuration how the images are built. To see all of the official images go to the [hub](https://registry.hub.docker.com/repos/stackbrew/?&s=alphabetical). This repository contains the docs for each of the Docker official images. See [docker-library/official-images](https://github.com/docker-library/official-images) for the configuration how the images are built. To see all of the official images go to the [hub](https://registry.hub.docker.com/repos/stackbrew/?&s=alphabetical).
All Markdown files here are run through [tianon's fork of `markdownfmt`](https://github.com/tianon/markdownfmt) (only forked to add some smaller-diff preference and minor DockerHub-compatibility changes), and verified as formatted correctly via Travis-CI.
# How do I add a new image's docs # How do I add a new image's docs
- create a folder for my image: `mkdir myimage` - create a folder for my image: `mkdir myimage`
- create a `README-short.txt` (required, 100 char max) - create a `README-short.txt` (required, 100 char max)
- create a `content.md` (required, 80 col wrap) - create a `content.md` (required)
- create a `license.md` (required, 80 col wrap) - create a `license.md` (required)
- add a `logo.png` (recommended) - add a `logo.png` (recommended)
- edit `update.sh` as needed (see below) - edit `update.sh` as needed (see below)
Optionally: (we run this periodically, especially before pushing updated descriptions)
- run `./update.sh myimage` to generate `myimage/README.md` - run `./update.sh myimage` to generate `myimage/README.md`
# What are all these files? # What are all these files?
@ -44,7 +49,7 @@ This file is generated using `update.sh`.
## `<image name>/content.md` ## `<image name>/content.md`
This file contains the main content of your readme. The basic parts you should have are a "What Is" section and a "How To" section. See the doc on [Official Repos](https://docs.docker.com/docker-hub/official_repos/#a-long-description) for more information on long description. The issues and contribution section is generated by the script but can be overridden. The following is a basic layout: This file contains the main content of your image's long description. The basic parts you should have are a "What Is" section and a "How To" section. See the doc on [Official Repos](https://docs.docker.com/docker-hub/official_repos/#a-long-description) for more information on long description. The issues and contribution section is generated by the script but can be overridden. The following is a basic layout:
# What is XYZ? # What is XYZ?
@ -69,10 +74,9 @@ Logo for the contained software. Specifications can be found in the docs on [Off
## `<image name>/license.md` ## `<image name>/license.md`
This file should contain a link to the license for the main software in the image, wrapped to 80 columns. Here is an example for `golang`: This file should contain a link to the license for the main software in the image. Here is an example for `golang`:
View [license information](http://golang.org/LICENSE) View [license information](http://golang.org/LICENSE) for the software contained in this image.
for the software contained in this image.
## `<image name>/user-feedback.md` ## `<image name>/user-feedback.md`