Improve user experience by overcoming the common issues/questions/struggles

[axonasif]

Is your feature request related to a problem? Please describe

From my personal experience, here's what I've seen being asked the most on our Discord server and other communication channels such as github, frontapp regarding the SaaS Gitpod.io. Trying to braindump all the important points I can think of now.

1. How do I configure my project X for lang/tool Y?
   • How do change the version of Y on my workspace?

Potential solution: Have lots of useful and upto date examples on our docs and have some automation for emails, discord and elsewhere where it makes sense for suggesting docs-pages and github-issues.

Example

Related issues:

• https://github.com/gitpod-io/website/issues/2187
• Epic: Improve versioning and rollout of workspace images #10683
• https://github.com/gitpod-io/website/issues/2227
• https://github.com/gitpod-io/website/issues/2226

2. Why I can't find the tools/things I configured from .gitpod.yml tasks (assuming init task and prebuilds is enabled)

Potential solution: use custom dockerfile or before/command task, but it would be nice if we could automatically detect and warn users during prebuild for files being written outside of /workspace. Provide this info via comments on .gitpod.yml for auto-generated .gitpod.yml (related: slack discussion)

Related issues:

• Add doc page(s) for "hints and tips" for getting stuff to work with gitpod #12185

3. Why is my webapp-port/service/websocket is unreachable from program X while it works outside of Gitpod? (assuming web version of Gitpod.io VSCODE)

Potential solution: Open workspace in desktop vscode or run chrome/firefox(Example templates: flutter, keystonejs) on Gitpod. Can this somehow be detected for automatic suggestion until we improve the situation on the web-version?

Related issues:

• Expose workspace ports on external IP #459
• Epic: Improve experience using ports with Gitpod #9262
• https://github.com/gitpod-io/website/issues/2179

4. How do I :
   • alter some X file under location Y
   • install or configure tool X

for each of my workspaces

Potential solution: Utilize dotfiles and it's install.sh when necessary.
Related: Global-workspace-tailoring

5. Why isn't my workspace opening in local VSCODE, why am I getting asked for password, why can't I connect with the ssh command.

Potential solution: Make users aware of the troubleshooting tips for SSH issues. Put step by step instructions that must be followed for first-time users to better ensure that their system is properly configured before them attempting to copy-paste the ssh command.

Related issues:

• Epic: SSH key support for VS Code Desktop #8513
• Epic: Upload users SSH keys to Gitpod #9932

6. Questions about teams and plans. (related: Epic: Simplify team plans and align with project teams #7759)
7. Questions about working with configuring gitpod (related: Epic: Remove need to commit to git (Gitpod "Inner Loop") #7671)
8. Also, our template-* repos and workspace-images needs more maintenance. (Related: slack thread)
9. How do I continue my work while gitpod is having downtime/incident?

Potential solution:
Have a good local fallback(slack discussion) + let the users know of the incident during a incident when they try to open a workspace or got disconnected and provide docs link for guidance of what to do.

10. Why am I having permission issues with docker-compose on Gitpod but it doesn't happen locally on my PC?

Related discord threads:

• https://discord.com/channels/816244985187008514/816246578594840586/985927978947063839
• https://discord.com/channels/816244985187008514/816246578594840586/982597242055721000
• And there was more, can't find them by searching now....

10. Friction and confusion for making Private org repos work on Gitpod.

Users mostly feel lost about this issue, often we have to tell them to follow this doc page. Could this be somehow improved or automated?

Related issues:

• Errors working with private repos on GitHub orgs, caused by missing 3rd party access for Gitpod #8076

11. IDE is sometimes not fully loaded due to either browser config/extension or network/CORS. As a side effect, this causes other non-existent issues.

Sometimes the workaround is to try a different browser, use a VPN or open in desktop VSCODE. Could this be somehow improved so that the gets informed about how to troubleshoot it?

Related issues:

(Please add/suggest)

Describe the behaviour you'd like

We can try to eliminate the causes for most of the questions and also document the missing parts.

Describe alternatives you've considered

Additional context

cc @akosyakov @loujaybee

[loujaybee]

Some related issues, can you link/add to your description, @axonasif ?

How do change the version of Y on my workspace?

• https://github.com/gitpod-io/website/issues/2187
• Epic: Improve versioning and rollout of workspace images #10683

Why is my webapp-port/service/websocket is unreachable from program X while it works on my local dev-env? (assuming web version of Gitpod.io VSCODE)

• Epic: Improve experience using ports with Gitpod #9262
• https://github.com/gitpod-io/website/issues/2179

Why isn't my workspace opening in local VSCODE, why am I getting asked for password, why can't I connect with the ssh command.

• Epic: SSH key support for VS Code Desktop #8513
• Epic: Upload users SSH keys to Gitpod #9932

[akosyakov]

I think one idea here is to think how we can address them in product by using diagnostics/quick fixes/notifications and other IDE means. Or at least using these IDE means to bring a user attention to such thing and set them on right track by navigating to useful docs.

[axonasif]

Some related issues, can you link/add to your description, @axonasif ?

Done @loujaybee 👍

[loujaybee]

Thanks @axonasif !

A couple more...

Also, our template-* repos and workspace-images needs more maintenance.

How do I configure my project X for lang/tool Y?

• https://github.com/gitpod-io/website/issues/2227
• https://github.com/gitpod-io/website/issues/2226

[axonasif]

New entry added:

---

10. Friction and confusion for making Private org repos work on Gitpod.

Users mostly feel lost about this issue, often we have to tell them to follow this doc page. Could this be somehow improved or automated?
Related issues:

• Errors working with private repos on GitHub orgs, caused by missing 3rd party access for Gitpod #8076

cc @jldec

[axonasif]

New entry added:

---

11. IDE is sometimes not fully loaded due to either browser config/extension or network/CORS. As a side effect, this causes other non-existent issues.

Could this be somehow improved so that the gets informed about how to troubleshoot it?
Sometimes the workaround is to try a different browser, use a VPN or open in desktop VSCODE.
Related issues:
(Please add/suggest)

cc @loujaybee @akosyakov

[stale]

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

[stale]

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

[stale]

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.