docs

# What is this?

This repository contains the image documentation for each of the Docker Official Images. See [docker-library/official-images](https://github.com/docker-library/official-images) for more information about the program in general.

All Markdown files here are run through [tianon's fork of `markdownfmt`](https://github.com/tianon/markdownfmt), and verified as formatted correctly via GitHub Actions.

## Table of Contents

<!-- AUTOGENERATED TOC -->

1.	[What is this?](#what-is-this)
	1.	[Table of Contents](#table-of-contents)
2.	[How do I update an image's docs](#how-do-i-update-an-images-docs)
3.	[How do I add a new image's docs](#how-do-i-add-a-new-images-docs)
4.	[Files related to an image's docs](#files-related-to-an-images-docs)
	1.	[folder `<image name>`](#folder-image-name)
	2.	[`README.md`](#readmemd)
	3.	[`content.md`](#contentmd)
	4.	[`get-help.md`](#get-helpmd)
	5.	[`github-repo`](#github-repo)
	6.	[`license.md`](#licensemd)
	7.	[`logo.png`](#logopng)
	8.	[`maintainer.md`](#maintainermd)
	9.	[`metadata.json`](#metadatajson)
	10.	[`README-short.txt`](#readme-shorttxt)
	11.	[`compose.yaml`](#composeyaml)
5.	[Files for main Docs repo](#files-for-main-docs-repo)
	1.	[`update.sh`](#updatesh)
	2.	[`markdownfmt.sh` and `ymlfmt.sh`](#markdownfmtsh-and-ymlfmtsh)
	3.	[`.template-helpers/generate-dockerfile-links-partial.sh`](#template-helpersgenerate-dockerfile-links-partialsh)
	4.	[`.template-helpers/`](#template-helpers)
6.	[Scripts unrelated to templates](#scripts-unrelated-to-templates)
	1.	[`generate-repo-stub-readme.sh`](#generate-repo-stub-readmesh)
	2.	[`push.pl` and `push.sh`](#pushpl-and-pushsh)
7.	[Issues and Contributing](#issues-and-contributing)

<!-- AUTOGENERATED TOC -->

# How do I update an image's docs

Edit the `content.md` for an image; not the `README.md` as it's auto-generated from the contents of the other files in that repo. To see the changes to the `README.md`, run `./update.sh myimage` from the repo root, but do not add the `README.md` changes to your pull request. See also `markdownfmt.sh` point [below](#how-do-i-add-a-new-images-docs).

After opening your Pull Request the changes will be checked by an automated `markdownfmt.sh` before it can be merged. A common issue is incorrect spacing such as with two lines missing an empty line between them (double-spaced).

# How do I add a new image's docs

-	Create a folder for my image: `mkdir myimage`
-	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)
-	Create a `metadata.json` (required)
-	Add a `logo.png` (recommended)

Optionally:

-	Run `./markdownfmt.sh -l myimage` to list any files that are non-compliant to [`tianon/markdownfmt`](https://hub.docker.com/r/tianon/markdownfmt).  
	Any files in the list will result in a failed build during continuous integration.
	-	run `./markdownfmt.sh -d myimage` to see a diff o