diff --git a/docker-hub/repos/create.md b/docker-hub/repos/create.md index a238fe2e1f..38acf2eabb 100644 --- a/docker-hub/repos/create.md +++ b/docker-hub/repos/create.md @@ -2,6 +2,7 @@ description: Creating repositories on Docker Hub keywords: Docker, docker, trusted, registry, accounts, plans, Dockerfile, Docker Hub, webhooks, docs, documentation, manage, repos title: Create repositories +toc_max: 3 redirect_from: - /docker-hub/repos/configure/ --- @@ -51,10 +52,10 @@ Once you have created a repository, add an overview to the **Repository overview

A good image description is essential to help potential users understand why and how to use the image. The bellow covers the best practices to follow when adding a description to your image.

-

Describe the image

+

Describe the image

Include a description of what the image is, the features it offers, and why people might want or need to use it in their project or image.

Optional information to include are examples of usage, history, the team behind the project, etc.

-

How to start and use the image

+

How to start and use the image

Provide instructions for a minimal “getting started” example with running a container using the image. Also provide a minimal example of how to use the image in a Dockerfile.

Optional information to include, if relevant, is:

-

Image tags and variants

+

Image tags and variants

List the key image variants and the tags for using them along with what that variant offers and why someone might want to use that variant.

-

Where to find more information

+

Where to find more information

Add links here for docs and support sites, communities, or mailing lists were users can find more and ask questions.

-

Who maintains the image

+

Who maintains the image

Who is the image maintained by and how can someone contact them with concerns.

-

License

+

License

What is the license for the image and where can people find more details if needed.