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

Signed-off-by: Jenny <32821331+jenny-s51@users.noreply.github.com>

Changes to step descriptions based on feedback
This commit is contained in:
Jenny 2025-07-04 10:36:19 -04:00 committed by Bhakti Narvekar
parent 23fed9c9a9
commit c6e81c2a77
1 changed files with 9 additions and 4 deletions

View File

@ -9,6 +9,7 @@ import {
ProgressStep, ProgressStep,
ProgressStepper, ProgressStepper,
Stack, Stack,
StackItem,
} from '@patternfly/react-core'; } from '@patternfly/react-core';
import useGenericObjectState from '~/app/hooks/useGenericObjectState'; import useGenericObjectState from '~/app/hooks/useGenericObjectState';
import { useNotebookAPI } from '~/app/hooks/useNotebookAPI'; import { useNotebookAPI } from '~/app/hooks/useNotebookAPI';
@ -30,10 +31,12 @@ enum WorkspaceFormSteps {
} }
const stepDescriptions: { [key in WorkspaceFormSteps]?: string } = { 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]: [WorkspaceFormSteps.ImageSelection]:
'Select a workspace image and image version 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.', [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.', [WorkspaceFormSteps.Properties]: 'Configure properties for your workspace.',
}; };
@ -167,7 +170,6 @@ const WorkspaceForm: React.FC = () => {
<FlexItem> <FlexItem>
<Content> <Content>
<h1>{`${mode === 'create' ? 'Create' : 'Edit'} workspace`}</h1> <h1>{`${mode === 'create' ? 'Create' : 'Edit'} workspace`}</h1>
<p>{stepDescriptions[currentStep]}</p>
</Content> </Content>
</FlexItem> </FlexItem>
<FlexItem> <FlexItem>
@ -211,6 +213,9 @@ const WorkspaceForm: React.FC = () => {
</ProgressStepper> </ProgressStepper>
</FlexItem> </FlexItem>
</Flex> </Flex>
<StackItem>
<p>{stepDescriptions[currentStep]}</p>
</StackItem>
</Stack> </Stack>
</PageSection> </PageSection>
</PageGroup> </PageGroup>