# 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 of changes required to pass.
-	Run `./update.sh myimage` to generate `myimage/README.md` for manual review of the generated copy.  
	**Note:** do not actually commit the `README.md` file; it is automatically generated/committed before being uploaded to Docker Hub.

# Files related to an image's docs

## folder `<image name>`

This is where all the partial (e.g. `content.md`) and generated files (e.g. `README.md`) for a given image reside, (e.g. `golang/`). It must match the name of the image used in `docker-library/official-images`.

## `README.md`

This file is generated using `update.sh`. Do not commit or edit this file; it is regenerated periodically by a bot.

## `content.md`

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. The following is a basic layout:

```markdown
# What is XYZ?

// about what the contained software is

%%LOGO%%

# How to use this image

// descriptions and examples of common use cases for the image
// make use of subsections as necessary
```

## `get-help.md`

This file is an optional override of the default `get-help.md`. This is the content of the "Where to get help" part of the "Quick reference" at the top of the generated README. We recommend linking to the best places for community support like forums, chat rooms, or mailing lists.

## `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`:

```text
https://github.com/docker-library/golang
```

## `license.md`

This file should contain a link to the license for the main software in the image. Here is an example for `golang`:

```markdown
View [license information](http://golang.org/LICENSE) for the software contained in this image.
```

## `logo.png`

Logo for the contained software. While there are not hard rules on formatting, most existing logos are square or landscape and stay within a few hundred pixels of width. Alternatively, a `logo.svg` can be used instead, but only one logo file will apply. To use it within `content.md`, put `%%LOGO%%` as shown above in the basic `content.md` layout.

The image is automatically scaled to a 120 pixel square for the top of the Docker Hub page and Hub search results.

## `maintainer.md`

This file should contain a link to the maintainers of the Dockerfile.

## `metadata.json`

This file contains data about the repo for Docker Hub. The minimum file is defined below. `./metadata.sh [repo-name]` must be used to correctly format it (use `-w` to apply its suggested format changes). Only three sorted unique Docker Hub categories are allowed. `metadata.json` in the root contains the list of categories to choose from. See descriptions for the categories on the [Docker docs site](https://docs.docker.com/docker-hub/repos/categories/).

```json
{
    "hub": {
         "categories": []
    }
}
```

## `README-short.txt`

This is the short description for the Docker Hub, limited to 100 characters in a single line.

> Go (golang) is a general purpose, higher-level, imperative programming language.

## `compose.yaml`

This optional file contains a small, working [Compose file](https://docs.docker.com/reference/compose-file/) showing off how to use the image. To use the `compose.yaml`, add `%%COMPOSE%%` to the `content.md` and this will embed the YAML.

Other official images may be referenced within the YAML to demonstrate the functionality of the image, but no images external to the Docker Official Images program may be referenced.

# Files for main Docs repo

## `update.sh`

This is the main script used to generate the `README.md` files for each image. The generated file is committed along with the files used to generate it. Accepted arguments are which image(s) you want to update or no arguments to update all of them.

This script assumes [`bashbrew`](https://github.com/docker-library/bashbrew/releases) is in your `PATH` (for scraping relevant tag information from the library manifest file for each repository).

## `markdownfmt.sh` and `ymlfmt.sh`

These two scripts are for verifying the formatting of Markdown (`.md`) and YAML (`.yml`) files, respectively. `markdownfmt.sh` uses the [`tianon/markdownfmt`](https://hub.docker.com/r/tianon/markdownfmt) image and `ymlfmt.sh` uses the [`tianon/ymlfmt`](https://hub.docker.com/r/tianon/ymlfmt) image.

## `.template-helpers/generate-dockerfile-links-partial.sh`

This script is used by `update.sh` to create the "Supported tags and respective `Dockerfile` links" section of each generated `README.md` from the information in the [official-images `library/` manifests](https://github.com/docker-library/official-images/tree/master/library).

## `.template-helpers/`

The scripts and Markdown files in here are used in building an image's `README.md` file in combination with its individual files.

# Scripts unrelated to templates

## `generate-repo-stub-readme.sh`

This is used to generate a simple `README.md` to put in the image's repo. We use this in Git repositories within https://github.com/docker-library to simplify our maintenance, but it is not required for anyone else. The only argument is the name of the image (or repo), like `golang` and it then outputs the readme to standard out.

## `push.pl` and `push.sh`

These are used by us to push the actual content of the READMEs to the Docker Hub as special access is required to modify the Hub description contents. The `Dockerfile` is used to create a suitable environment for `push.pl`.

# Issues and Contributing

If you would like to make a new Official Image, be sure to follow the [guidelines](https://docs.docker.com/docker-hub/official_repos/).

Feel free to make a pull request for fixes and improvements to current documentation. For questions or problems on this repo come talk to us via the `#docker-library` IRC channel on [Libera.Chat](https://libera.chat/) or open up an issue.
