-
Notifications
You must be signed in to change notification settings - Fork 66
fix(ws): Improve Workspace Creation Wizard Step Descriptions #452
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
fix(ws): Improve Workspace Creation Wizard Step Descriptions #452
Conversation
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.', |
There was a problem hiding this comment.
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.', |
There was a problem hiding this comment.
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.', |
There was a problem hiding this comment.
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
49796ad
to
5a1bd23
Compare
There was a problem hiding this 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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
/lgtm
/ok-to-test |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
/lgtm
/approve |
[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 |
…w#452) Signed-off-by: Jenny <[email protected]> Changes to step descriptions based on feedback
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:
This enhancement improves the workspace creation process by helping users understand what to select and why each step matters for their workspace setup.