Getting started walkthrough for data scientists (#8733)

* walkthrough experiment * reverting typescript version * fixing ts version * fixing ts version * fixing ts version * fixing ts version
microsoft · Jan 24, 2022 · a21a19d · a21a19d
1 parent 67191b9
commit a21a19d
Show file tree

Hide file tree

Showing 2 changed files with 53 additions and 0 deletions.
diff --git a/images/dataviewerdark.gif b/images/dataviewerdark.gif
diff --git a/package.json b/package.json
@@ -68,6 +68,7 @@
         "onCommand:jupyter.selectNativeJupyterUriFromToolBar",
         "onCommand:jupyter.clearSavedJupyterUris",
         "onCommand:jupyter.filterKernels",
+        "onWalkthrough:jupyterWelcome",
         "onNotebook:jupyter-notebook",
         "onNotebook:interactive"
     ],
@@ -80,6 +81,58 @@
         }
     },
     "contributes": {
+        "walkthroughs": [
+            {
+                "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",
+                "steps": [
+                    {
+                        "id": "jupyter.createNewNotebook",
+                        "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",
+                            "altText": "Creating a new Jupyter notebook"
+                        },
+                        "completionEvents": [
+                            "onCommand:jupyter.createnewnotebook",
+                            "onCommand:jupyter.createnewinteractive",
+                            "onCommand:workbench.action.files.openFolder",
+                            "onCommand:workbench.action.files.openFileFolder"
+                        ]
+                    },
+                    {
+                        "id": "jupyter.selectKernel",
+                        "title": "Select a Jupyter kernel",
+                        "description": "Click Select Kernel at the top right of the notebook and choose the environment in which to run your kernel. \n[Select a kernel](command:notebook.selectKernel)",
+                        "media": {
+                            "image": "images/jupyter README/kernelPicker.gif",
+                            "altText": "Selecting or changing a notebook kernel"
+                        }
+                    },
+                    {
+                        "id": "jupyter.exploreAndDebug",
+                        "title": "Explore data and debug",
+                        "description": "📅 You can use the [Data Viewer](https://code.visualstudio.com/docs/datascience/data-science-tutorial#_prepare-the-data) to view, sort, and filter the rows of data. After loading your data, click \"Variables\" at the top right of notebook and click the Data Viewer icon to the left of the data table. \n \n[Learn about Data Viewer](https://code.visualstudio.com/docs/datascience/data-science-tutorial#_prepare-the-data)\n \n📒 Debug your notebook using the [Run by Line](https://code.visualstudio.com/docs/datascience/jupyter-notebooks#_run-by-line) mode to execute a cell one line at a time. Click the Run by Line icon from your cell (play button with lines) or hit F10. \n \n[Learn about Run by Line](https://code.visualstudio.com/docs/datascience/jupyter-notebooks#_run-by-line)",
+                        "media": {
+                            "image": "images/dataviewerdark.gif",
+                            "altText": "Opening data viewer"
+                        }
+                    },
+                    {
+                        "id": "jupyter.dataScienceLearnMore",
+                        "title": "Find out more!",
+                        "description": "🎨 Explore all the features the Jupyter extension has to offer by looking for \"Jupyter\" in the [Command Palette](command:workbench.action.showCommands). \n 📈 Learn more about getting started with data science in [Python](command:workbench.action.openWalkthrough?%7B%22category%22%3A%22ms-python.python%23pythonDataScienceWelcome%22%2C%22step%22%3A%22ms-python.python%23python.createNewNotebook%22%7D) by installing the Python extension ([search Python extension](command:workbench.extensions.search?\"ms-python.python\")). \n 📃 Find out more features in our [Tutorials](https://code.visualstudio.com/docs/datascience/jupyter-notebooks).  \n[Learn more](https://aka.ms/AAdar6q)",
+                        "media": {
+                            "image": "images/interactive.gif",
+                            "altText": "Image representing our documentation page and mailing list resources."
+                        }
+                    }
+                ]
+            }
+        ],
         "keybindings": [
             {
                 "command": "jupyter.execSelectionInteractive",