Skip to content

Commit

Permalink
hub: refresh/restructure repo content (#21435)
Browse files Browse the repository at this point in the history
<!--Delete sections as needed -->

## Description

Started refreshing and reorganizing the Hub manual.

- Moved & rearranged the content from "Docker Hub > Manage repositories"
to "Docker Hub > Repositories > Manage" with the following sections:
  - repo info: description, overview, categories
  - access: visibility, collaborators, teams/permissions, roles, OATs
  - images: tags, software artifacts, push images, move images
- Moved the repository features (automated builds, webhooks,
vulnerability scanning) under "Repositories > Manage".
- Moved/added Create, Delete, and Personal settings to top-level of
Repositories
- Filled in some content gaps

https://deploy-preview-21435--docsdocker.netlify.app/docker-hub/repos/

## Related issues or tickets

ENGDOCS-2227

## Reviews

<!-- Notes for reviewers here -->
<!-- List applicable reviews (optionally @tag reviewers) -->

- [ ] Technical review
- [ ] Editorial review
- [ ] Product review

---------

Signed-off-by: Craig <[email protected]>
  • Loading branch information
craig-osterhout authored Nov 21, 2024
1 parent 42d97aa commit 5d12cf6
Show file tree
Hide file tree
Showing 54 changed files with 861 additions and 413 deletions.
1 change: 0 additions & 1 deletion _vale/Docker/RecommendedWords.yml
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,6 @@ swap:
keypress: keystroke
mutices: mutexes
repo: repository
scan: analyze
scroll: navigate
url: URL
vs: versus
Expand Down
1 change: 0 additions & 1 deletion _vale/config/vocabularies/Docker/accept.txt
Original file line number Diff line number Diff line change
Expand Up @@ -144,7 +144,6 @@ minikube
monorepos?
musl
nameserver
namespace
npm
osquery
osxfs
Expand Down
2 changes: 1 addition & 1 deletion content/guides/jupyter.md
Original file line number Diff line number Diff line change
Expand Up @@ -382,7 +382,7 @@ $ docker run --rm -p 8889:8888 YOUR-USER-NAME/my-jupyter-image start-notebook.py

### Share your volume

This example uses the Docker Desktop graphical user interface. Alternatively, in the command line interface you can [back up the volume](/engine/storage/volumes/#back-up-a-volume) and then [push it using the ORAS CLI](/manuals/docker-hub/oci-artifacts.md#push-a-volume).
This example uses the Docker Desktop graphical user interface. Alternatively, in the command line interface you can [back up the volume](/engine/storage/volumes/#back-up-a-volume) and then [push it using the ORAS CLI](/manuals/docker-hub/repos/manage/hub-images/oci-artifacts.md#push-a-volume).

1. Sign in to Docker Desktop.
2. In the Docker Dashboard, select **Volumes**.
Expand Down
2 changes: 1 addition & 1 deletion content/manuals/accounts/deactivate-user-account.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ Before deactivating your Docker account, ensure you meet the following requireme

- Download any images and tags you want to keep. Use `docker pull -a <image>:<tag>`.

- Unlink your [GitHub and Bitbucket accounts](../docker-hub/builds/link-source.md#unlink-a-github-user-account).
- Unlink your [GitHub and Bitbucket accounts](../docker-hub/repos/manage/builds/link-source.md#unlink-a-github-user-account).

## Deactivate

Expand Down
2 changes: 1 addition & 1 deletion content/manuals/admin/deactivate-account.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ Before deactivating an organization, complete the following:

- Remove all other members within the organization.

- Unlink your [Github and Bitbucket accounts](../docker-hub/builds/link-source.md#unlink-a-github-user-account).
- Unlink your [Github and Bitbucket accounts](../docker-hub/repos/manage/builds/link-source.md#unlink-a-github-user-account).

## Deactivate

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -82,7 +82,7 @@ This release contains a Kubernetes upgrade. Note that your local Kubernetes clus

### New

- If you have enabled [Vulnerability Scanning](/docker-hub/vulnerability-scanning/) in Docker Hub, the scan results will now appear in Docker Desktop.
- If you have enabled [Vulnerability Scanning](/docker-hub/repos/manage/vulnerability-scanning/) in Docker Hub, the scan results will now appear in Docker Desktop.

### Upgrades

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -74,7 +74,7 @@ This release contains a Kubernetes upgrade. Note that your local Kubernetes clus

### New

- If you have enabled [Vulnerability Scanning](../../docker-hub/vulnerability-scanning.md) in Docker Hub, the scan results will now appear in Docker Desktop.
- If you have enabled [Vulnerability Scanning](../../docker-hub/repos/manage/vulnerability-scanning.md) in Docker Hub, the scan results will now appear in Docker Desktop.

### Upgrades

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ This includes:
- The resources in the [Learning Center](/manuals/desktop/use-desktop/_index.md)
- Pulling or pushing an image to Docker Hub
- [Image Access Management](/manuals/security/for-developers/access-tokens.md)
- [Static vulnerability scanning](/manuals/docker-hub/vulnerability-scanning.md)
- [Static vulnerability scanning](/manuals/docker-hub/repos/manage/vulnerability-scanning.md)
- Viewing remote images in the Docker Dashboard
- Setting up [Dev Environments](/manuals/desktop/features/dev-environments/_index.md)
- Docker Build when using [BuildKit](/manuals/build/buildkit/_index.md#getting-started).
Expand Down
10 changes: 2 additions & 8 deletions content/manuals/desktop/use-desktop/volumes.md
Original file line number Diff line number Diff line change
Expand Up @@ -144,10 +144,7 @@ You can either [export a volume now](#export-a-volume-now) or [schedule a recurr
- **Local image**: Select a local image to export the content to. Any
existing data in the image will be replaced by the exported content.
- **New image**: Specify a name for the new image.
- **Registry**: Specify a Docker Hub repository. Note that Docker Hub
repositories can be publicly accessible which means your data can be
publicly accessible. For more details, see
[Change a repository from public to private](/docker-hub/repos/#change-a-repository-from-public-to-private).
- **Registry**: Specify a Docker Hub repository.

{{< /tab >}}
{{< tab name="External cloud storage" >}}
Expand Down Expand Up @@ -193,10 +190,7 @@ You can either [export a volume now](#export-a-volume-now) or [schedule a recurr
- **Local image**: Select a local image to export the content to. Any
existing data in the image will be replaced by the exported content.
- **New image**: Specify a name for the new image.
- **Registry**: Specify a Docker Hub repository. Note that Docker Hub
repositories can be publicly accessible which means your data can be
publicly accessible. For more details, see
[Change a repository from public to private](/docker-hub/repos/#change-a-repository-from-public-to-private).
- **Registry**: Specify a Docker Hub repository.

{{< /tab >}}
{{< tab name="External cloud storage" >}}
Expand Down
Binary file not shown.
9 changes: 3 additions & 6 deletions content/manuals/docker-hub/quickstart.md
Original file line number Diff line number Diff line change
Expand Up @@ -217,9 +217,6 @@ these options.

## Next steps

- Automatically build container images from code through
[builds](builds/_index.md).
- Use [webhooks](./webhooks.md) to cause an action in another service in
response to a push event in the repository.
- Manage [repository settings](./repos/_index.md) to set the default privacy for
your repositories.
Add [repository information](./repos/manage/information.md) to help users find and use
your image.

6 changes: 3 additions & 3 deletions content/manuals/docker-hub/release-notes.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ Take a look at the [Docker Public Roadmap](https://github.com/orgs/docker/projec

### New

- You can tag Docker Hub repositories with [categories](./repos/categories.md).
- You can tag Docker Hub repositories with [categories](./repos/manage/information.md#repository-categories).

## 2023-12-11

Expand Down Expand Up @@ -80,7 +80,7 @@ Take a look at the [Docker Public Roadmap](https://github.com/orgs/docker/projec

### New

- The new [autobuild feature](../docker-hub/builds/manage-builds.md#check-your-active-builds) lets you view your in-progress logs every 30 seconds instead of when the build is complete.
- The new [autobuild feature](../docker-hub/repos/manage/builds/manage-builds.md#check-your-active-builds) lets you view your in-progress logs every 30 seconds instead of when the build is complete.

## 2022-09-21

Expand Down Expand Up @@ -191,7 +191,7 @@ For more information about this feature and for instructions on how to use it, s

### New feature

The **Repositories** view now shows which images have gone stale because they haven't been pulled or pushed recently. For more information, see [repository tags](repos/access/_index.md#view-repository-tags).
The **Repositories** view now shows which images have gone stale because they haven't been pulled or pushed recently. For more information, see [repository tags](repos/manage/access/_index.md#view-repository-tags).

## 2020-10-07

Expand Down
128 changes: 47 additions & 81 deletions content/manuals/docker-hub/repos/_index.md
Original file line number Diff line number Diff line change
@@ -1,88 +1,54 @@
---
description: Learn how to manage repositories on Docker Hub
keywords: Docker, docker, trusted, registry, accounts, plans, Dockerfile, Docker Hub,
webhooks, docs, documentation, manage, repos
title: Manage repositories
keywords: Docker Hub, Hub, repositories
title: Repositories
weight: 20
aliases:
- /engine/tutorials/dockerrepos/
- /docker-hub/repos/
- /docker-hub/repos/configure/
---

## Manage default repository settings

You can manage the default repository settings for your personal account in Docker Hub. Select the **Settings** icon, then select **Repository Settings**.

![Repository settings menu](../images/docker-hub-repo-settings-menu.png)

Here you can manage the following:

- Default privacy: set the default repository privacy to either **Public** or **Private**.
- Linked accounts: for users with a Docker Pro, Team, or Business subscription, manage your source provider accounts to enable Automated Builds.
- Notifications: for users with a Docker Pro, Team, or Business subscription, manage how you receive notifications from autobuilds.

## Change a repository from public to private

1. Navigate to your repository.
2. Select the **Settings** tab.
3. Select **Make private**.
4. Enter the name of your repository to confirm.

You get one free private repository with your Docker Hub user account (not
available for organizations you're a member of). If you need more private
repositories for your user account, upgrade your Docker Hub subscription from your [Billing Information](https://hub.docker.com/billing/plan) page.

## Move images between repositories

### Personal to personal

When consolidating personal repositories, you can pull private images from the initial repository and push them into another repository owned by you. To avoid losing your private images, perform the following steps:

1. Navigate to [Docker Hub](https://hub.docker.com) create a new Docker ID and select a personal subscription.
2. Using `docker login` from the CLI, sign in using your original Docker ID and pull your private images.
3. Tag your private images with your newly created Docker ID, for example:

```console
$ docker tag namespace1/docker101tutorial new_namespace/docker101tutorial
```
4. Using `docker login` from the CLI, sign in with your newly created Docker ID, and push your newly tagged private images to your new Docker ID namespace:

```console
$ docker push new_namespace/docker101tutorial
```

The private images that existed in your previous account are now available in your new account.

### Personal to an organization

To avoid losing your private images, you can pull your private images from your personal account and push them to an organization that's owned by you.

1. Navigate to [Docker Hub](https://hub.docker.com) and select **Organizations**.
2. Select the applicable organization and verify that your user account is a member of the organization.
3. Sign in to [Docker Hub](https://hub.docker.com) using your original Docker ID, and pull your images:

```console
$ docker pull namespace1/docker101tutorial
```
4. Tag your images with your new organization namespace:

```console
$ docker tag namespace1/docker101tutorial <new_org>/docker101tutorial
```
5. Push your newly tagged images to your new org namespace:

```console
$ docker push new_org/docker101tutorial
```

The private images that existed in your user account are now available for your organization.

## Delete a repository

> [!WARNING]
>
> Deleting a repository deletes all the images it contains and its build settings. This action can't be undone.
1. Navigate to your repository.
2. Select the **Settings** tab.
3. Select **Delete repository**.
4. Enter the name of your repository to confirm.
A Docker Hub repository is a collection of container images, enabling you to
store, manage, and share Docker images publicly or privately. Each repository
serves as a dedicated space where you can store images associated with a
particular application, microservice, or project. Content in repositories is
organized by tags, which represent different versions of the same application,
allowing users to pull the right version when needed.

In this section, learn how to:

- [Create](./create.md) a repository.
- Manage a repository, including how to manage:

- [Repository information](./manage/information.md): Add descriptions,
overviews, and categories to help users understand the purpose and usage of
your repository. Clear repository information aids discoverability and
usability.

- [Access](./manage/access.md): Control who can access your repositories with
flexible options. Make repositories public or private, add collaborators,
and, for organizations, manage roles and teams to maintain security and
control.

- [Images](./manage/hub-images/_index.md): Repositories support diverse
content types, including OCI artifacts, and allow version control through
tagging. Push new images and manage existing content across repositories
for flexibility.

- [Image security insights](./manage/vulnerability-scanning.md): Utilize
continuous Docker Scout analysis and static vulnerability scanning to
detect, understand, and address security issues within container images.

- [Webhooks](./manage/webhooks.md): Automate responses to repository events
like image pushes or updates by setting up webhooks, which can trigger
notifications or actions in external systems, streamlining workflows.

- [Automated builds](./manage/builds/_index.md): Integrate with GitHub or
Bitbucket for automated builds. Every code change triggers an image
rebuild, supporting continuous integration and delivery.

- [Delete](./delete.md) a repository.
- [Manage personal settings](./settings.md): For your account, you can set personal
settings for repositories, including default repository privacy and autobuild
notifications.
89 changes: 0 additions & 89 deletions content/manuals/docker-hub/repos/access.md

This file was deleted.

Loading

0 comments on commit 5d12cf6

Please sign in to comment.