Update Central Dashboard docs for 1.9.0 (#3806)

Signed-off-by: Mathew Wicks <[email protected]>
kubeflow · Jul 17, 2024 · 38121c4 · 38121c4
1 parent f67dd9f
commit 38121c4
Show file tree

Hide file tree

Showing 17 changed files with 70 additions and 33 deletions.
diff --git a/content/en/docs/components/central-dash/customize.md b/content/en/docs/components/central-dash/customize.md
@@ -8,16 +8,23 @@ weight = 90
 
 The Kubeflow Central Dashboard provides a way to customize the menu items and integrate third-party apps.
 
-For example, the below image shows the Kubeflow Central Dashboard with a custom "My App" menu item:
+For example, the below image shows the Kubeflow Central Dashboard with a custom **"My App"** menu item:
 
-<img src="/docs/images/customize-menu-add-app.png" alt="Display third party app on a kubeflow dashboard" class="mt-3 mb-3 border border-info rounded"></img>
+<img src="/docs/images/dashboard/custom-menu-item.png" 
+     alt="Kubeflow Central Dashboard - Customize Menu Items"
+     class="mt-3 mb-3 border border-info rounded">
+</img>
 
 ## Central Dashboard ConfigMap
 
 The Kubeflow Central Dashboard is configured using a Kubernetes ConfigMap.
 
-The `CD_CONFIGMAP_NAME` environment variable on the central-dashboard Deployment specifies the name of the ConfigMap.
-By default, the ConfigMap is named `centraldashboard-config`. You can find the default ConfigMap in the [`/apps/centraldashboard/upstream/base/configmap.yaml` file of the `kubeflow/manifests`](https://github.com/kubeflow/manifests/blob/v1.8.0/apps/centraldashboard/upstream/base/configmap.yaml) repository.
+The `CD_CONFIGMAP_NAME` environment variable on the central-dashboard Deployment specifies the name of the ConfigMap (`centraldashboard-config` by default).
+
+You can find examples of the ConfigMap in the following locations:
+
+- [Default](https://github.com/kubeflow/kubeflow/blob/v1.9.0/components/centraldashboard/manifests/base/configmap.yaml)
+- [Default + KServe](https://github.com/kubeflow/kubeflow/blob/v1.9.0/components/centraldashboard/manifests/overlays/kserve/patches/configmap.yaml)
 
 ## External Links
 

diff --git a/content/en/docs/components/central-dash/overview.md b/content/en/docs/components/central-dash/overview.md
@@ -21,7 +21,10 @@ Some core features of the central dashboard include:
 
 Here is a screenshot of the Kubeflow Central Dashboard:
 
-<img src="/docs/images/central-ui.png" alt="Kubeflow central UI" class="mt-3 mb-3 border border-info rounded"></img>
+<img src="/docs/images/dashboard/homepage.png" 
+     alt="Kubeflow Central Dashboard - Homepage" 
+     class="mt-3 mb-3 border border-info rounded">
+</img>
 
 ## Navigation
 
@@ -33,38 +36,46 @@ Here is a list of the main pages, grouped by component.
 
 The following sections are available in all Kubeflow deployments:
 
-- **Home**: landing page for the Kubeflow Central Dashboard
-- **Manage Contributors**: manage contributors for the current profile/namespace
+- **Home**: landing page for Kubeflow Central Dashboard
+- **Manage Contributors**: manage contributors of profiles (namespaces) that you own
 
 ### Kubeflow Notebooks
 
 The following sections are available when [Kubeflow Notebooks](/docs/components/notebooks/) is installed:
 
 - **Notebooks**: manage Kubeflow Notebooks
+- **TensorBoards**: manage TensorBoard instances
 - **Volumes**: manage Kubernetes PVC Volumes
 
-### Kubeflow Pipelines
-
-The following sections are available when [Kubeflow Pipelines](/docs/components/pipelines/) is installed:
-
-- **Experiments (KFP)**: manage KFP experiments
-- **Runs**: manage KFP runs
-- **Recurring Runs**: To manage KFP recurring runs
-- **Pipelines**: manage KFP pipelines
-- **Artifacts**: track ML Metadata (MLMD) artifacts
-- **Executions**: track various component executions in MLMD
-
-### Katib
+### Kubeflow Katib
 
 The following sections are available when [Katib](/docs/components/katib/) is installed:
 
-- **Experiments (AutoML)**: manage Katib experiments
+- **Katib Experiments**: manage Katib AutoML experiments
 
 ### KServe
 
 The following sections are available when [KServe](/docs/external-add-ons/kserve/) is installed:
 
-- **Models**: manage deployed KServe models
+- **KServe Endpoints**: manage deployed KServe model endpoints
+
+### Kubeflow Pipelines
+
+When [Kubeflow Pipelines](/docs/components/pipelines/) is installed, you can select **Pipelines** from the sidebar:
+
+<img src="/docs/images/dashboard/pipelines-runs.png" 
+     alt="Kubeflow Central Dashboard - Pipelines - Runs" 
+     class="mt-3 mb-3 border border-info rounded">
+</img>
+
+In the **Pipelines** section, you can access the following pages:
+
+- **Pipelines**: manage pipeline definitions
+- **Experiments**: manage pipeline experiments
+- **Runs**: manage pipeline runs
+- **Recurring Runs**: manage recurring pipeline runs
+- **Artifacts**: track artifacts produced by pipelines stored in MLMD
+- **Executions**: track executions of pipeline components stored in MLMD
 
 ## Next steps
 

diff --git a/content/en/docs/components/central-dash/profiles.md b/content/en/docs/components/central-dash/profiles.md
@@ -14,12 +14,15 @@ Profiles and their child Namespaces are reconciled by the [Kubeflow Profile Cont
 
 ## Central Dashboard
 
-You can select the active profile from the top bar on the Kubeflow Central Dashboard.
-Users can only see profiles to which they have owner, modify, or view access.
-
+Select the active profile with the drop-down found in the top bar of Kubeflow Central Dashboard.
 Most Kubeflow components use the active profile to determine which resources to display, and what permissions to grant.
 
-<img src="/docs/images/select-profile.png" alt="Select active profile" class="mt-3 mb-3 border border-info rounded"></img>
+Users can only see profiles to which they have owner, contributor (read + write), or viewer (read) access.
+
+<img src="/docs/images/dashboard/homepage-profile-selector.png" 
+     alt="Kubeflow Central Dashboard - Profile Selector" 
+     class="mt-3 mb-3 border border-info rounded">
+</img>
 
 ## Automatic Profile Creation
 
@@ -42,11 +45,19 @@ Here is an example of the automatic profile creation flow:
 
 1. A new user logs into Kubeflow for the first time:
 
-<img src="/docs/images/auto-profile1-crop.png" alt="Automatic profile creation step 1" class="mt-3 mb-3 border border-info rounded" style="width: 100%; max-width: 30em"></img>
+<img src="/docs/images/dashboard/auto-profile-step-1.png"
+     alt="Kubeflow Central Dashboard - Automatic Profile Creation - Step 1"
+     class="mt-3 mb-3 border border-info rounded"
+     style="width: 100%; max-width: 30em">
+</img>
 
 2. The user can name their profile and click *Finish*: 
 
-<img src="/docs/images/auto-profile2.png" alt="Automatic profile creation step 2" class="mt-3 mb-3 border border-info rounded" style="width: 100%; max-width: 30em"></img>
+<img src="/docs/images/dashboard/auto-profile-step-2.png"
+     alt="Kubeflow Central Dashboard - Automatic Profile Creation - Step 2"
+     class="mt-3 mb-3 border border-info rounded"
+     style="width: 100%; max-width: 30em">
+</img>
 
 ## Profile Resources
 
@@ -153,11 +164,18 @@ To add contributors with "view" access, you must use the [manual method](#manage
 
 The __owner__ of a profile can use the __Manage Contributors__ tab in the Kubeflow Central Dashboard to add or remove contributors.
 
-<img src="/docs/images/multi-user-contributors.png" alt="Manage Contributors in Profiles" class="mt-3 mb-3 border border-info rounded"></img>
+<img src="/docs/images/dashboard/homepage-manage-contributors.png" 
+     alt="Kubeflow Central Dashboard - Manage Contributors Link"
+     class="mt-3 mb-3 border border-info rounded">
+</img>
 
 Contributors are managed with the "Contributors to your namespace" field.
 
-<img src="/docs/images/add-contributors.png" alt="Add Contributors" class="mt-3 mb-3 border border-info rounded"></img>
+<img src="/docs/images/dashboard/manage-contributors.png" 
+     alt="Kubeflow Central Dashboard - Manage Contributors"
+     class="mt-3 mb-3 border border-info rounded"
+     style="width: 100%; max-width: 40em">
+</img>
 
 ### Manage Contributors Manually
 

diff --git a/content/en/docs/images/add-contributors.png b/content/en/docs/images/add-contributors.png
diff --git a/content/en/docs/images/central-ui.png b/content/en/docs/images/central-ui.png
diff --git a/...ent/en/docs/images/auto-profile1-crop.png → .../images/dashboard/auto-profile-step-1.png b/...ent/en/docs/images/auto-profile1-crop.png → .../images/dashboard/auto-profile-step-1.png
diff --git a/content/en/docs/images/auto-profile2.png → .../images/dashboard/auto-profile-step-2.png b/content/en/docs/images/auto-profile2.png → .../images/dashboard/auto-profile-step-2.png
diff --git a/content/en/docs/images/dashboard/custom-menu-item.png b/content/en/docs/images/dashboard/custom-menu-item.png
diff --git a/content/en/docs/images/dashboard/homepage-manage-contributors.png b/content/en/docs/images/dashboard/homepage-manage-contributors.png
diff --git a/content/en/docs/images/dashboard/homepage-profile-selector.png b/content/en/docs/images/dashboard/homepage-profile-selector.png
diff --git a/content/en/docs/images/dashboard/homepage.png b/content/en/docs/images/dashboard/homepage.png
diff --git a/content/en/docs/images/dashboard/manage-contributors.png b/content/en/docs/images/dashboard/manage-contributors.png
diff --git a/content/en/docs/images/dashboard/pipelines-runs.png b/content/en/docs/images/dashboard/pipelines-runs.png
diff --git a/content/en/docs/images/manage-contributors.png b/content/en/docs/images/manage-contributors.png
diff --git a/content/en/docs/images/multi-user-contributors.png b/content/en/docs/images/multi-user-contributors.png
diff --git a/content/en/docs/images/select-profile.png b/content/en/docs/images/select-profile.png
diff --git a/content/en/docs/started/architecture.md b/content/en/docs/started/architecture.md
@@ -114,11 +114,12 @@ Kubeflow and to build and run your ML workflows on Kubeflow.
 
 ### Kubeflow User Interface (UI)
 
-The Kubeflow UI looks like this:
+The Kubeflow Central Dashboard looks like this:
 
-<img src="/docs/images/central-ui.png" 
-  alt="The Kubeflow UI"
-  class="mt-3 mb-3 border border-info rounded">
+<img src="/docs/images/dashboard/homepage.png" 
+     alt="Kubeflow Central Dashboard - Homepage" 
+     class="mt-3 mb-3 border border-info rounded">
+</img>
 
 The Kubeflow Platform includes [Kubeflow Central Dashboard](/docs/components/central-dash/overview/)
 which acts as a hub for your ML platform and tools by exposing the UIs of components running in the