Skip to content

Commit c0656fa

Browse files
author
Jeffrey Morgan
committed
Rename official repos to official images
1 parent dacad06 commit c0656fa

File tree

12 files changed

+271
-60
lines changed

12 files changed

+271
-60
lines changed

_data/toc.yaml

+4-2
Original file line numberDiff line numberDiff line change
@@ -173,6 +173,8 @@ guides:
173173
path: /get-started/part4/
174174
- title: "Part 5: Stacks"
175175
path: /get-started/part5/
176+
- title: "Part 6: Deploy your app"
177+
path: /get-started/part6/
176178
- path: /engine/docker-overview/
177179
title: Docker overview
178180
- sectiontitle: Develop with Docker
@@ -3631,8 +3633,8 @@ manuals:
36313633
title: Docker ID
36323634
- path: /docker-hub/repos/
36333635
title: Public Repositories
3634-
- path: /docker-hub/official_repos/
3635-
title: Official Repositories
3636+
- path: /docker-hub/official_images/
3637+
title: Official Images
36363638
- path: /docker-hub/orgs/
36373639
title: Teams & Organizations
36383640
- path: /docker-hub/webhooks/

develop/develop-images/baseimages.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -119,4 +119,4 @@ There are lots more resources available to help you write your `Dockerfile`.
119119
* There's a [complete guide to all the instructions](/engine/reference/builder.md) available for use in a `Dockerfile` in the reference section.
120120
* To help you write a clear, readable, maintainable `Dockerfile`, we've also
121121
written a [`Dockerfile` best practices guide](dockerfile_best-practices.md).
122-
* If your goal is to create a new Official Repository, be sure to read up on Docker's [Official Repositories](/docker-hub/official_repos/).
122+
* If your goal is to create a new Official Image, be sure to read up on Docker's [Official Images](/docker-hub/official_images/).

develop/develop-images/dockerfile_best-practices.md

+5-5
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
description: Hints, tips and guidelines for writing clean, reliable Dockerfiles
3-
keywords: parent image, images, dockerfile, best practices, hub, official repo
3+
keywords: parent image, images, dockerfile, best practices, hub, official image
44
redirect_from:
55
- /articles/dockerfile_best-practices/
66
- /engine/articles/dockerfile_best-practices/
@@ -291,7 +291,7 @@ maintainable `Dockerfile`.
291291

292292
[Dockerfile reference for the FROM instruction](/engine/reference/builder.md#from)
293293

294-
Whenever possible, use current official repositories as the basis for your
294+
Whenever possible, use current official images as the basis for your
295295
images. We recommend the [Alpine image](https://hub.docker.com/_/alpine/) as it
296296
is tightly controlled and small in size (currently under 5 MB), while still
297297
being a full Linux distribution.
@@ -766,9 +766,9 @@ fails catastrophically if the new build's context is missing the resource being
766766
added. Adding a separate tag, as recommended above, helps mitigate this by
767767
allowing the `Dockerfile` author to make a choice.
768768

769-
## Examples for Official Repositories
769+
## Examples for Official Images
770770

771-
These Official Repositories have exemplary `Dockerfile`s:
771+
These Official Images have exemplary `Dockerfile`s:
772772

773773
* [Go](https://hub.docker.com/_/golang/)
774774
* [Perl](https://hub.docker.com/_/perl/)
@@ -780,4 +780,4 @@ These Official Repositories have exemplary `Dockerfile`s:
780780
* [Dockerfile Reference](/engine/reference/builder.md)
781781
* [More about Base Images](baseimages.md)
782782
* [More about Automated Builds](/docker-hub/builds/)
783-
* [Guidelines for Creating Official Repositories](/docker-hub/official_repos/)
783+
* [Guidelines for Creating Official Images](/docker-hub/official_images/)

docker-hub/builds/builds.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -207,7 +207,7 @@ To add a link:
207207

208208
2. In the Repository Links section, enter an image repository name.
209209

210-
A remote repository name should be either an official repository name such as `ubuntu` or a public repository name `namespace/repoName`.
210+
A remote repository name should be either an official image name such as `ubuntu` or a public repository name `namespace/repoName`.
211211

212212
3. Press **Add**.
213213

docker-hub/index.md

+5-5
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ Docker Hub provides the following major features:
1616
repositories allow you to share container images with your team. Public
1717
repositories allow you to share them with anyone.
1818
* [Teams & Organizations](/docker-hub/orgs.md): Manage access to private repositories.
19-
* [Official Repositories](/docker-hub/official_repos.md): Pull & use high-quality container images provided by Docker.
19+
* [Official Images](/docker-hub/official_images.md): Pull & use high-quality container images provided by Docker.
2020
* [Publisher Images](/docker-hub/publish/customer_faq.md): Pull & use high-quality container
2121
images provided by external vendors. Certified images also include support and guarantee
2222
compatibility with Docker Enterprise.
@@ -32,17 +32,17 @@ Start by creating an [account](/docker-hub/accounts.md) at [https://hub.docker.c
3232
> **Note**: You can search for and pull Docker images from Hub without logging
3333
> in, however to push images or share them with your team, you must log in.
3434
35-
## Find & Pull an Official Repositories
35+
## Find & Pull an Official Image
3636

3737
Docker Hub contains a number of [Official
3838
Repositories](http://hub.docker.com/explore/). These are curated repositories from vendors and contributors to Docker. They contain Docker images from vendors like Canonical, Oracle, and Elastic that you can use as the basis to build your applications and services.
3939

40-
With Official Repositories you know you're using an optimized and
40+
With Official Images you know you're using an optimized and
4141
up-to-date image that was built by experts to power your applications.
4242

43-
> **Note**: If you would like to contribute an Official Repository for your
43+
> **Note**: If you would like to contribute an Official Image for your
4444
> organization or product, see the documentation on
45-
> [Official Repositories on Docker Hub](/docker-hub/official_repos.md) for more
45+
> [Official Images on Docker Hub](/docker-hub/official_images.md) for more
4646
> information.
4747
4848
## Create your first repository and push an image to it

docker-hub/official_repos.md

+23-23
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
---
2-
description: Guidelines for Official Repositories on Docker Hub
2+
description: Guidelines for Official Images on Docker Hub
33
keywords: Docker, docker, registry, accounts, plans, Dockerfile, Docker Hub, docs, official,image, documentation
4-
title: Official repositories on Docker Hub
4+
title: Official Images on Docker Hub
55
---
66

7-
The Docker [Official Repositories](https://hub.docker.com/official/) are a
7+
The Docker [Official Images](https://hub.docker.com/search?q=&type=image&image_filter=official) are a
88
curated set of Docker repositories hosted on Docker Hub. They are
99
designed to:
1010

@@ -22,29 +22,29 @@ designed to:
2222
authors.
2323

2424
* Ensure that security updates are applied in a timely manner. This is
25-
particularly important as many Official Repositories are some of the most
25+
particularly important as many Official Images are some of the most
2626
popular on Docker Hub.
2727

2828
Docker, Inc. sponsors a dedicated team that is responsible for reviewing and
29-
publishing all content in the official repositories. This team works in
29+
publishing all content in the Official Images. This team works in
3030
collaboration with upstream software maintainers, security experts, and the
3131
broader Docker community.
3232

3333
While it is preferable to have upstream software authors maintaining their
34-
corresponding Official Repositories, this is not a strict requirement. Creating
35-
and maintaining images for Official Repositories is a public process. It takes
34+
corresponding Official Images, this is not a strict requirement. Creating
35+
and maintaining images for Official Images is a public process. It takes
3636
place openly on GitHub where participation is encouraged. Anyone can provide
3737
feedback, contribute code, suggest process changes, or even propose a new
38-
Official Repository.
38+
Official Image.
3939

40-
## Should I use Official Repositories?
40+
## Should I use Official Images?
4141

42-
New Docker users are encouraged to use the Official Repositories in their
42+
New Docker users are encouraged to use the Official Images in their
4343
projects. These repositories have clear documentation, promote best practices,
4444
and are designed for the most common use cases. Advanced users are encouraged to
45-
review the Official Repositories as part of their `Dockerfile` learning process.
45+
review the Official Images as part of their `Dockerfile` learning process.
4646

47-
A common rationale for diverging from Official Repositories is to optimize for
47+
A common rationale for diverging from Official Images is to optimize for
4848
image size. For instance, many of the programming language stack images contain
4949
a complete build toolchain to support installation of modules that depend on
5050
optimized code. An advanced user could build a custom image with just the
@@ -54,13 +54,13 @@ A number of language stacks such as
5454
[python](https://hub.docker.com/_/python/) and
5555
[ruby](https://hub.docker.com/_/ruby/) have `-slim` tag variants
5656
designed to fill the need for optimization. Even when these "slim" variants are
57-
insufficient, it is still recommended to inherit from an Official Repository
57+
insufficient, it is still recommended to inherit from an Official Image
5858
base OS image to leverage the ongoing maintenance work, rather than duplicating
5959
these efforts.
6060

61-
## How do I know the Official Repositories are secure?
61+
## How do I know the Official Images are secure?
6262

63-
Each of the images in the Official Repositories is scanned for vulnerabilities. The results of
63+
Each of the images in the Official Images is scanned for vulnerabilities. The results of
6464
these security scans provide valuable information about which images contain
6565
security vulnerabilities, and allow you to choose images that align with your
6666
security standards.
@@ -69,7 +69,7 @@ To view the Docker Security Scanning results:
6969

7070
1. Make sure you're logged in to Docker Hub.
7171
You can view Official Images even while logged out, however the scan results are only available once you log in.
72-
2. Navigate to the official repository whose security scan you want to view.
72+
2. Navigate to the repository of the Official Image whose security scan you want to view.
7373
3. Click the `Tags` tab to see a list of tags and their security scan summaries.
7474
![Viewing CVEs from Docker images](images/scan-drilldown.gif)
7575

@@ -80,37 +80,37 @@ when you click an individual vulnerable component.
8080

8181
## How can I get involved?
8282

83-
All Official Repositories contain a **User Feedback** section in their
83+
All Official Images contain a **User Feedback** section in their
8484
documentation which covers the details for that specific repository. In most
8585
cases, the GitHub repository which contains the Dockerfiles for an Official
8686
Repository also has an active issue tracker. General feedback and support
8787
questions should be directed to `#docker-library` on Freenode IRC.
8888

89-
## How do I create a new Official Repository?
89+
## How do I create a new Official Image?
9090

91-
From a high level, an Official Repository starts out as a proposal in the form
91+
From a high level, an Official Image starts out as a proposal in the form
9292
of a set of GitHub pull requests. Detailed and objective proposal
9393
requirements are documented in the following GitHub repositories:
9494

9595
* [docker-library/official-images](https://github.com/docker-library/official-images)
9696

9797
* [docker-library/docs](https://github.com/docker-library/docs)
9898

99-
The Official Repositories team, with help from community contributors, formally
99+
The Official Images team, with help from community contributors, formally
100100
review each proposal and provide feedback to the author. This initial review
101101
process may require a bit of back and forth before the proposal is accepted.
102102

103103
There are also subjective considerations during the review process. These
104104
subjective concerns boil down to the basic question: "is this image generally
105105
useful?" For example, the [python](https://hub.docker.com/_/python/)
106-
Official Repository is "generally useful" to the large Python developer
106+
Official Image is "generally useful" to the large Python developer
107107
community, whereas an obscure text adventure game written in Python last week is
108108
not.
109109

110110
Once a new proposal is accepted, the author is responsible for keeping
111111
their images up-to-date and responding to user feedback. The Official
112112
Repositories team becomes responsible for publishing the images and
113-
documentation on Docker Hub. Updates to the Official Repository follow the same
114-
pull request process, though with less review. The Official Repositories team
113+
documentation on Docker Hub. Updates to the Official Image follow the same
114+
pull request process, though with less review. The Official Images team
115115
ultimately acts as a gatekeeper for all changes, which helps mitigate the risk
116116
of quality and security issues from being introduced.

docker-hub/publish/certify-images.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ You must use the tool, `inspectDockerImage`, to certify your content for publica
2222

2323
The `inspectDockerImage` tool does the following:
2424

25-
- Verifies that the Docker image was built from an image in the [Docker Official Repository](https://github.com/docker-library/repo-info/tree/master/repos)
25+
- Verifies that the Docker image was built from an image in the [Docker Official Image](https://github.com/docker-library/repo-info/tree/master/repos)
2626

2727
- Inspects the Docker image for a Health Check. Although a Health Check is not required, it is recommended.
2828

docker-hub/publish/publish.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,7 @@ and guidelines listed below to build and deliver great content:
6262

6363
* [Best practices for writing Dockerfiles](/engine/userguide/eng-image/dockerfile_best-practices/)
6464

65-
* [Official repositories on Docker Hub](/docker-hub/official_repos/)
65+
* [Official Images on Docker Hub](/docker-hub/official_images/)
6666

6767
* [Docker Bench for Security](https://github.com/docker/docker-bench-security){: target="_blank"
6868
class="_"}

docker-hub/repos.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ There you can see two example results: `centos` and `ansible/centos7-ansible`.
3434
The second result shows that it comes from the public repository of a user,
3535
named `ansible/`, while the first result, `centos`, doesn't explicitly list a
3636
repository which means that it comes from the top-level namespace for [Official
37-
Repositories](official_repos.md). The `/` character separates a user's
37+
Images](/docker-hub/official_images.md). The `/` character separates a user's
3838
repository from the image name.
3939

4040
Once you've found the image you want, you can download it with `docker pull <imagename>`:

0 commit comments

Comments
 (0)