kubeflow / website

Kubeflow's public website
Creative Commons Attribution 4.0 International
146 stars 764 forks source link

update architecture page on kubeflow.org #3536

Closed jbottum closed 2 months ago

jbottum commented 1 year ago

The current Kubeflow architecture diagram on Kubeflow.org is out of date: https://www.kubeflow.org/docs/started/architecture/

kubeflow-overview-platform-diagram

Proposal:

  1. This diagram should be updated.
  2. The updated diagram could be re-used in multiple places i.e. kubeflow.org, github repo (manifest), what is Kubeflow slide deck.
  3. The diagram and its description should be consistent when used on kubeflow.org, the manifest repo, and the slide deck
  4. We should remove chainer from ML Tools
  5. We should change contrib to add-ons Kubeflow github uses contrib, and Kubeflow.org uses add-ons. kubeflow.org uses other terms. https://github.com/kubeflow/manifests (apps, common, contrib) https://www.kubeflow.org/docs/components/ (components, SHOULD THIS BE CHANGED FROM COMPONENTS TO APPS) https://www.kubeflow.org/docs/external-add-ons/ (add-ons)

6.Kubeflow applications and scaffolding need an extensive re-write to match apps and common names in manifest github repo, https://github.com/kubeflow/manifests

DO WE WANT THE NAMES IN THE REPO TO MATCH THE WEBSITE EXACTLY? IF NOT, WHAT DO WE EXCLUDE ON THE WEBSITE. (see list from repo below...which use the term COMPONENT RATHER THAN APPS.

Screenshot 2023-06-29 at 2 09 45 PM

see 2nd list from repo below for Common, which also uses the term COMPONENT

Screenshot 2023-06-29 at 2 10 00 PM

Other a. We might want to consider a way to minimize the info and updates on kubeflow.org b. We might want to drive users to the github manifest repo for current updates. We could then focus on updating info on the github repo.

Related - Julius has provided this diagram on Kubeflow, which is a good technical diagram but not a replacement for the existing diagram on kubefllow.org. still, we figure out if/how we can use it (see page 8). https://kccnceu2023.sched.com/event/1HyY8

@akgraner @juliusvonkohout @kimwnasptd @annajung