Getting started walkthrough for data scientists #8733

minsa110 · 2022-01-19T18:06:50Z

For https://github.com/microsoft/vscode-jupyter-internal/issues/243

Pull request represents a single change (i.e. not fixing disparate/unrelated things in a single PR).
Title summarizes what is changing.
Has a news entry file (remember to thank yourself!).
Appropriate comments and documentation strings in the code.
Has sufficient logging.
Has telemetry for enhancements.
Unit tests & system/integration tests are added/updated.
Test plan is updated as appropriate.
package-lock.json has been regenerated by running npm install (if dependencies have changed).

rchiodo · 2022-01-19T20:52:55Z

package.json

+                "id": "jupyterWelcome",
+                "title": "Get started with Jupyter Notebooks",
+                "description": "Your first steps to set up a Jupyter project with all the powerful tools and features that the Jupyter extension has to offer!",
+                "when": "false",


when: false? Does this mean it doesn't show up?

Yep, by default it's turned off. The experiment turns it on for folks:

vscode.gettingStarted.overrideCategory.ms-toolsai.jupyter.jupyterWelcome.when:workspacePlatform != webworker

rchiodo · 2022-01-19T20:53:53Z

package.json

        "tslint-plugin-prettier": "^2.1.0",
        "typemoq": "^2.1.0",
-        "typescript": "^4.4.3",
+        "typescript": "^4.5.4",


THis seems like an odd addition? Did you need a new typescript compiler?

No need for a new TS compiler. I think it just updated it with the one I used.

You should back out this change then. This should also remove the change to package-lock.json

rchiodo · 2022-01-19T20:54:49Z

Could you screenshot what it actually looks like and paste it here? It's hard to get a feel for the walkthrough just by looking at the package.json.

rchiodo · 2022-01-19T20:55:23Z

I was also wondering how the walkthrough entries get translated to other languages? Is there support for loading the strings in them from an nls.json file?

minsa110 · 2022-01-19T21:07:12Z

Here is a screenshot (can only expand one step at a time, so only the first one is expanded in the screenshot):

You can also see a gif of it here: https://github.com/microsoft/vscode-jupyter-internal/issues/243

DonJayamanne · 2022-01-19T21:15:33Z

package.json

+                        "title": "Create or open a Jupyter Notebook",
+                        "description": "Right click in the file explorer and create a new file with an .ipynb extension. Or, open the [Command Palette](command:workbench.action.showCommands) and run the command \n``Jupyter: Create New Blank Notebook``.\n[Create new Jupyter Notebook](command:toSide:jupyter.createnewnotebook)\n If you have an existing project, you can also [open a folder](command:workbench.action.files.openFolder) and/or clone a project from GitHub: [clone a Git repository](command:git.clone).",
+                        "media": {
+                            "image": "images/OpenOrCreateNotebook.gif",


I think i remember VS Code adding support for themable images (svgs) for welcome pages.
Else someone on a light them (default) would get dark images.
@luabud might have more information about this.

Also, do we need gifs for everything?
Python extension has SVGs and I personally prefer that, rather than just having dark images

I'm a bit torn myself. The SVGs look much better, but at the same time the gifs feel like they explain things better.

Agreed, but for some like opening a notebook, I don't think we need a gif,
also thats the very first walkthrough, i'd like that to be themeble via svg

Yea, I think Python walkthrough pages use them. I was thinking that once we start seeing positive numbers from the experiment, we'd ask Miguel to help us make them for us as well (I don't have the artsy skills to create svgs 😅). This way we can get the bits in front of our users fast and start getting statistically significant improvements to our feature usage and/or engagement to justify our request. What do you think?

I'm fine with that personally, you can track it how you want, but might be good to create an issue for that change of adding SVGs, just so it doesn't get forgotten in day to day shuffle..

Agreed with Ian, approving

FWIW there are SVGs that could be reused for this first tile, for example these: https://github.com/microsoft/vscode-python/blob/main/resources/walkthrough/create-notebook.svg or https://github.com/microsoft/vscode-python/blob/main/resources/walkthrough/data-science.svg

Thanks folks! #8782

DonJayamanne

Suggest we use SVGs where possible like Python extension to cater all users with different themes

minsa110 · 2022-01-20T07:37:07Z

Hey @rchiodo, sorry I missed your other reply. It is currently not being localized and we plan on running the experiment for users who have English set as their default language. I don't think this has been addressed by other extensions either with exception to this one that C++ team uses

rchiodo · 2022-01-20T17:20:51Z

package-lock.json

            }
        },
        "typescript": {
-            "version": "4.4.3",


This change needs to be reverted too. Otherwise it doesn't match the package.json.

codecov-commenter · 2022-01-24T15:54:01Z

Codecov Report

Merging #8733 (eb90a8a) into main (70cb636) will increase coverage by 0%.
The diff coverage is n/a.

❗ Current head eb90a8a differs from pull request most recent head 9227312. Consider uploading reports for the commit 9227312 to get more accurate results

@@          Coverage Diff           @@
##            main   #8733    +/-   ##
======================================
  Coverage     71%     72%            
======================================
  Files        381     385     +4     
  Lines      24484   24819   +335     
  Branches    3755    3822    +67     
======================================
+ Hits       17508   17888   +380     
+ Misses      5465    5370    -95     
- Partials    1511    1561    +50

Impacted Files	Coverage Δ
...ience/variablesView/variableViewMessageListener.ts	`77% <0%> (-23%)`	⬇️
...ent/common/application/webviewViews/webviewView.ts	`67% <0%> (-11%)`	⬇️
...rc/client/datascience/errors/errorRendererComms.ts	`25% <0%> (-9%)`	⬇️
...ent/datascience/jupyter/pythonVariableRequester.ts	`71% <0%> (-6%)`	⬇️
...ience/kernel-launcher/localKernelSpecFinderBase.ts	`74% <0%> (-3%)`	⬇️
src/client/datascience/jupyter/kernelVariables.ts	`59% <0%> (-2%)`	⬇️
src/client/extensionActivation.ts	`94% <0%> (-2%)`	⬇️
...ient/datascience/kernel-launcher/kernelLauncher.ts	`81% <0%> (-2%)`	⬇️
src/client/datascience/jupyter/kernels/kernel.ts	`75% <0%> (-2%)`	⬇️
...tascience/jupyter/kernels/kernelCommandListener.ts	`70% <0%> (-1%)`	⬇️
... and 40 more

walkthrough experiment

eb90a8a

minsa110 marked this pull request as ready for review January 19, 2022 20:50

minsa110 requested a review from a team as a code owner January 19, 2022 20:50

rchiodo reviewed Jan 19, 2022

View reviewed changes

DonJayamanne reviewed Jan 19, 2022

View reviewed changes

DonJayamanne requested changes Jan 19, 2022

View reviewed changes

IanMatthewHuff approved these changes Jan 19, 2022

View reviewed changes

rchiodo reviewed Jan 20, 2022

View reviewed changes

DonJayamanne self-requested a review January 20, 2022 18:34

DonJayamanne approved these changes Jan 20, 2022

View reviewed changes

minsa110 added 2 commits January 24, 2022 07:46

reverting typescript version

b489d7d

fixing ts version

85bc442

minsa110 added the skip news label Jan 24, 2022

fixing ts version

9227312

minsa110 mentioned this pull request Jan 24, 2022

Add SVGs for getting started walkthrough #8782

Closed

minsa110 added 2 commits January 24, 2022 09:27

fixing ts version

8a16e8a

fixing ts version

558d53c

rchiodo approved these changes Jan 24, 2022

View reviewed changes

minsa110 merged commit a21a19d into main Jan 24, 2022

minsa110 deleted the walkthrough branch January 24, 2022 18:12

This was referenced Jan 25, 2022

Testing new Jupyter walkthrough microsoft/vscode-python#18354

Closed

Testing new data science walkthrough microsoft/vscode-python#18355

Closed

minsa110 mentioned this pull request Jan 25, 2022

Testing new Jupyter walkthrough #8793

Closed

2 tasks

Getting started walkthrough for data scientists #8733

Getting started walkthrough for data scientists #8733

Uh oh!

Conversation

minsa110 commented Jan 19, 2022

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

rchiodo commented Jan 19, 2022

Uh oh!

rchiodo commented Jan 19, 2022

Uh oh!

minsa110 commented Jan 19, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

minsa110 Jan 20, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

DonJayamanne left a comment

Choose a reason for hiding this comment

Uh oh!

minsa110 commented Jan 20, 2022

Uh oh!

Choose a reason for hiding this comment

Uh oh!

codecov-commenter commented Jan 24, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

7 participants

minsa110 commented Jan 19, 2022 •

edited

Loading

minsa110 Jan 20, 2022 •

edited

Loading

codecov-commenter commented Jan 24, 2022 •

edited

Loading