From 4fda44a82b2c3d28f59ad78a376634179b5b7d9f Mon Sep 17 00:00:00 2001 From: Chris Chinchilla Date: Thu, 25 May 2023 14:22:21 +0200 Subject: [PATCH 1/8] Add description best practices Signed-off-by: Chris Chinchilla --- docker-hub/repos/create.md | 29 +++++++++++++++++++++++++++++ 1 file changed, 29 insertions(+) diff --git a/docker-hub/repos/create.md b/docker-hub/repos/create.md index 32da7bca95..bf71f5dfd0 100644 --- a/docker-hub/repos/create.md +++ b/docker-hub/repos/create.md @@ -32,6 +32,35 @@ When creating a new repository: > You can't rename a Docker Hub repository once it's created. - The description can be up to 100 characters. It is used in the search results. + +
+ +
+

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

+

Include a description of what the image is, the features it offers, and why people might want 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

+

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:

+
    +
  • Exposing ports
    • +
  • Default environment variables
    • +
  • Non-root user
    • +
  • Running in debug mode
    • +
+

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

+

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

+

Who the image is maintained by

+

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

+

License

+

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

+
+ - If you are a Docker Verified Publisher (DVP) or Docker-Sponsored Open Source (DSOS) organization, you can also add a logo to a repository. The maximum size is 1000x1000. - You can link a GitHub or Bitbucket account now, or choose to do it later in the repository settings. From 96b60be29b1c26306e1cb318113c3f5e1e4cf533 Mon Sep 17 00:00:00 2001 From: Chris Chinchilla Date: Fri, 26 May 2023 11:10:09 +0200 Subject: [PATCH 2/8] Update docker-hub/repos/create.md Co-authored-by: Stephanie Aurelio <133041642+stephaurelio@users.noreply.github.com> --- docker-hub/repos/create.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docker-hub/repos/create.md b/docker-hub/repos/create.md index bf71f5dfd0..cfcc390a6b 100644 --- a/docker-hub/repos/create.md +++ b/docker-hub/repos/create.md @@ -38,7 +38,7 @@ When creating a new repository: Description best practices
-

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.

+

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

Describe the image

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

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

From 5cc0f10fe0bce5c9a633aa92a7f412efbf90d508 Mon Sep 17 00:00:00 2001 From: Chris Chinchilla Date: Fri, 26 May 2023 11:10:51 +0200 Subject: [PATCH 3/8] Update docker-hub/repos/create.md Co-authored-by: Stephanie Aurelio <133041642+stephaurelio@users.noreply.github.com> --- docker-hub/repos/create.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docker-hub/repos/create.md b/docker-hub/repos/create.md index cfcc390a6b..31629069b2 100644 --- a/docker-hub/repos/create.md +++ b/docker-hub/repos/create.md @@ -54,7 +54,7 @@ When creating a new repository:

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

-

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

+

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

Who the image is maintained by

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

License

From b9bf546c6030fc13a2ac284f22e520ab4fd70a4d Mon Sep 17 00:00:00 2001 From: Chris Chinchilla Date: Fri, 26 May 2023 12:02:33 +0200 Subject: [PATCH 4/8] Draft Signed-off-by: Chris Chinchilla --- docker-hub/repos/create.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docker-hub/repos/create.md b/docker-hub/repos/create.md index bf71f5dfd0..c5c1da78d6 100644 --- a/docker-hub/repos/create.md +++ b/docker-hub/repos/create.md @@ -40,7 +40,7 @@ When creating a new repository:

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

-

Include a description of what the image is, the features it offers, and why people might want to use it in their project or 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

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.

From 9a0d450c6488bb32bb7501d18af531327716f0fc Mon Sep 17 00:00:00 2001 From: Chris Chinchilla Date: Fri, 26 May 2023 12:29:47 +0200 Subject: [PATCH 5/8] Move and update copy and context Signed-off-by: Chris Chinchilla --- docker-hub/repos/create.md | 62 ++++++++++++++++++++------------------ 1 file changed, 33 insertions(+), 29 deletions(-) diff --git a/docker-hub/repos/create.md b/docker-hub/repos/create.md index 99e2661924..a238fe2e1f 100644 --- a/docker-hub/repos/create.md +++ b/docker-hub/repos/create.md @@ -32,35 +32,6 @@ When creating a new repository: > You can't rename a Docker Hub repository once it's created. - The description can be up to 100 characters. It is used in the search results. - -
- -
-

A good image description is essential to help potential users understand why and how to use the image. The below covers the best practices to follow when adding a description to your 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

-

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:

-
    -
  • Exposing ports
    • -
  • Default environment variables
    • -
  • Non-root user
    • -
  • Running in debug mode
    • -
-

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

-

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

-

Who the image is maintained by

-

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

-

License

-

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

-
- - If you are a Docker Verified Publisher (DVP) or Docker-Sponsored Open Source (DSOS) organization, you can also add a logo to a repository. The maximum size is 1000x1000. - You can link a GitHub or Bitbucket account now, or choose to do it later in the repository settings. @@ -70,6 +41,39 @@ When creating a new repository: > > For organizations creating a new repository, it's recommended you select **Private**. +### Add a repository overview + +Once you have created a repository, add an overview to the **Repository overview** field. This describes what your image does and how to use it. + +
+ +
+

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

+

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

+

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:

+
    +
  • Exposing ports
    • +
  • Default environment variables
    • +
  • Non-root user
    • +
  • Running in debug mode
    • +
+

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

+

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 is the image maintained by and how can someone contact them with concerns.

+

License

+

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

+
+
+ ## Push a Docker container image to Docker Hub Once you have created a repository, you can start using `docker push` to push From bc5fcbadeda040df442f8b83e620af5528aeface Mon Sep 17 00:00:00 2001 From: Chris Chinchilla Date: Sat, 27 May 2023 12:21:29 +0200 Subject: [PATCH 6/8] Update docker-hub/repos/create.md Co-authored-by: Stephanie Aurelio <133041642+stephaurelio@users.noreply.github.com> --- docker-hub/repos/create.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docker-hub/repos/create.md b/docker-hub/repos/create.md index a238fe2e1f..4999e17d4b 100644 --- a/docker-hub/repos/create.md +++ b/docker-hub/repos/create.md @@ -50,7 +50,7 @@ Once you have created a repository, add an overview to the **Repository overview Repository overview best practices
-

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.

+

A good image description is essential to help potential users understand why and how to use the image. The below covers the best practices to follow when adding a description to your 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.

From fce72ebf14762882804296c3696c7f2cb571a4e2 Mon Sep 17 00:00:00 2001 From: Chris Chinchilla Date: Sat, 27 May 2023 12:21:41 +0200 Subject: [PATCH 7/8] Update docker-hub/repos/create.md Co-authored-by: Stephanie Aurelio <133041642+stephaurelio@users.noreply.github.com> --- docker-hub/repos/create.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docker-hub/repos/create.md b/docker-hub/repos/create.md index 4999e17d4b..f25dd02ff8 100644 --- a/docker-hub/repos/create.md +++ b/docker-hub/repos/create.md @@ -66,7 +66,7 @@ Once you have created a repository, add an overview to the **Repository overview

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

-

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

+

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

Who maintains the image

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

License

From a51cb7a12513bd3981879969e7c351f4743fc056 Mon Sep 17 00:00:00 2001 From: Chris Chinchilla Date: Tue, 30 May 2023 12:03:56 +0200 Subject: [PATCH 8/8] Tweak headings displayed Signed-off-by: Chris Chinchilla --- docker-hub/repos/create.md | 13 +++++++------ 1 file changed, 7 insertions(+), 6 deletions(-) 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:

    @@ -63,13 +64,13 @@ Once you have created a repository, add an overview to the **Repository overview
  • Non-root user
  • Running in debug mode
-

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.