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

Setup-focused getting started walkthrough #588

Conversation

digitarald
Copy link
Contributor

Posting these ideas for the shape of Java's walkthrough. I'd love feedback on this approach and expanding on it further:

Outcome:

  • Moving setup steps first avoids popping them up for all users, while ensuring that they come out of the walkthrough with a fully working setup
  • Use when clauses
  1. Added the runtime and extension setup as first steps.
    • Further potential: Java extension could provide a when clause that only shows the runtime step when no JDK was detected
  2. Added a when clause to only show open folder when workspace doesn't have a folder open.
    • Further potential: Other when clauses could further be used for contextual tasks, like detecting Springboard in a project and recommending the extension.

Feel free to try it out. Meanwhile, I am working on recording this to help with feedback.

If we think this direction works well, I would spend more time on polishing the copy.

@@ -121,6 +147,19 @@
"path": "walkthrough/testing.png",
"altText": "Testing"
}
},

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@digitarald java getting started page will be opened on the top of welcome page? I think better to be opened on the right hand side. also, a good demo for side-by-side view.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Correct, this is on the list for this release to allow. In my testing, the current Java Tools welcome page does not trigger any side by side views, so I would not block on this.

@digitarald
Copy link
Contributor Author

@yaojinyang @Eskibear recorded a demo of the latest code with a side-by-side onboarding flow:

java-walkthrough-v0.mp4

package.json Outdated
@@ -121,6 +147,19 @@
"path": "walkthrough/testing.png",
"altText": "Testing"
}
},
{
"id": "java.showTesting",
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This task is not shown possibly, because of its duplicated id. Is it on purpose?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No, an oversight from copy/pasta.

@digitarald
Copy link
Contributor Author

@yaojinyang @Eskibear are there any specific concerns or questions that need need to be addressed to move this pull request forward?

@Eskibear
Copy link
Member

@digitarald Thank you for the rephrasing and nice looking screenshots, it looks much better. I haven't merge this PR because:

  • I want to revisit as many use cases as possible, to ensure none of these steps would lead users to a dead end.
  • I was not sure whether the contribution point was finalized. Please let me know if it won't change.

Besides I don't have other concern to merge it as it's a feature branch.
Regarding to the newly added markdown support, do we also add multiple actions to better help users? @yaojinyang Or do we polish in incrementally in iterations?

@yaojinyang
Copy link

@yaojinyang @Eskibear are there any specific concerns or questions that need need to be addressed to move this pull request forward?
@digitarald I think it's good to go. We can release more improvements through future iterations. Besides @Eskibear's question, I raised another question in our Teams channel, how experience will look like for extensions added post initial VS Code installation.

@digitarald
Copy link
Contributor Author

The updated pull request has the markdown, toSide opening, and adds multiple actions for opening and creating a project.

how experience will look like for extensions added post initial VS Code installation.

A lot can be tweaked here. First step is opening the walkthrough after extension installation; next doing more complex heuristics like opening the walkthrough when the extension activates and no items have been completed yet.

Copy link
Member

@Eskibear Eskibear left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks!

@Eskibear Eskibear merged commit b03f7e4 into microsoft:getting-started-insider Apr 23, 2021
@digitarald
Copy link
Contributor Author

@Eskibear thanks for merging! What are your plans for merging https://github.com/microsoft/vscode-java-pack/tree/getting-started-insider into master, so we can start testing the content?

@Eskibear
Copy link
Member

I can always prepare a private build from this branch for testing. Or do you want me to ship it directly into marketplace?

@Eskibear
Copy link
Member

@digitarald we'll release a new version this week. As long as it doesn't affect stable version users, I think it's okay for insider users to have a test before we throughly polish these steps/use cases.

@digitarald
Copy link
Contributor Author

we'll release a new version this week

That would work, as it doesn't do anything for existing users. We could also wait to have an experimentation framework in place, that prevents the build-in Java welcome logic when VS Code has extension walkthroughs enabled.

@Eskibear
Copy link
Member

We could also wait to have an experimentation framework in place,

Do you have the timeline when it would be ready?

@digitarald
Copy link
Contributor Author

I'd plan for microsoft/vscode#122592 to land in the next iteration and we can start as soon as extensions adopted it.

Eskibear added a commit that referenced this pull request May 10, 2021
* integrated feature tour with vscode's native getting started page

Signed-off-by: Yan Zhang <[email protected]>

* update schema as gettingStartedService changed in vscode

Signed-off-by: Yan Zhang <[email protected]>

* Setup-focused getting started walkthrough (#588)

* Making walkthrough more setup focused.

* Snapper copy for walkthrough

* Added multi-button and markdown updates

* don't enable proposed API

* update Java walkthrough

Signed-off-by: Yan Zhang <[email protected]>

* fix wording

Signed-off-by: Yan Zhang <[email protected]>

Co-authored-by: Harald Kirschner <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants