diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 23c8a9aaac..4839ba99c7 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -14,7 +14,7 @@ The contributor's guide: * and [describes](https://www.kubeflow.org/docs/about/contributing/#owners-files-and-pr-workflow) the pull request and review workflow in detail, including the OWNERS files and automated workflow tool -The [Kubeflow Community calendar](https://www.kubeflow.org/docs/about/community/#kubeflow-community-calendar) provides an overview of the community calls and specifically the bi-weekly Kubeflow Model Registry meeting. +The [Kubeflow Community calendar](https://www.kubeflow.org/docs/about/community/#kubeflow-community-calendar) provides an overview of the community calls and specifically the bi-weekly Kubeflow Hub meeting.
diff --git a/README.md b/README.md index 4ed6ea21b4..d6bd4595b8 100644 --- a/README.md +++ b/README.md @@ -6,7 +6,9 @@ [![OpenSSF Best Practices](https://www.bestpractices.dev/projects/9937/badge)](https://www.bestpractices.dev/projects/9937) [![OpenSSF Scorecard](https://api.scorecard.dev/projects/github.com/kubeflow/hub/badge)](https://scorecard.dev/viewer/?uri=github.com/kubeflow/hub) -Kubeflow Hub (formerly known as Model Registry) provides a central repository for model developers to store and manage models, versions, and artifacts metadata. +Kubeflow Hub is an umbrella project including the **Model Registry**, which provides a central repository for model developers to store and manage models, versions, and artifact metadata; and the **[Catalog](catalog/README.md)**, which enables federated discovery across external catalogs. + +The project was formerly known as Model Registry. ## Red Hat's Pledge - Red Hat drives the project's development through Open Source principles, ensuring transparency, sustainability, and community ownership. diff --git a/RELEASE.md b/RELEASE.md index b03fd531d3..ec533240bf 100644 --- a/RELEASE.md +++ b/RELEASE.md @@ -29,8 +29,8 @@ These instructions can be followed by the Maintainers with write access on the r Assuming the following remotes are setup locally: ``` -origin git@github.com:/model-registry.git (fetch) -origin git@github.com:/model-registry.git (push) +origin git@github.com:/hub.git (fetch) +origin git@github.com:/hub.git (push) upstream git@github.com:kubeflow/hub.git (fetch) upstream git@github.com:kubeflow/hub.git (push) ``` @@ -120,13 +120,13 @@ At this point, a release as been created, both the container images and the Pyth ## KF/manifests -The KF/model-registry manifests need to be sync'd to KF/manifests repository using the Manifest/Platform WG provided script (in the KF/manifests repo). +The KF/hub manifests need to be sync'd to KF/manifests repository using the Manifest/Platform WG provided script (in the KF/manifests repo). Example PR: - https://github.com/kubeflow/manifests/pull/3053 It is supposed to work by leveraging sync script in KF/manifests repo: -- https://github.com/kubeflow/manifests/blob/13a72b79e6f107118bfaeeba2bb26fc21e9244b6/scripts/synchronize-model-registry-manifests.sh#L18 +- https://github.com/pboyd/kubeflow-manifests/blob/163b45fcb55bdcbafa33a843a856a6bd96c5cecd/scripts/synchronize-hub-manifests.sh ## KF/website @@ -135,7 +135,7 @@ Update latest MR release version number in the KF/website repo. Example PR: - https://github.com/kubeflow/website/pull/4046 -Please notice the OpenAPI spec in the Reference section is automatically updated, since it is sourced from the repo: https://github.com/kubeflow/website/blob/23d50fea25adbb4883ab21ca64d19db9100390bf/content/en/docs/components/model-registry/reference/rest-api.md#L44-L47 +Please notice the OpenAPI spec in the Reference section is automatically updated, since it is sourced from the repo: https://github.com/kubeflow/website/blob/b97081e8e19a06430268e1fa9a38808f2a04cf69/content/en/docs/components/hub/reference/rest-api.md?plain=1#L44-L46 ## Anticipate prerequisites diff --git a/clients/python/README.md b/clients/python/README.md index 74b90aaf8a..60d3bd213c 100644 --- a/clients/python/README.md +++ b/clients/python/README.md @@ -5,7 +5,7 @@ [![Read the Docs](https://img.shields.io/readthedocs/model-registry)](https://model-registry.readthedocs.io/en/latest/) [![Tutorial Website](https://img.shields.io/badge/Website-green?style=plastic&label=Tutorial&labelColor=blue)](https://www.kubeflow.org/docs/components/model-registry/getting-started/) -This library provides a high level interface for interacting with a model registry server. +This is the Python SDK for the **Model Registry** component of [Kubeflow Hub](https://github.com/kubeflow/hub). It provides a high-level interface for interacting with a model registry server. > **Alpha** >