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

Merge pull request #1148 from J0WI/maintainer.md-hint 

Add a hint about required maintainer.md
This commit is contained in:
yosifkit 2018-02-08 09:42:58 -08:00 committed by GitHub
parent 607b63f6b5 0a2fcd72f9
commit 9d7bd658b3
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 5 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
README.md
View File

@ -15,6 +15,7 @@ All Markdown files here are run through [tianon's fork of `markdownfmt`](https:/
- create a `README-short.txt` (required, 100 char max)
- create a `content.md` (required)
- create a `license.md` (required)
- create a `maintainer.md` (required)
- create a `github-repo` (required)
- add a `logo.png` (recommended)
@ -95,6 +96,10 @@ This file should contain a link to the license for the main software in the imag
View [license information](http://golang.org/LICENSE) for the software contained in this image.
```
## `<image name>/maintainer.md`
This file should contain a link to the maintainers of the Dockerfile.
## `<image name>/github-repo`
This file should contain the URL to the GitHub repository for the Dockerfiles that become the images. The file should be in a single line ending in a newline with no extraneous whitespace. Only one GitHub repo per image repository is supported. It is used in generating links. Here is an example for `golang`: