Skip to content
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

[dashboard] Tell users prebuild is uploading #9904

Closed
wants to merge 1 commit into from

Conversation

svenefftinge
Copy link
Member

Description

Tell users that a workspace is uploading

Related Issue(s)

Fixes #

How to test

Release Notes

Documentation

@roboquat
Copy link
Contributor

@svenefftinge: Adding the "do-not-merge/release-note-label-needed" label because no release-note block was detected, please follow our release note process to remove it.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

@gtsiolis gtsiolis requested review from gtsiolis May 11, 2022 16:23
@svenefftinge svenefftinge marked this pull request as ready for review May 12, 2022 09:43
@svenefftinge svenefftinge requested a review from a team May 12, 2022 09:43
@github-actions github-actions bot added the team: webapp Issue belongs to the WebApp team label May 12, 2022
@@ -340,7 +340,7 @@ export default class StartWorkspace extends React.Component<StartWorkspaceProps,
return;
}

if (workspaceInstance.status.phase === "building" || workspaceInstance.status.phase == "preparing") {
if (workspaceInstance.status.phase === "building" || workspaceInstance.status.phase === "preparing") {
Copy link
Member

Choose a reason for hiding this comment

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

👍

Copy link
Member

@geropl geropl left a comment

Choose a reason for hiding this comment

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

👍

Copy link
Contributor

@gtsiolis gtsiolis left a comment

Choose a reason for hiding this comment

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

Thanks, @svenefftinge! 🏀

I could not test this in action due to some hiccups of the the preview environment, see relevant discussion (internal).

Left one suggestion to rephrase the title below based on our yesterday's discussion.

return (
<HeadlessWorkspaceView
instanceId={this.state.workspaceInstance.id}
title="Uploading the prebuild ..."
Copy link
Contributor

Choose a reason for hiding this comment

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

issue: Based on a recent discussion, the term uploading here is not something users have seen across the product and do not to learn about, right?

return (
<HeadlessWorkspaceView
instanceId={this.state.workspaceInstance.id}
title="Uploading the prebuild ..."
Copy link
Contributor

Choose a reason for hiding this comment

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

suggestion: Maybe we could rephrase this to something like the following as this actually prepares the prebuild for the next workspace start phase. We could also skip the ellipsis (...) as this is not used in phase titles.

Suggested change
title="Uploading the prebuild ..."
title="Preparing Prebuild"

Alternatively, we could go with:

Suggested change
title="Uploading the prebuild ..."
title="Finalizing Prebuild"

Copy link
Member Author

Choose a reason for hiding this comment

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

I find preparing and finalizing too abstract to bridge a few minutes of waiting. "Why does finalizing take so long?"

Copy link
Contributor

@gtsiolis gtsiolis May 12, 2022

Choose a reason for hiding this comment

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

Agree! The existing titles aim to abstract the sub-states of the loading cycle to make the loading friendlier to the user, that's why we're using Checking, Creating, & Starting in the rest of the workspace start phases. We're currently hijacking the same title to show Prebuild in Progress and do not group or relate the prebuild-in-progress phase with the rest of the workspace start phases.

Using the Uploading term could suffice as a sub-state and also wouldn't hurt to also use it as a title as this is already a good improvement. 🤝

Uploading as title Uploading as sub-state Preparing at title
loading-1 loading-6 loading-2

thought: We could consider 🅰️ reusing the same element from the prebuilds pages (see #9132) where we could surface these sub-states of the prebuild phase and 🅱️ providing better visibility of the step sequence as currently it's not clear if the prebuild happens before or after the rest of the workspace start phases, etc. However, this is probably out of the scope of this PR. ➿

BEFORE AFTER (Early design)
loading-0 loading-5

@svenefftinge svenefftinge marked this pull request as draft May 12, 2022 10:16
@svenefftinge
Copy link
Member Author

Turns out this was the wrong place (CreateWorkspace is correct) and also we don't get updates on the prebuild.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants