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

Merge branch 'chrisward/image-desc-bp' of github.com:ChrisChinchilla/docs into chrisward/image-desc-bp

This commit is contained in:
Chris Chinchilla 2023-05-26 12:02:39 +02:00
parent b9bf546c60 5cc0f10fe0
commit 7bb26f6c01
1 changed files with 2 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
docker-hub/repos/create.md
View File

@ -38,7 +38,7 @@ When creating a new repository:
Description best practices
<i class="chevron fa fa-fw"></i></div>
<div class="collapse block" id="collapseSample1">
<p>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.</p>
<p>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.</p>
<h3>Describe the image</h3>
<p>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.</p>
<p>Optional information to include are examples of usage, history, the team behind the project, etc.</p>
@ -54,7 +54,7 @@ When creating a new repository:
<h3>Image tags and variants</h3>
<p>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.</p>
<h3>Where to find more information</h3>
<p>Add links here for docs and support sites, communities, or mailing lists were users can find more and ask questions.</p>
<p>Add links here for docs and support sites, communities, or mailing lists where users can find more and ask questions.</p>
<h3>Who the image is maintained by</h3>
<p>Who is the image maintained by and how can someone contact them with concerns.</p>
<h3>License</h3>