Add Python Quick Start page #6951
Conversation
cwebster-99
commented
Jan 9, 2024
cwebster-99
commented
- Adding new Python Quick Start page
- Adding media files for Quick Start page
- Reordering the remainder of the docs
docs/python/python-quick-start.md
Outdated
| Order: 1 | ||
| Area: python | ||
| TOCTitle: Quick Start | ||
| ContentId: 77828f36-ae45-4887-b25c-34545edd52d3 |
There was a problem hiding this comment.
This was copied from another file so will need to be updated. Where do I get a new ContentId?
There was a problem hiding this comment.
this is just a GUID, which you can generate however you want (I used the nwallace.createguid extension per Greg's suggestion 😊)
docs/python/python-quick-start.md
Outdated
|
|
||
| ### Open an existing Python project or file | ||
|
|
||
| If you have an existing Python project you wish to work on in VS Code, you can begin by opening your folder or file from the VS Code welcome page or Explorer panel, or by selecting **File -> Open Folder** (Ctrl+K Ctrl+O) or **File -> Open File** (Ctrl+O). |
There was a problem hiding this comment.
Need to add the kb.style shortcut for these commands
docs/python/python-quick-start.md
Outdated
|
|
||
| ### Create new Python scripts | ||
|
|
||
| If you are starting a new Python script, you can create Python files directly in VS Code. You can create a new Python file by selecting **New File** in the VS Code Welcome page and select **Python file**, or navigating to **File -> New File** (ADD SHORTCUT). |
There was a problem hiding this comment.
Need to add kb.style shortcut
docs/python/python-quick-start.md
Outdated
|
|
||
| ### Open an existing Python project or file | ||
|
|
||
| If you have an existing Python project you wish to work on in VS Code, you can begin by opening your folder or file from the VS Code welcome page or Explorer panel, or by selecting **File -> Open Folder** (Ctrl+K Ctrl+O) or **File -> Open File** (Ctrl+O). |
There was a problem hiding this comment.
since it's a quick start maybe we should cover just one flow?
I think it makes sense to go with the generic File > Open folder since it's applicable for other languages as well.
docs/python/python-quick-start.md
Outdated
|
|
||
| To start debugging, initialize the debugger by pressing `F5`. Since this is your first time debugging this file, a configuration menu will open from the Command Palette allowing you to select the type of debug configuration you would like for the opened file or project. | ||
|
|
||
| The program will stop at the breakpoint you set, and you can track data in the Python Debug console, and progress through your program using the debug toolbar. |
There was a problem hiding this comment.
I'm not sure how to rephrase this but basically if someone adds a breakpoint to a line that isn't executed, this won't be true. E.g.
if false:
print("hi") # a breakpoint on this line will not be hit
docs/python/python-quick-start.md
Outdated
|
|
||
|  | ||
|
|
||
| After selecting a debug configuration, you can also start the debugger by clicking on the down-arrow next to the run button on the editor and selecting **Debug Python File in Terminal**. |
There was a problem hiding this comment.
I'd suggest to remove this too, keeping it simple with F5 (or direct users to the Run and Debug view instead. Either or, we should probably suggest one flow only)
|
this is so exciting!! 🥳 |
Co-authored-by: Luciana Abud <45497113+luabud@users.noreply.github.com>
Co-authored-by: Luciana Abud <45497113+luabud@users.noreply.github.com>
ntrogh
left a comment
ntrogh
left a comment
There was a problem hiding this comment.
Mostly minor text updates and use of relative links to VS Code docs.
Co-authored-by: Nick Trogh <1908215+ntrogh@users.noreply.github.com>
|
@ntrogh Thanks for the review! Since this is a newly added page, are there any additional changes to ensure it shows up correctly in the Python section? |
@cwebster-99 I've added the new article to the sitemap information. In addition, I've enlisted the article in our feedback system, so readers can use the feedback control on the page. We have a recovery release going out later today, so I'll hold off on publishing the site until after that. The new page should be up tomorrow. |
|
@cwebster-99 ready for your final review. Then we can publish tomorrow. |
…ode-docs into python-quick-start
|
@ntrogh Left a couple of comments on things I wasn't sure about and updated a gif to better align with the debug description. LGTM! |
Co-authored-by: Courtney Webster <60238438+cwebster-99@users.noreply.github.com>
