From 218eff78a60ac5ae192fb673c0797b69fd47124d Mon Sep 17 00:00:00 2001 From: Mathew Wicks <5735406+thesuperzapper@users.noreply.github.com> Date: Tue, 5 Dec 2023 13:47:33 -0800 Subject: [PATCH 1/5] add distribution name notice on "installing kubeflow" --- assets/scss/_styles_project.scss | 12 +++++++ .../en/docs/started/installing-kubeflow.md | 32 +++++++++++-------- 2 files changed, 31 insertions(+), 13 deletions(-) diff --git a/assets/scss/_styles_project.scss b/assets/scss/_styles_project.scss index edcb68f258..fb7c333a5b 100644 --- a/assets/scss/_styles_project.scss +++ b/assets/scss/_styles_project.scss @@ -285,6 +285,18 @@ footer { } } +// -------------------------------------------------- +// Installing Kubeflow page +// -------------------------------------------------- +.distributions-table-active thead { + background-color: $primary; + color: $secondary; +} + +.distributions-table-legacy thead { + background-color: $info; +} + // -------------------------------------------------- // 404 page // -------------------------------------------------- diff --git a/content/en/docs/started/installing-kubeflow.md b/content/en/docs/started/installing-kubeflow.md index 2b92081bdf..72f26aedd0 100644 --- a/content/en/docs/started/installing-kubeflow.md +++ b/content/en/docs/started/installing-kubeflow.md @@ -20,19 +20,27 @@ There are two pathways to get up and running with Kubeflow, you may either: ## Packaged Distributions of Kubeflow -{{% alert title="Note" color="warning" %}} -Packaged distributions are developed and supported by their respective maintainers, the Kubeflow community does not endorse or certify any specific distribution. +{{% alert title="Conformance and Certification" color="warning" %}} +Packaged distributions are developed and supported by their respective maintainers. +The Kubeflow community does not endorse or certify any specific distribution. In the near future, there are plans to introduce conformance testing for distributions, you may track progress on this initiative by following kubeflow/kubeflow#6485. {{% /alert %}} +{{% alert title="Distribution Names" color="info" %}} +Some distributions have names like `Kubeflow on `. +Please note, they are not the "official installation method" for Kubeflow on that platform, it is simply the name of a distribution. + +There are discussions about renaming these distributions to avoid confusion with others that may be available on the same platform. +{{% /alert %}} + ### Active Distributions -The following table lists active distributions that have had a recent release (within the last 6 months). +The following table lists active distributions that are currently maintained by their respective maintainers. -
+
- + @@ -68,7 +76,6 @@ The following table lists active distributions that have had a recent 1.7.0 [Release Notes] - @@ -164,11 +171,11 @@ The following table lists active distributions that have had a recent ### Legacy Distributions -The following table lists legacy distributions which have not had a recent release (within the last 6 months). +The following table lists legacy distributions which have not had a recent release (within the last 6 months), or whose maintainers have indicated that they are no longer actively maintaining the distribution. -
+
Name Maintainer
Kubeflow on Google Cloud Google Cloud
- + @@ -231,14 +238,13 @@ The following table lists legacy distributions which have not had a re {{% alert title="Warning" color="warning" %}} This method is for advanced users. - The Kubeflow community is not able to provide support for environment-specific issues when using the raw manifests. If you need support, please consider using a [packaged distribution](#packaged-distributions-of-kubeflow). {{% /alert %}} -The raw Kubeflow manifests are aggregated by the Manifests Working Group -and are intended to be used as the base of packaged distributions, -advanced users may choose to install the manifests directly by following these instructions. +The raw kubeflow/manifests are aggregated by the Manifests Working Group +and are intended to be used as the base of packaged distributions. +However, advanced users that are willing to make manual patches may choose to install the manifests directly by following these instructions. ## Next steps From 2fbd31aa7253a0ecf8847996f31d9e1ac5fea1f0 Mon Sep 17 00:00:00 2001 From: Mathew Wicks <5735406+thesuperzapper@users.noreply.github.com> Date: Tue, 6 Feb 2024 10:14:46 -0800 Subject: [PATCH 2/5] update distribution name notice --- content/en/docs/started/installing-kubeflow.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/en/docs/started/installing-kubeflow.md b/content/en/docs/started/installing-kubeflow.md index 72f26aedd0..94beb9ed00 100644 --- a/content/en/docs/started/installing-kubeflow.md +++ b/content/en/docs/started/installing-kubeflow.md @@ -29,7 +29,7 @@ In the near future, there are plans to introduce `. -Please note, they are not the "official installation method" for Kubeflow on that platform, it is simply the name of a distribution. +Please note, they are __not__ the only way to use Kubeflow on that platform, it is simply the name of a distribution. There are discussions about renaming these distributions to avoid confusion with others that may be available on the same platform. {{% /alert %}} From 4052ece79c076424c733e9c9c9e91f020ee81025 Mon Sep 17 00:00:00 2001 From: Mathew Wicks <5735406+thesuperzapper@users.noreply.github.com> Date: Tue, 20 Feb 2024 12:06:09 -0800 Subject: [PATCH 3/5] update "raw manifests" wording and add intro heading --- .../en/docs/started/installing-kubeflow.md | 39 +++++++++++++------ 1 file changed, 27 insertions(+), 12 deletions(-) diff --git a/content/en/docs/started/installing-kubeflow.md b/content/en/docs/started/installing-kubeflow.md index 94beb9ed00..76c2007cb4 100644 --- a/content/en/docs/started/installing-kubeflow.md +++ b/content/en/docs/started/installing-kubeflow.md @@ -5,21 +5,27 @@ weight = 20 +++ +### What is Kubeflow? + Kubeflow is an end-to-end Machine Learning (ML) platform for Kubernetes, it provides components for each stage in the ML lifecycle, from exploration through to training and deployment. Operators can choose what is best for their users, there is no requirement to deploy every component. -To read more about the components and architecture of Kubeflow, please see the Kubeflow Architecture page. + +Learn more about Kubeflow on the [Introduction](/docs/started/introduction/) and [Architecture](/docs/started/architecture/) pages. ### How to install Kubeflow? -There are two pathways to get up and running with Kubeflow, you may either: +Anywhere you are running Kubernetes, you should be able to run Kubeflow. +There are two primary ways to install Kubeflow: -1. [Use a packaged distribution](#packaged-distributions-of-kubeflow) -2. [Use the raw manifests](#raw-kubeflow-manifests) (for advanced users) +1. [__Packaged Distributions__](#packaged-distributions-of-kubeflow) (recommended) +2. [__Raw Manifests__](#raw-kubeflow-manifests) (advanced users) ## Packaged Distributions of Kubeflow +Packaged distributions are maintained by various organizations and typically aim to provide a simplified installation and management experience for Kubeflow. + {{% alert title="Conformance and Certification" color="warning" %}} Packaged distributions are developed and supported by their respective maintainers. The Kubeflow community does not endorse or certify any specific distribution. @@ -28,7 +34,7 @@ In the near future, there are plans to introduce `. +Some packaged distributions have names like `Kubeflow on `. Please note, they are __not__ the only way to use Kubeflow on that platform, it is simply the name of a distribution. There are discussions about renaming these distributions to avoid confusion with others that may be available on the same platform. @@ -36,7 +42,7 @@ There are discussions about renaming these distributions to avoid confusion with ### Active Distributions -The following table lists active distributions that are currently maintained by their respective maintainers. +The following table lists active distributions which are currently maintained by their respective maintainers.
Name Maintainer
@@ -236,16 +242,25 @@ The following table lists legacy distributions which have n ## Raw Kubeflow Manifests +The raw Kubeflow Manifests are aggregated by the [Manifests Working Group](https://github.com/kubeflow/community/tree/master/wg-manifests) +and are intended to be used as the __base of packaged distributions__. + +Very advanced users may choose to install the manifests for a specific Kubeflow version by following the instructions in the `README` in the [`kubeflow/manifests`](https://github.com/kubeflow/manifests) repository. + +- [__Kubeflow 1.8:__](/docs/releases/kubeflow-1.8/) + - [`v1.8-branch`](https://github.com/kubeflow/manifests/tree/v1.8-branch#installation) (development branch) + - [`v1.8.0`](https://github.com/kubeflow/manifests/tree/v1.8.0#installation) +- [__Kubeflow 1.7:__](/docs/releases/kubeflow-1.7/) + - [`v1.7-branch`](https://github.com/kubeflow/manifests/tree/v1.7-branch#installation) (development branch) + - [`v1.7.0`](https://github.com/kubeflow/manifests/tree/v1.7.0#installation) + {{% alert title="Warning" color="warning" %}} -This method is for advanced users. -The Kubeflow community is not able to provide support for environment-specific issues when using the raw manifests. +Kubeflow is a complex system with many components and dependencies, using the raw manifests requires a deep understanding of Kubernetes, Istio, and Kubeflow itself. + +When using the raw manifests, the Kubeflow community is not able to provide support for environment-specific issues or custom configurations. If you need support, please consider using a [packaged distribution](#packaged-distributions-of-kubeflow). {{% /alert %}} -The raw kubeflow/manifests are aggregated by the Manifests Working Group -and are intended to be used as the base of packaged distributions. -However, advanced users that are willing to make manual patches may choose to install the manifests directly by following these instructions. - ## Next steps From 3fd0a3d941a59a83d908b8999ea15e3f19fd7130 Mon Sep 17 00:00:00 2001 From: Mathew Wicks <5735406+thesuperzapper@users.noreply.github.com> Date: Tue, 20 Feb 2024 12:19:17 -0800 Subject: [PATCH 4/5] small typo --- content/en/docs/started/installing-kubeflow.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/en/docs/started/installing-kubeflow.md b/content/en/docs/started/installing-kubeflow.md index 76c2007cb4..5e8f5d067b 100644 --- a/content/en/docs/started/installing-kubeflow.md +++ b/content/en/docs/started/installing-kubeflow.md @@ -245,7 +245,7 @@ The following table lists legacy distributions which have n The raw Kubeflow Manifests are aggregated by the [Manifests Working Group](https://github.com/kubeflow/community/tree/master/wg-manifests) and are intended to be used as the __base of packaged distributions__. -Very advanced users may choose to install the manifests for a specific Kubeflow version by following the instructions in the `README` in the [`kubeflow/manifests`](https://github.com/kubeflow/manifests) repository. +Very advanced users may choose to install the manifests for a specific Kubeflow version by following the instructions in the `README` of the [`kubeflow/manifests`](https://github.com/kubeflow/manifests) repository. - [__Kubeflow 1.8:__](/docs/releases/kubeflow-1.8/) - [`v1.8-branch`](https://github.com/kubeflow/manifests/tree/v1.8-branch#installation) (development branch) From 18d610f8e2e0874457456ce995636e472ab3bf15 Mon Sep 17 00:00:00 2001 From: Mathew Wicks <5735406+thesuperzapper@users.noreply.github.com> Date: Tue, 20 Feb 2024 15:38:09 -0800 Subject: [PATCH 5/5] updates from suggestions --- content/en/docs/started/installing-kubeflow.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/content/en/docs/started/installing-kubeflow.md b/content/en/docs/started/installing-kubeflow.md index 5e8f5d067b..bd26aac069 100644 --- a/content/en/docs/started/installing-kubeflow.md +++ b/content/en/docs/started/installing-kubeflow.md @@ -17,7 +17,7 @@ Learn more about Kubeflow on the [Introduction](/docs/started/introduction/) and Anywhere you are running Kubernetes, you should be able to run Kubeflow. There are two primary ways to install Kubeflow: -1. [__Packaged Distributions__](#packaged-distributions-of-kubeflow) (recommended) +1. [__Packaged Distributions__](#packaged-distributions-of-kubeflow) 2. [__Raw Manifests__](#raw-kubeflow-manifests) (advanced users) @@ -255,7 +255,8 @@ Very advanced users may choose to install the manifests for a specific Kubeflow - [`v1.7.0`](https://github.com/kubeflow/manifests/tree/v1.7.0#installation) {{% alert title="Warning" color="warning" %}} -Kubeflow is a complex system with many components and dependencies, using the raw manifests requires a deep understanding of Kubernetes, Istio, and Kubeflow itself. +Kubeflow is a complex system with many components and dependencies. +Using the raw manifests requires a deep understanding of Kubernetes, Istio, and Kubeflow itself. When using the raw manifests, the Kubeflow community is not able to provide support for environment-specific issues or custom configurations. If you need support, please consider using a [packaged distribution](#packaged-distributions-of-kubeflow).