[Dashboard] Suggest using gp rebuild when image build fails

[andreafalzetti]

Description

We've recently introduced gp rebuild to help users debug their custom workspace image. In the future it will do more. We hope to reduce the number of image build failures caused by config changes that could have been caught in a workspace, before pushing.

Related Issue(s)

Relates #7671

How to test

1. Start a workspace for https://ide-gp-rebbd1841bbcb.preview.gitpod-dev.com/?workspaceClass=default&editor=code#https://github.com/andreafalzetti/gitpod-experiments/tree/imagebuild-broken
2. Observe the message educating about the use of gp rebuild underneath the logs

Release Notes

NONE

Documentation

Werft options:

• /werft with-local-preview
  If enabled this will build install/preview
• /werft with-preview
• /werft with-large-vm
• /werft with-integration-tests=all
  Valid options are all, workspace, webapp, ide, jetbrains, vscode, ssh

[andreafalzetti]

@gtsiolis I would appreciate your touch here!

Other approaches I've considered:

• using the (TIP) pill (currently used for (BETA)
• wrap eveything in a box like we do for the "unstable IDE" alert

[akosyakov]

I think custom can be dropped, a user can also use it to validate any other base image, just workspace image?

[gtsiolis]

Looking at this now! 👀

[gtsiolis]

Checked with similar approaches (see relevant discussion (internal)), our existing alert component flexibility, and similar components in the wild that could support what we want here.

UX LGTM and seems like a good skateboard! 🛹

Thanks for the ping[1], @andreafalzetti! 🏓

FWIW, I couldn't test this because I was getting the following error:

Request createWorkspace failed with message: 13 INTERNAL: cannot resolve workspace image: pulling from host eu.gcr.io failed with status code [manifests 81971a6456bed2bd0c75aa21ad46ba7932353c4f0227d22d09025deac0b573cb]: 429

Too Many Requests

Unknown Error: { "code": -32603 }

[gtsiolis]

suggestion: We could trim some text here to make it easier to parse and read. Haven't checked if linting fails with the following code suggestions. 😅

Suggested change

	<span className="font-bold">Did you know?</span> You can use <code>gp rebuild</code> to
	validate and debug your custom workspace image before pushing &nbsp;&middot;&nbsp;
	💡 You can use the <code>gp rebuild</code> command to
	validate the configuration and rebuild the workspace.

We could also skip the validation part as this could be self-explanatory, making the message even easier to read and more specific where you can use the rebuild command.

Suggested change

	<span className="font-bold">Did you know?</span> You can use <code>gp rebuild</code> to
	validate and debug your custom workspace image before pushing &nbsp;&middot;&nbsp;
	💡 You can use the <code>gp rebuild</code> command to
	rebuild the workspace from the editor terminal.

[andreafalzetti]

Thanks for the inspiration! I've updated the message, check if you like it or have more suggestions 🙏

[gtsiolis]

Looks shippable, @andreafalzetti! Here are background thoughts on the copy suggestion above, but the current state looks good for this iteration, and we can update the copy later.

1. The rebuild term was referring to the image build of the container image.
2. The workspace term was trying to communicate this is about your workspace and nothing scary like images, containers, etc which may be strange to some users.
3. The command term reference was trying to make it clear this is an actual command you have to type in a terminal or somewhere to run it.
4. The debug term was removed to make it less scary to users.
5. The editor term was used to clarify this action can happen inside an editor. Could be removed as this can happen in a terminal locally if you connect with SSH.
6. The terminal term was used to make it clear you need to type this command in a terminal and it's not something you find on the editor UI.

[andreafalzetti]

@gtsiolis for context, we'll also enable users calling gp rebuild from the UI (vscode only for now), see context, but it feels very hard compress all these info in a line. For now we can go with the "terminal" option and later once we create more generic docs on gitpod.io/docs, we can rephrase this and link there to be a generic "rebuild" feature

[gtsiolis]

Looks shippable, @andreafalzetti! Here are background thoughts on the copy suggestion above, but the current state looks good for this iteration, and we can update the copy later.

1. The rebuild term was referring to the image build of the container image.
2. The workspace term was trying to communicate this is about your workspace and nothing scary like images, containers, etc which may be strange to some users.
3. The command term reference was trying to make it clear this is an actual command you have to type in a terminal or somewhere to run it.
4. The debug term was removed to make it less scary to users.
5. The editor term was used to clarify this action can happen inside an editor. Could be removed as this can happen in a terminal locally if you connect with SSH.
6. The terminal term was used to make it clear you need to type this command in a terminal and it's not something you find on the editor UI.

[gtsiolis]

Thanks, @andreafalzetti! 🍕

Left one minor suggestion around the help link.

[svenefftinge]

I agree that the message should include something telling me where I can use gp rebuild. George's proposal sounds much better to me:

💡 You can use the gp rebuild command to rebuild the workspace from the editor terminal.

/hold

[svenefftinge]

Ups, it got merged even though I added the hold label 😬