Skip to content

Conversation

jenny-s51
Copy link
Member

Closes #373

Description

This PR enhances the workspace creation wizard by providing more context for each step in the form flow.

Includes updated step descriptions for:

  • Kind Selection
  • Image Selection
  • Pod Config Selection

This enhancement improves the workspace creation process by helping users understand what to select and why each step matters for their workspace setup.

@github-project-automation github-project-automation bot moved this to Needs Triage in Kubeflow Notebooks Jun 27, 2025
@google-oss-prow google-oss-prow bot added area/frontend area - related to frontend components area/v2 area - version - kubeflow notebooks v2 labels Jun 27, 2025
const stepDescriptions: { [key in WorkspaceFormSteps]?: string } = {
[WorkspaceFormSteps.KindSelection]: 'Select a workspace kind to use for the workspace.',
[WorkspaceFormSteps.KindSelection]:
'A workspace kind is a template that creates an isolated area where you can work with models in your preferred IDE, such as a Jupyter notebook.',
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

isolated area

that isolated area is to be called a workspace, maybe this information can be weaved into it somehow too?

const stepDescriptions: { [key in WorkspaceFormSteps]?: string } = {
[WorkspaceFormSteps.KindSelection]: 'Select a workspace kind to use for the workspace.',
[WorkspaceFormSteps.KindSelection]:
'A workspace kind is a template that creates an isolated area where you can work with models in your preferred IDE, such as a Jupyter notebook.',
Copy link
Member

@jiridanek jiridanek Jun 27, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

your preferred IDE, such as a Jupyter notebook

this is not wrong, but I'd prefer to say "such as Jupyter Notebook" (leave out the a), or "such as JupyterLab". What do you all think?

[WorkspaceFormSteps.PodConfigSelection]: 'Select a pod config to use for the workspace.',
'Select a workspace image and image version to use for the workspace. A workspace image is a container image that contains the software and dependencies needed to run a workspace.',
[WorkspaceFormSteps.PodConfigSelection]:
'Select a pod config to use for the workspace. A pod config is a configuration that defines the resources and settings for a workspace pod.',
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

for a workspace pod

maybe leave out pod?

Signed-off-by: Jenny <[email protected]>

Changes to step descriptions based on feedback
@jenny-s51 jenny-s51 force-pushed the add-step-1-context branch from 49796ad to 5a1bd23 Compare July 2, 2025 14:10
Copy link
Member Author

@jenny-s51 jenny-s51 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you @jiridanek for your review! Appreciate your feedback, and these are great points. Updated to reflect your suggestions.

@jenny-s51 jenny-s51 requested a review from jiridanek July 2, 2025 14:12
Copy link

@paulovmr paulovmr left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

/lgtm

@paulovmr
Copy link

paulovmr commented Jul 2, 2025

/ok-to-test

Copy link
Member

@ederign ederign left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

/lgtm

@ederign
Copy link
Member

ederign commented Jul 4, 2025

/approve

Copy link

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: ederign

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@google-oss-prow google-oss-prow bot merged commit 063d533 into kubeflow:notebooks-v2 Jul 4, 2025
8 checks passed
@github-project-automation github-project-automation bot moved this from Needs Triage to Done in Kubeflow Notebooks Jul 4, 2025
bhaktinarvekar pushed a commit to bhaktinarvekar/notebooks that referenced this pull request Sep 14, 2025
…w#452)

Signed-off-by: Jenny <[email protected]>

Changes to step descriptions based on feedback
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

approved area/frontend area - related to frontend components area/v2 area - version - kubeflow notebooks v2 lgtm ok-to-test size/S

Projects

Archived in project

Development

Successfully merging this pull request may close these issues.

4 participants