From 8a805f4f0b31f17c85a5255cde3122fae90be068 Mon Sep 17 00:00:00 2001 From: Craig Osterhout <103533812+craig-osterhout@users.noreply.github.com> Date: Mon, 9 Dec 2024 08:36:19 -0800 Subject: [PATCH] hub: add archive repo (#21553) ## Description - Added topic for archive or activate a repository - Updated repo landing page topic to add new archive topic - Added note to repo information topic Modified pages: - https://deploy-preview-21553--docsdocker.netlify.app/docker-hub/repos/ - https://deploy-preview-21553--docsdocker.netlify.app/docker-hub/repos/archive/ - https://deploy-preview-21553--docsdocker.netlify.app/docker-hub/repos/manage/information/ ## Related issues or tickets ENGDOCS-2337 ## Reviews - [ ] Technical review - [ ] Editorial review - [ ] Product review --------- Signed-off-by: Craig Co-authored-by: David Karlsson <35727626+dvdksn@users.noreply.github.com> --- _vale/config/vocabularies/Docker/accept.txt | 1 + content/manuals/docker-hub/repos/_index.md | 3 +- content/manuals/docker-hub/repos/archive.md | 63 ++++++++++++++++++ .../repos/images/outdated-icon.webp | Bin 0 -> 198 bytes .../docker-hub/repos/manage/information.md | 4 ++ 5 files changed, 70 insertions(+), 1 deletion(-) create mode 100644 content/manuals/docker-hub/repos/archive.md create mode 100644 content/manuals/docker-hub/repos/images/outdated-icon.webp diff --git a/_vale/config/vocabularies/Docker/accept.txt b/_vale/config/vocabularies/Docker/accept.txt index 354982cbc7..97b29fc633 100644 --- a/_vale/config/vocabularies/Docker/accept.txt +++ b/_vale/config/vocabularies/Docker/accept.txt @@ -132,6 +132,7 @@ Zsh [Ss]yscalls? [Ss]ysfs [Tt]oolchains? +[Uu]narchived? [Vv]irtiofs [Vv]irtualize [Ww]alkthrough diff --git a/content/manuals/docker-hub/repos/_index.md b/content/manuals/docker-hub/repos/_index.md index 7eb9e73b7c..5ead03bebe 100644 --- a/content/manuals/docker-hub/repos/_index.md +++ b/content/manuals/docker-hub/repos/_index.md @@ -46,7 +46,8 @@ In this section, learn how to: - [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. - + +- [Archive](./archive.md) an outdated or unsupported repository. - [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 diff --git a/content/manuals/docker-hub/repos/archive.md b/content/manuals/docker-hub/repos/archive.md new file mode 100644 index 0000000000..18c89bfccc --- /dev/null +++ b/content/manuals/docker-hub/repos/archive.md @@ -0,0 +1,63 @@ +--- +description: Learn how to archive or unarchive a repository on Docker Hub +keywords: Docker Hub, Hub, repositories, archive, unarchive +title: Archive or unarchive a repository +linkTitle: Archive +toc_max: 3 +weight: 35 +--- + +You can archive a repository on Docker Hub to mark it as read-only and indicate +that it's no longer actively maintained. This helps prevent the use of outdated +or unsupported images in workflows. Archived repositories can also be unarchived +if needed. + +Docker Hub highlights repositories that haven't been updated in over a year by +displaying an icon ({{< inline-image src="./images/outdated-icon.webp" +alt="outdated icon" >}}) next to them on the [**Repositories** +page](https://hub.docker.com/repositories/). Consider reviewing these +highlighted repositories and archiving them if necessary. + +When a repository is archived, the following occurs: + +- The repository information can't be modified. +- New images can't be pushed to the repository. +- An **Archived** label is displayed on the public repository page. +- Users can still pull the images. + +You can unarchive an archived repository to remove the archived state. When +unarchived, the following occurs: + +- The repository information can be modified. +- New images can be pushed to the repository. +- The **Archived** label is removed on the public repository page. + +## Archive a repository + +1. Sign in to [Docker Hub](https://hub.docker.com). +2. Select **Repositories**. + + A list of your repositories appears. + +3. Select a repository. + + The **General** page for the repository appears. + +4. Select the **Settings** tab. +5. Select **Archive repository**. +6. Enter the name of your repository to confirm. +7. Select **Archive**. + +## Unarchive a repository + +1. Sign in to [Docker Hub](https://hub.docker.com). +2. Select **Repositories**. + + A list of your repositories appears. + +3. Select a repository. + + The **General** page for the repository appears. + +4. Select the **Settings** tab. +5. Select **Unarchive repository**. \ No newline at end of file diff --git a/content/manuals/docker-hub/repos/images/outdated-icon.webp b/content/manuals/docker-hub/repos/images/outdated-icon.webp new file mode 100644 index 0000000000000000000000000000000000000000..153d3dcea0926d5cb590c3f78ef565921313de43 GIT binary patch literal 198 zcmV;%06G6sNk&G#00012MM6+kP&gp60000m1pu7^Dir_`06vjIn@T04q9LdV0I(7X zYyiFG04~5ckO@zIJcwWxBYrC6)Dhz&5CH!BrYyhpuC83>V)-%aHGiy>uY_p1c(J($ zM7Yac(OM+&LmNz!*Pt4Lm%LGmNjtqg4^1pPr-vWAY3}}VYa@o^nz~a2#?3wypEEw( z`x~Q0f_*lzF9@7f#rC&9zu|>}^<1jZUoyY1cTn|R&G`FU5K%y;zC_uRt^fc40FMt< AP5=M^ literal 0 HcmV?d00001 diff --git a/content/manuals/docker-hub/repos/manage/information.md b/content/manuals/docker-hub/repos/manage/information.md index a6da93c26d..0edff44ca9 100644 --- a/content/manuals/docker-hub/repos/manage/information.md +++ b/content/manuals/docker-hub/repos/manage/information.md @@ -12,6 +12,10 @@ Each repository can include a description, an overview, and categories to help users understand its purpose and usage. Adding clear repository information ensures that others can find your images and use them effectively. +You can only modify the repository information of repositories that aren't +archived. If a repository is archived, you must unarchive it to modify the +information. For more details, see [Unarchive a repository](../archive.md#unarchive-a-repository). + ## Repository description The description appears in search results when using the `docker search` command