Skip to content

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.

Sign up for GitHub

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

Merged
merged 1 commit into from
Jul 4, 2025
Merged

fix(ws): Improve Workspace Creation Wizard Step Descriptions #452

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 9 additions & 4 deletions workspaces/frontend/src/app/pages/Workspaces/Form/WorkspaceForm.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ import {
ProgressStep,
ProgressStepper,
Stack,
StackItem,
} from '@patternfly/react-core';
import useGenericObjectState from '~/app/hooks/useGenericObjectState';
import { useNotebookAPI } from '~/app/hooks/useNotebookAPI';
Expand All @@ -30,10 +31,12 @@ enum WorkspaceFormSteps {
}

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 for creating a workspace, which is an isolated area where you can work with models in your preferred IDE, such as Jupyter Notebook.',
[WorkspaceFormSteps.ImageSelection]:
'Select a workspace image and image version to use for the workspace.',
[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.',
[WorkspaceFormSteps.Properties]: 'Configure properties for your workspace.',
};

Expand Down Expand Up @@ -167,7 +170,6 @@ const WorkspaceForm: React.FC = () => {
<FlexItem>
<Content>
<h1>{`${mode === 'create' ? 'Create' : 'Edit'} workspace`}</h1>
<p>{stepDescriptions[currentStep]}</p>
</Content>
</FlexItem>
<FlexItem>
Expand Down Expand Up @@ -211,6 +213,9 @@ const WorkspaceForm: React.FC = () => {
</ProgressStepper>
</FlexItem>
</Flex>
<StackItem>
<p>{stepDescriptions[currentStep]}</p>
</StackItem>
</Stack>
</PageSection>
</PageGroup>
Expand Down