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

Investigate Getting Started Walkthrough flow #20740

Closed
cwebster-99 opened this issue Feb 23, 2023 · 8 comments
Closed

Investigate Getting Started Walkthrough flow #20740

cwebster-99 opened this issue Feb 23, 2023 · 8 comments
Assignees
Labels
needs spike Label for issues that need investigation before they can be worked on.

Comments

@cwebster-99
Copy link
Member

We should investigate the flow we are encouraging in the Getting Started with Python walkthrough to ensure it reflects best practice's and the idealized use of the tool.

We currently guide users to:

  • Create a Python file
  • Select a Python Interpreter
  • Run and debug a Python file
  • Explore more resources

We also show a different flow if the user has a workspace open:

  • Create a Python file
  • Create a Python environment
  • Run and debug a Python file
  • Explore more resources

Some considerations are if we should encourage the user to open a folder instead of a file, where we should prompt the user to create an environment, if these tiles are in the best order, etc.

Ref #20649

@cwebster-99 cwebster-99 added feature-request Request for new features or functionality and removed feature-request Request for new features or functionality labels Feb 23, 2023
@cwebster-99 cwebster-99 self-assigned this Feb 23, 2023
@github-actions github-actions bot added the triage-needed Needs assignment to the proper sub-team label Feb 23, 2023
@cwebster-99 cwebster-99 self-assigned this Feb 23, 2023
@cwebster-99 cwebster-99 removed the triage-needed Needs assignment to the proper sub-team label Feb 23, 2023
@cwebster-99
Copy link
Member Author

cwebster-99 commented Mar 16, 2023

We could adapt our current views to reflect a more ideal flow (i.e. using a workspace, using a virtual environment, etc.)

For users that are visiting the getting started page with a workspace open when can encourage them to take the following steps:

  • Create a Python file
  • Create a Python environment
  • Run and debug your Python file
  • Explore more resources (could include information about compatible tool extensions)

For users visiting the getting started page with no workspace open we can encourage them to take the following steps:

  • Create a new project folder
  • Create a Python file
  • Create a Python environment
  • Run and debug your Python code
  • Explore more resources (could include information about compatible tool extensions)

Currently in "Explore more resources" we have:

  • Explore features in the command palette
  • Link to Getting Start with Data Science in Python walkthrough
  • Link to Release Notes
  • "Learn More" button that leads to our tutorial

Changing the wording on the "Learn More" button to something more related to the tutorial might make new users more likely to interact with it. Perhaps, "Python Tutorial" or "Follow Along with the Python Tutorial"

@karrtikr
Copy link

Looks good. It would be great if we can somehow teach what "Select Interpreter" tile does as well. Something like: "Create a Python environment or use <...> to select an existing one".

@luabud
Copy link
Member

luabud commented Mar 17, 2023

good point on learn more, +1 to "Follow Along with the Python Tutorial"

I think the ideal would be to make #20249 happen, then we could just guide people on "Select Interpreter" from both flows 😁

@karrtikr
Copy link

When doing getting started or supporting a Create workspace command, I think we should prioritize "Create Environment" over the "Select Interpreter" list, as we want to encourage users to use an environment.

#20249 exposes "Create Environment" as a secondary option though 😅 so many users can simply end up choosing a global interpreter and moving on.

@cwebster-99
Copy link
Member Author

I think we should prioritize "Create Environment" over the "Select Interpreter" list, as we want to encourage users to use an environment.

I agree, whichever one we think is more important should be the top level option, and then the nested one is secondary.

@luabud
Copy link
Member

luabud commented Mar 17, 2023

Yes good point. This is especially important when there isn't a virtual environment in the workspace (or a folder open).

Would the idea here be to expose a picker with "Create environment" and "Select an existing interpreter" first?

@karrtikr
Copy link

Would the idea here be to expose a picker with "Create environment" and "Select an existing interpreter" first?

I like it 🙂 kind of like mirror idea of #20249:

@brettcannon brettcannon added the needs spike Label for issues that need investigation before they can be worked on. label Mar 23, 2023
@cwebster-99
Copy link
Member Author

Closing as this investigation is finished with the following issues as a result:

@github-actions github-actions bot locked as resolved and limited conversation to collaborators Apr 7, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
needs spike Label for issues that need investigation before they can be worked on.
Projects
None yet
Development

No branches or pull requests

4 participants