Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

In-workspace onboarding v2 #5964

Closed
mikenikles opened this issue Sep 30, 2021 · 11 comments
Closed

In-workspace onboarding v2 #5964

mikenikles opened this issue Sep 30, 2021 · 11 comments
Assignees

Comments

@mikenikles
Copy link
Contributor

In gitpod-io/openvscode-server#110, we released v1 of the in-workspace onboarding.

As a follow-up, here are some ideas.

Change the look & feel to match what VS Code does

Screenshot

In particular, use each step's description to provide the content. Note, this is very limited in terms of content length compared to the Markdown files we currently use.
As the content on the right, we'd use an image to explain each step.

Provide more dynamic onboarding

We could use a step's when clause to provide onboarding steps that are tailored to a given project. For example, if we detect that a project does not have prebuilds configured, we could provide a button to automatically enable prebuilds whereas someone who already uses prebuilds doesn't need to see that.

@JohannesLandgraf
Copy link
Contributor

JohannesLandgraf commented Sep 30, 2021

Excellent work with v1 @mikenikles! I really like the tone of it. Some small suggestions for improvement:

  • At the end of each section add a 'Next button' to move e.g. from 'What is Gitpod?' to 'Prebuilds do the heavy lifting'
  • For the CTAs (click here for e.g. the docker command, open ports) kumquat coloured buttons will work better
    • Enabled kumquat colours for the Gitpod Light (default) & Gitpod Dark themes.
      Screenshots
      LightDark
  • Describe in 'Full access to a terminal' the shortcut how to open one (or let the button ^ do all the work)
  • Include a button at the VS Code Desktop Support that does the same as Gitpod: Open in VS Code

@JohannesLandgraf
Copy link
Contributor

And another thing: I think the Get Started with Gitpod onboarding flow should replace the Welcome Tab (or open as the primary one next to the Welcome one)

@filiptronicek
Copy link
Member

  • Include a button at the VS Code Desktop Support that does the same as Gitpod: Open in VS Code

Would be great to fit a Open in VS Code: Insiders there, too!

@mikenikles
Copy link
Contributor Author

mikenikles commented Sep 30, 2021

At the end of each section add a 'Next button' to move e.g. from 'What is Gitpod?' to 'Prebuilds do the heavy lifting'
Blocked by microsoft/vscode#129735

For the CTAs (click here for e.g. the docker command, open ports) kumquat coloured buttons will work better
✅ shipped

Describe in 'Full access to a terminal' the shortcut how to open one (or let the button ^ do all the work)
👍. We have to consider operating-system dependent shortcuts. Will see what we can do.

Include a button at the VS Code Desktop Support that does the same as Gitpod: Open in VS Code
👍. Will see what's possible in v2

Get Started with Gitpod onboarding flow should replace the Welcome Tab
✅ shipped

@JohannesLandgraf
Copy link
Contributor

JohannesLandgraf commented Sep 30, 2021

That's already there if you click either of the links, unless I misunderstand what you're looking for.

What I meant is having a real button :)

@mikenikles
Copy link
Contributor Author

💡 Let's use the first step of the Gitpod onboarding walkthrough as a "What's new?" step where we highlight the most recent changelog entries.

Ideally, IMHO, the changelog is more prominent than that, but adding it to the walkthrough is better than no in-product changelog or a very limited "What's new" dialog.

@akosyakov
Copy link
Member

When should we show walk through? Right now it pops up each page reload. It's very annoying. Should we remember that a user seen it already and if does not change since then don't show it again?

@stale
Copy link

stale bot commented Jan 17, 2022

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 stale bot added the meta: stale This issue/PR is stale and will be closed soon label Jan 17, 2022
@stale stale bot closed this as completed Jan 28, 2022
@filiptronicek
Copy link
Member

I believe this should still be open, it's still a good idea to update the onboarding exp

@filiptronicek filiptronicek reopened this Jan 28, 2022
@stale stale bot removed the meta: stale This issue/PR is stale and will be closed soon label Jan 28, 2022
@mikenikles
Copy link
Contributor Author

Thanks Filip. Yes Anton, that sounds like a sensible approach.

@stale
Copy link

stale bot commented May 31, 2022

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 stale bot added the meta: stale This issue/PR is stale and will be closed soon label May 31, 2022
@stale stale bot closed this as completed Jun 19, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

4 participants