gitpod-io / gitpod-io/gitpod

Improve paused prebuilds alert

Open
#14,294 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

component: dashboard feature: prebuilds meta: never-stale team: webapp type: improvement
Dominant language
TypeScript
Stars
13.8k
Forks
1.4k
Avg merge
17h 58m
Merged PRs (30d)
5

Description

Problem to solve

Following up from https://github.com/gitpod-io/gitpod/pull/14081, the new paused prebuilds alert successfully informs users about this system change and provides an action to resolve the alert.

However, there are a couple of issues that come with the current approach:

  1. The paused prebuilds alert is not visible in the prebuilds page, which is the most relevant page for this message.
  2. The latest prebuild information on the project card is accurate, but possibly irrelevant and not useful.
  3. Clicking the action (link button) to resume prebuilds, breaks the layout of the alert message, keeps the alert on visible, is updating the link color to be the same as the rest of the alert message, etc.

See also relevant discussion (internal). Cc @AlexTugarev @jldec

Branches (project default page) Prebuilds Project Resuming Prebuilds
paused-1 paused-2 Screenshot 2022-10-31 at 5 22 41 PM Screenshot 2022-10-31 at 5 33 29 PM copy
Proposal

TBD (To be discussed)

In the meantime, here are two approaches to consider doing as minimal viable changes (MVCs):

🅰️ Move the alert to the top of the prebuilds list as an in-page alert.
- This way, we lower the risk of running into seeing multiple alerts racing for user's attention (see local preview alert[1], usage limit alert[2], etc)

🅱️ Move the alert to the top of the branches and prebuilds page.
- This is one of the most critical system status messages for a project in Gitpod, and moving this to the top of the page provides better visibility of system status.

In both cases 🅰️/🅱️, there's no need to maintain the trigger state inside the alert when resuming prebuilds. Instead, we could a) redirect to project prebuilds and b) populate the prebuilds list with the newly triggered prebuild as user feedback.

Other things to consider for next iterations include updating the project card so that the prebuilds paused state is also visible from the team page where all projects are listed. ➰

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reviewing PR #14081 and the paused prebuilds alert on the prebuilds page, then compare the linked screenshots with the current behavior. Resolve which proposed alert placement and resume flow should be used before implementation. Done means the alert is visible in the relevant prebuilds context, its action preserves the layout, and the resulting prebuild state is clear to the user.

Written by the indexing model from the issue text.

Assessment

Tech stack
typescript
Domain
frontend
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.