From 64e2baba728991b939e67ec78cc0bc90c92ecb25 Mon Sep 17 00:00:00 2001 From: Matt Farina Date: Tue, 8 Sep 2020 15:24:32 -0400 Subject: [PATCH] Add docs on Artifact Hub migration Relates to #439 Signed-off-by: Matt Farina --- README.md | 22 ++++++++++++++++++++++ Repositories.md | 6 ++++++ 2 files changed, 28 insertions(+) diff --git a/README.md b/README.md index 5d7b71d2..d15e05a6 100644 --- a/README.md +++ b/README.md @@ -20,6 +20,28 @@ project. This has implications for those who build and distribute charts includi - They can manage the workflow around releases themselves - They can track metrics around the use of their charts +## Artifact Hub Migration + +The Helm Hub is migrating to the [Artifact Hub](https://artifacthub.io/) ([issue here](https://github.com/helm/hub/issues/439)). This means a few changes are coming: + +- When the migration is complete, the Helm Hub will redirect to the Artifact Hub +- The Helm Client will search the Artifact Hub instead of the Helm Hub +- Charts will be listed in the Artifact Hub instead of the Helm Hub + +Chart repositories listed in the Helm Hub have been migrated to the Artifact Hub +if they were not already listed there. They are managed by the Helm Organization. +If you own one of the repositories and want to claim it there are two methods +you can use. + +1. Once you have an account (or organization) setup you can claim ownership. This + happens via the "Claim Ownership" button in the Repositories settings. This + will walk you through a process where you prove ownership to claim it. +2. Contact one of the Helm chart maintainers and work through a manual handoff. + +You are encouraged to take over ownership of your repositories in the Artifact Hub. +The first method is the preferred method as a repository owner can accomplish this +at their own pace. + ## How To Add Your Helm Charts The process to add a repository and all of its charts is documented in the diff --git a/Repositories.md b/Repositories.md index 0ee34d59..300c6d10 100644 --- a/Repositories.md +++ b/Repositories.md @@ -4,6 +4,12 @@ This document outlines the requirements and guidelines for a Helm repository to be listed in the distributed search hosted by the Helm Project. This document may be updated at any time. +## Artifact Hub + +The Helm Hub is in the process of migrating to the [Artifact Hub](https://artifacthub.io/). +Please list your repository in the Artifact Hub prior to listing it in the Helm +Hub. + ## Process to Add A Repository To add a repository create a new pull request with the following two pieces