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

Add description best practices 

Signed-off-by: Chris Chinchilla <chris.ward@docker.com>
This commit is contained in:
Chris Chinchilla 2023-05-25 14:22:21 +02:00
parent 7ecfd29e57
commit 4fda44a82b
No known key found for this signature in database
GPG Key ID: 78FA9FB7CEAE483F
1 changed files with 29 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -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.
<div class="panel panel-default">
<div class="panel-heading collapsed" data-toggle="collapse" data-target="#collapseSample1" style="cursor: pointer">
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>
<h3>Describe the image</h3>
<p>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.</p>
<p>Optional information to include are examples of usage, history, the team behind the project, etc.</p>
<h3>How to start and use the image</h3>
<p>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.</p>
<p>Optional information to include, if relevant, is:</p>
<ul>
<li>Exposing ports</li>
<li>Default environment variables</li>
<li>Non-root user</li>
<li>Running in debug mode</li>
</ul>
<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>
<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>
<p>What is the license for the image and where can people find more details if needed.</p>
</div>
- 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.