Improve Verbiage and Next Steps When Workspace Process Has Trouble Using a Container Image Specified in .gitpod.yml
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 13.8k
- Forks
- 1.4k
- Avg merge
- 17h 58m
- Merged PRs (30d)
- 5
Description
Is your feature request related to a problem? Please describe
When a user has specified a container image to use for their workspace within their repositories .gitpod.yml file and the image either doesn't exist, requires some sort of authentication to access, or there's some other issue that prevents it from being used we show a rather generic error message. On the page which displays this error message we also advise the customer to contact support which generally results in support telling them the issue isn't on our end.
Describe the behaviour you'd like
I believe there's an opportunity for improvements on this page when this issue occurs.
- We should see if it's possible to determine what the exact error is and display that (fall back with a generic message like we have now).
- We should show the user which image is trying to be used and advise them to check and make sure the image exists and is publicly accessible (if that's one of our requirements).
- Provide a link to our documentation on how to use other images for their workspaces.
- Advise them if they've done all of the above to contact support.
Describe alternatives you've considered
N/A
Additional context
This was brought to my attention in a recently submitted support ticket in Front (cnv_jkpb0p6).
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by tracing the workspace error page and the handling of the image specified in .gitpod.yml. Check the linked container-image documentation for required image access rules; done means the page reports the available failure detail, identifies the requested image, links to the documentation, and gives appropriate support guidance.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- docker
- Domain
- cloud, developer-experience
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100