Test: Getting Started

[brettcannon]

Refs: #16678

• anyOS @lszomoru
• anyOS @karrtikr

Complexity: 5

Create Issue

---

Created on behalf of @luabud who wrote this but is out recovering from her second vaccine dose 💉

Because the new getting started page will only show in the welcome view for those in the treatment group of the A/B experiment, you need to set the following settings in your user settings.json in order to test it:

    "experiments.override.gettingStarted.overrideCategory.ms-python.python.pythonWelcome.when": "true",
    "experiments.override.gettingStarted.overrideCategory.ms-python.python.pythonDataScienceWelcome.when": "true",

Pre-existing start page

• When typing Python: Start in the command palette, ensure that no start page-related commands appear.
• When typing "start" in the settings page and selecting the "Python" section, ensure that no start page-related settings appear.
• Add the "python.showStartPage": false, setting to your JSON settings, and verify that this setting is marked as unsupported.

Welcome Page (Help: Welcome command)

• Ensure the two tiles appear on the VS Code welcome view when you install the Python extension:

• The Python extension should activate when you click on either of the tiles

Get started with Python development

• Clicking on the "Get started with Python development" should take you to the first step of the walkthrough, which gives instructions on how to install Python. Ensure it shows the correct commands for your operating system.
• If there are any links on the installation instructions, make sure they work as you'd expect them to.
• Clicking on the "Select Interpreter" tile should display a button to trigger the select interpreter command as well as a GIF. Make sure the GIF is rendered correctly according to your theme (GIF changes for light, dark and high contrast themes).
• Make sure the "Select Interpreter" button triggers the command and displays the list with Python interpreters
• Ensure the "Command Palette" link opens up the command palette
• Clicking on the "Run and debug your Python file" should display a "Learn more" button and instructions in a markdown file. Make sure the image in the instructions is rendered properly (this one doesn't change according to themes).
• Ensure the "open" link in the first step of the instructions displays the file explorer for you to open a file
• Ensure the "learn more" button directs you to https://code.visualstudio.com/docs/python/python-tutorial#_run-hello-world
• Ensure that following the instructions would lead to a file being run in VS Code correctly
• Clicking on the last tile of the walkthrough ("Learn more") should display a list of resources and a screenshot. Ensure the screenshot is rendered properly (this one doesn't change according to themes either).
• Ensure the links work properly:
  • "Command Palette" opens the command palette in VS Code
  • "Sign up" takes you to https://code.visualstudio.com/welcome-python
  • "Tutorials" takes you to https://code.visualstudio.com/docs/python/python-tutorial
  • "Documentation" takes you to https://code.visualstudio.com/docs/languages/python
  • "Release Notes" takes you to https://devblogs.microsoft.com/python/category/visual-studio-code/

Get started with Python for Data Science

• Clicking on the "Get started with Python for Data Science" should take you to the first step of the walkthrough, which gives instructions on how to install Python with Anaconda and displays a screenshot. Ensure the screenshot is displayed correctly.
• Clicking on the Anaconda link should take you to: https://www.anaconda.com/
• Clicking on the Install button should reload the window (*)
• If you don't have a folder open, you should see a tile to open a project or clone a git repo. Ensure the buttons trigger the right commands. Also ensure there's a GIF rendered properly.
• If you have a folder open, you should not see a tile with content to open a new project.
• Clicking on the "Create a new Jupyter Notebook" tile should display a screenshot and a button to create a new Jupyter notebook (as well as a link to the command palette). Ensure the image is displayed correctly and the button and the link work as expected.
• Clicking on the "Open the Python interactive window" tile should display a screenshot and a button to create a new Jupyter notebook (as well as a link to the command palette). Ensure the image is displayed correctly and the button and the link work as expected.
• Ensure the links work properly:
  • "Command Palette" opens the command palette in VS Code
  • "Sign up" takes you to https://code.visualstudio.com/welcome-python
  • "Tutorials" takes you to https://code.visualstudio.com/docs/python/python-tutorial
  • "Documentation" takes you to https://code.visualstudio.com/docs/languages/python
  • "Release Notes" takes you to https://devblogs.microsoft.com/python/category/visual-studio-code/

(*) When I was testing this, I didn't quite like the experience as it felt unexpected. If others feel the same way, we can talk to Jeffrey to see if it's worth just directing it to the anaconda webpage, and then add a tip on the next tile (for interpreter selection) for users to reload the window if they don't find their conda environment.

[karrtikr]

@brettcannon

(*) When I was testing this, I didn't quite like the experience as it felt unexpected. If others feel the same way, we can talk to Jeffrey to see if it's worth just directing it to the anaconda webpage, and then add a tip on the next tile (for interpreter selection) for users to reload the window if they don't find their conda environment.

I agree, I felt disconnected when going between many of the steps.

Clicking on the Install button should reload the window (*)

1. As a user I was tempted to clicking into the button instead of the "Anaconda" hyperlink. It did not open any installation link and reloaded the window to the main welcome page and the data science walkthrough page disappeared, so I had to click the data science tile again. I expected it should atleast open anaconda installation page before reload.

If you don't have a folder open, you should see a tile to open a project or clone a git repo. Ensure the buttons trigger the right commands. Also ensure there's a GIF rendered properly.

2. When I opened the folder, the window reloaded again and I was redirected the main welcome page instead of the data science walkthrough page.

3. Weird experience if a user chooses to install anaconda even though they have Python installed. I expected Create a new Jupyter Notebook to use anaconda which I just installed. Instead default interpreter for workspace was chosen directly which did not have basic dependencies installed. A Select Interpreter tip to intercept this could be useful as Brett suggested.

[lszomoru]

@luabud, @brettcannon - Are those A/B experiment settings correct?
I have put them in my user setting but "python.showStartPage": false still seems to be a valid setting:

[karrtikr]

@lszomoru Are you using the insiders build of the Python extension? Try using Python: Switch to Insiders Weekly command to install the latest insiders build.

[lszomoru]

@karrtikr, that was it. I am unblocked now. thanks!

[lszomoru]

Shouldn't the tutorial link under data science point to https://code.visualstudio.com/docs/datascience/overview?

[brettcannon]

@luabud see the question ☝ from @lszomoru

[luabud]

Shouldn't the tutorial link under data science point to https://code.visualstudio.com/docs/datascience/overview?

Yeah that's much better, thanks for bringing it up! Fixed by #16820