oxidecomputer / oxidecomputer/console

Better messaging around image upload cleanup

Open
#1,788 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

polish
Dominant language
TypeScript
Stars
228
Forks
22
Avg merge
19h 42m
Merged PRs (30d)
32

Description

Image upload requires making a disk to bulk write to, and then a snapshot, and then that's made into an image. At the end, we have the image, and we can delete the disk and snapshot.

  1. We don't explain what these cleanup steps are. It would be nice to either have a tooltip on those steps explaining why or at least link to the image upload guide, which explains it.
  2. If cleanup fails but the image got created, the user has mostly done what they came to do, so instead of getting stuck on the cleanup steps, we could say
    Done!*
    
    * Your image is uploaded but the disk and snapshot we use to make it are still hanging around. You might want to go delete them.
    

Obviously the underlying issue causing cleanup to fail is more important, but we can handle it nicely here. Thanks @jordanhendricks for the suggestion.

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 locating the image upload flow in the console and compare its cleanup steps with the linked image upload guide. The work is done when those steps explain or link to the cleanup rationale and a successful image upload reports completion clearly even if disk or snapshot cleanup fails.

Written by the indexing model from the issue text.

Assessment

Tech stack
typescript
Domain
frontend
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
62/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.