Skip to content

Commit d532a33

Browse files
author
Kraig Brockschmidt
committed
First round of SEO change for Python
Includes renaming files to be more descriptive (which means adding necessary redirects and updating other links), flushing out any titles that need it, and adding metadata descriptions.
1 parent 6eab960 commit d532a33

39 files changed

+218
-149
lines changed

.openpublishing.redirection.json

Lines changed: 65 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1335,6 +1335,11 @@
13351335
"redirect_url": "/visualstudio/profiling/profiling-feature-tour",
13361336
"redirect_document_id": false
13371337
},
1338+
{
1339+
"source_path": "docs/python/cpp-and-python.md",
1340+
"redirect_url": "/visualstudio/python/working-with-c-cpp-python-in-visual-studio",
1341+
"redirect_document_id": false
1342+
},
13381343
{
13391344
"source_path": "docs/python/getting-started-with-ptvs-building-a-website-in-azure.md",
13401345
"redirect_url": "/visualstudio/python/publishing-to-azure",
@@ -1357,29 +1362,84 @@
13571362
},
13581363
{
13591364
"source_path": "docs/python/getting-started-with-ptvs-setting-up-visual-studio.md",
1360-
"redirect_url": "/visualstudio/python/installation",
1365+
"redirect_url": "/visualstudio/python/installing-python-support-in-visual-studio",
13611366
"redirect_document_id": false
13621367
},
13631368
{
13641369
"source_path": "docs/python/getting-started-with-ptvs-start-coding-projects.md",
1365-
"redirect_url": "/visualstudio/python/python-projects",
1370+
"redirect_url": "/visualstudio/python/managing-python-projects-in-visual-studio",
13661371
"redirect_document_id": false
13671372
},
13681373
{
13691374
"source_path": "docs/python/getting-started-with-python.md",
1370-
"redirect_url": "/visualstudio/python/python-in-visual-studio",
1375+
"redirect_url": "/visualstudio/python/overview-of-python-tools-for-visual-studio",
13711376
"redirect_document_id": false
13721377
},
13731378
{
13741379
"source_path": "docs/python/getting-started.md",
1375-
"redirect_url": "/visualstudio/python/vs-tutorial-01-01",
1380+
"redirect_url": "/visualstudio/python/tutorial-working-with-python-in-visual-studio-step-01-create-project",
13761381
"redirect_document_id": false
13771382
},
13781383
{
13791384
"source_path": "docs/python/index.md",
1380-
"redirect_url": "/visualstudio/python/python-in-visual-studio",
1385+
"redirect_url": "/visualstudio/python/overview-of-python-tools-for-visual-studio",
1386+
"redirect_document_id": false
1387+
},
1388+
{
1389+
"source_path": "docs/python/installation.md",
1390+
"redirect_url": "/visualstudio/python/installing-python-support-in-visual-studio",
1391+
"redirect_document_id": false
1392+
},
1393+
{
1394+
"source_path": "docs/python/python-environments.md",
1395+
"redirect_url": "/visualstudio/python/managing-python-environments-in-visual-studio",
1396+
"redirect_document_id": false
1397+
},
1398+
{
1399+
"source_path": "docs/python/python-in-visual-studio.md",
1400+
"redirect_url": "/visualstudio/python/overview-of-python-tools-for-visual-studio",
1401+
"redirect_document_id": false
1402+
},
1403+
{
1404+
"source_path": "docs/python/python-projects.md",
1405+
"redirect_url": "/visualstudio/python/managing-python-projects-in-visual-studio",
1406+
"redirect_document_id": false
1407+
},
1408+
{
1409+
"source_path": "docs/python/vs-tutorial-01-00.md",
1410+
"redirect_url": "/visualstudio/python/tutorial-working-with-python-in-visual-studio-step-00-installation",
13811411
"redirect_document_id": false
13821412
},
1413+
{
1414+
"source_path": "docs/python/vs-tutorial-01-01.md",
1415+
"redirect_url": "/visualstudio/python/tutorial-working-with-python-in-visual-studio-step-01-create-project",
1416+
"redirect_document_id": false
1417+
},
1418+
{
1419+
"source_path": "docs/python/vs-tutorial-01-02.md",
1420+
"redirect_url": "/visualstudio/python/tutorial-working-with-python-in-visual-studio-step-02-writing-code",
1421+
"redirect_document_id": false
1422+
},
1423+
{
1424+
"source_path": "docs/python/vs-tutorial-01-03.md",
1425+
"redirect_url": "/visualstudio/python/tutorial-working-with-python-in-visual-studio-step-03-interactive-repl",
1426+
"redirect_document_id": false
1427+
},
1428+
{
1429+
"source_path": "docs/python/vs-tutorial-01-04.md",
1430+
"redirect_url": "/visualstudio/python/tutorial-working-with-python-in-visual-studio-step-04-debugging",
1431+
"redirect_document_id": false
1432+
},
1433+
{
1434+
"source_path": "docs/python/vs-tutorial-01-05.md",
1435+
"redirect_url": "/visualstudio/python/tutorial-working-with-python-in-visual-studio-step-05-installing-packages",
1436+
"redirect_document_id": false
1437+
},
1438+
{
1439+
"source_path": "docs/python/vs-tutorial-01-06.md",
1440+
"redirect_url": "/visualstudio/python/tutorial-working-with-python-in-visual-studio-step-06-working-with-git",
1441+
"redirect_document_id": false
1442+
},
13831443
{
13841444
"source_path": "docs/sharepoint/index.md",
13851445
"redirect_url": "/visualstudio/sharepoint/create-sharepoint-solutions",

docs/TOC.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@
5454
## [Visual Basic: Create a Console App](ide/quickstart-visual-basic-console.md)
5555
# Tutorials
5656
## [C++ in Visual Studio...](/cpp/build/vscpp-step-0-installation)
57-
## [Python in Visual Studio...](python/vs-tutorial-01-01.md)
57+
## [Python in Visual Studio...](python/tutorial-working-with-python-in-visual-studio-step-01-create-project.md)
5858
## [R in Visual Studio...](rtvs/getting-started-with-r.md)
5959
## [Node.js in Visual Studio](nodejs/tutorial-nodejs.md)
6060
## [C# in Visual Studio](ide/tutorial-csharp-aspnet-core.md)

docs/ai/create-project-existing.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ Once you've [installed Visual Studio Tools for AI](installation.md), it's easy t
2424
8. If desired, run the program by pressing Ctrl+F5 or selecting **Debug > Start Without Debugging**.
2525

2626
> [!div class="nextstepaction"]
27-
> [Tutorial: Working with Python in Visual Studio](https://docs.microsoft.com/visualstudio/python/vs-tutorial-01-00)
27+
> [Tutorial: Working with Python in Visual Studio](../python/tutorial-working-with-python-in-visual-studio-step-00-installation.md)
2828
2929
## See Also
3030

docs/ide/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -255,7 +255,7 @@ src="https://docs.microsoft.com/media/logos/logo_TS.svg"><span>TypeScript</span>
255255
src="https://docs.microsoft.com/media/logos/logo_Cplusplus.svg"><span>C++</span></a></div>
256256
<div class="ico48Link"><a href="/visualstudio/nodejs/tutorial-nodejs"><img width="48" height="48" alt=""
257257
src="https://docs.microsoft.com/media/logos/logo_nodejs.svg"><span>Node.js</span></a></div>
258-
<div class="ico48Link"><a href="/visualstudio/python/vs-tutorial-01-01"><img width="48" height="48" alt=""
258+
<div class="ico48Link"><a href="/visualstudio/python/tutorial-working-with-python-in-visual-studio-step-01-create-project"><img width="48" height="48" alt=""
259259
src="https://docs.microsoft.com/media/logos/logo_Python.svg"><span>Python</span></a></div>
260260
<div class="ico48Link"><a href="/visualstudio/rtvs/getting-started-with-r"><img width="48" height="48" alt=""
261261
src="https://docs.microsoft.com/media/logos/logo_R.svg"><span>R</span></a></div>

docs/ide/quickstart-python.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -68,7 +68,7 @@ In this Quickstart, however, you use the Falcon library to experience the proces
6868

6969
For more information about Falcon, visit [falconframework.org](https://falconframework.org/).
7070

71-
Note that instead of installing libraries in the global environment, developers typically create a "virtual environment" in which to install libraries for a specific project. Many Python project templates in Visual Studio include a `requirements.txt` file that lists the libraries on which the template depends. Creating a project from one of those templates triggers creation of a virtual environment into which the libraries are installed. For more information, see [Python environments - Virtual environments](../python/python-environments.md#creating-virtual-environments).
71+
Note that instead of installing libraries in the global environment, developers typically create a "virtual environment" in which to install libraries for a specific project. Many Python project templates in Visual Studio include a `requirements.txt` file that lists the libraries on which the template depends. Creating a project from one of those templates triggers creation of a virtual environment into which the libraries are installed. For more information, see [Python environments - Virtual environments](../python/managing-python-environments-in-visual-studio.md#creating-virtual-environments).
7272

7373
## Add a code file
7474

@@ -142,7 +142,7 @@ For more information about Falcon, see the [Falcon Quickstart](https://falcon.re
142142
Congratulations on completing this Quickstart, in which you've learned a little about the Visual Studio IDE with Python. To continue with a fuller tutorial on Python in Visual Studio, including using the interactive window, debugging, data visualization, and working with Git, select the button below.
143143

144144
> [!div class="nextstepaction"]
145-
> [Tutorial: Getting Started with Python in Visual Studio](../python/vs-tutorial-01-01.md).
145+
> [Tutorial: Getting Started with Python in Visual Studio](../python/tutorial-working-with-python-in-visual-studio-step-01-create-project.md).
146146

147147
- Learn about [Python web app templates in Visual Studio](../python/template-web.md)
148148
- Learn about [Python debugging](../python/debugging.md)

docs/python/TOC.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,21 @@
1-
# [Overview](python-in-visual-studio.md)
2-
# [Installation](installation.md)
1+
# [Overview](overview-of-python-tools-for-visual-studio.md)
2+
# [Installation](installing-python-support-in-visual-studio.md)
33
# Quickstarts
44
## [Create a project from existing code](quickstart-01-project-from-existing.md)
55
## [Create a project from a template](quickstart-02-project-from-template.md)
66
## [Create a project from a repository](quickstart-03-project-from-repository.md)
77
## [Create a project from a Cookiecutter template](quickstart-04-project-from-cookiecutter.md)
88
# Tutorials
9-
## [0 - Install Python support](vs-tutorial-01-00.md)
10-
## [1 - Create a new Python project](vs-tutorial-01-01.md)
11-
## [2 - Writing and running code](vs-tutorial-01-02.md)
12-
## [3 - Using the interactive REPL window](vs-tutorial-01-03.md)
13-
## [4 - Running code in the debugger](vs-tutorial-01-04.md)
14-
## [5 - Installing packages and managing Python environments](vs-tutorial-01-05.md)
15-
## [6 - Working with Git](vs-tutorial-01-06.md)
9+
## [0 - Install Python support](tutorial-working-with-python-in-visual-studio-step-00-installation.md)
10+
## [1 - Create a new Python project](tutorial-working-with-python-in-visual-studio-step-01-create-project.md)
11+
## [2 - Writing and running code](tutorial-working-with-python-in-visual-studio-step-02-writing-code.md)
12+
## [3 - Using the interactive REPL window](tutorial-working-with-python-in-visual-studio-step-03-interactive-repl.md)
13+
## [4 - Running code in the debugger](tutorial-working-with-python-in-visual-studio-step-04-debugging.md)
14+
## [5 - Installing packages and managing Python environments](tutorial-working-with-python-in-visual-studio-step-05-installing-packages.md)
15+
## [6 - Working with Git](tutorial-working-with-python-in-visual-studio-step-06-working-with-git.md)
1616
# Concepts
17-
## [Python environments](python-environments.md)
18-
## [Python projects](python-projects.md)
17+
## [Python environments](managing-python-environments-in-visual-studio.md)
18+
## [Python projects](managing-python-projects-in-visual-studio.md)
1919
### [Web project templates](template-web.md)
2020
### [Django web project template](template-django.md)
2121
### [Azure cloud service template](template-azure-cloud-service.md)
@@ -35,7 +35,7 @@
3535
### [Azure remote debugging](debugging-azure-remote.md)
3636
### [Troubleshooting Azure remote debugging](debugging-azure-remote-troubleshooting.md)
3737
## Interacting with C++
38-
### [Creating a C++ extension for Python](cpp-and-python.md)
38+
### [Creating a C++ extension for Python](working-with-c-cpp-python-in-visual-studio.md)
3939
### [Python/C++ mixed-mode debugging](debugging-mixed-mode.md)
4040
### [Symbols for mixed-mode debugging](debugging-symbols-for-mixed-mode.md)
4141
## [Profiling](profiling.md)

docs/python/code-editing.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ ms.workload:
2020

2121
# Editing Python code
2222

23-
Developers spend much of their time in the code editor, so [Python support in Visual Studio](installation.md) provides functionality to help you be more productive. Features include IntelliSense syntax highlighting, auto-completion, signature help, method overrides, search, and navigation.
23+
Developers spend much of their time in the code editor, so [Python support in Visual Studio](installing-python-support-in-visual-studio.md) provides functionality to help you be more productive. Features include IntelliSense syntax highlighting, auto-completion, signature help, method overrides, search, and navigation.
2424

2525
In this topic:
2626

@@ -30,15 +30,15 @@ In this topic:
3030

3131
For general documentation on editing code in Visual Studio, see [Writing Code in the Code and Text Editor](../ide/writing-code-in-the-code-and-text-editor.md). Also see [Outlining in Visual Studio](../ide/outlining.md), which helps you stay focused on particular sections of your code. Python support includes using the Visual Studio Object Browser (**View > Other Windows > Object Browser** or Ctrl+W,J) for inspecting classes defined in each module and the functions defined in those classes.
3232

33-
The editor is also integrated with the interactive window in Visual Studio, making it easy to exchange code between the two. See [Tutorial Step 3: Using the interactive REPL window](vs-tutorial-01-03.md) and [Using the interactive window - Send code to interactive command](interactive-repl.md#send-code-to-interactive-command) for details.
33+
The editor is also integrated with the interactive window in Visual Studio, making it easy to exchange code between the two. See [Tutorial Step 3: Using the interactive REPL window](tutorial-working-with-python-in-visual-studio-step-03-interactive-repl.md) and [Using the interactive window - Send code to interactive command](interactive-repl.md#send-code-to-interactive-command) for details.
3434

3535
For an introduction to editing Python code, see [Editing Python code](https://mva.microsoft.com/en-US/training-courses/python-tools-for-visual-studio-2017-18121?l=r2iQH5LWE_4605918567) (Microsoft Virtual Academy, 2m30s):
3636

3737
> [!VIDEO https://mva.microsoft.com/en-US/training-courses-embed/python-tools-for-visual-studio-2017-18121/Video-Editing-Python-Code-r2iQH5LWE_4605918567]
3838
3939
## IntelliSense
4040

41-
IntelliSense provides [completions](#completions), [signature help](#signature-help), [quick info](#quick-info), and [code coloring](#code-coloring). To improve performance, IntelliSense depends on the completion database that's generated for each Python environment in your project. Databases may need refreshing if you add, remove, or update packages. Database status is shown in the **Python Environments** window (a sibling of Solution Explorer) on the **IntelliSense** tab (see [Python environments](python-environments.md)).
41+
IntelliSense provides [completions](#completions), [signature help](#signature-help), [quick info](#quick-info), and [code coloring](#code-coloring). To improve performance, IntelliSense depends on the completion database that's generated for each Python environment in your project. Databases may need refreshing if you add, remove, or update packages. Database status is shown in the **Python Environments** window (a sibling of Solution Explorer) on the **IntelliSense** tab (see [Python environments](managing-python-environments-in-visual-studio.md)).
4242

4343
### Completions
4444

docs/python/code-formatting.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ Visual Studio lets you quick reformat code to match pre-configured formatting op
2727

2828
Options are set through **Tools > Options > Text Editor > Python > Formatting** and its nested tabs, and by default are set to match a superset of the [PEP 8 style guide](http://www.python.org/dev/peps/pep-0008/). The **General** tab determines when formatting is applied; settings the other three tabs are described in this topic.
2929

30-
[Python support in Visual Studio](installation.md) also adds the useful [Fill Comment Paragraph](#fill-comment-paragraph-command) command to the **Edit > Advanced** menu as described that follow.
30+
[Python support in Visual Studio](installing-python-support-in-visual-studio.md) also adds the useful [Fill Comment Paragraph](#fill-comment-paragraph-command) command to the **Edit > Advanced** menu as described that follow.
3131

3232
## Spacing
3333

docs/python/cookiecutter.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ ms.workload:
2222

2323
[Cookiecutter](https://cookiecutter.readthedocs.io/en/latest/) provides a graphical user interface to discover templates, input template options, and create projects and files. It's included with Visual Studio 2017 and can be installed separately in earlier versions of Visual Studio.
2424

25-
Cookiecutter requires Python 3.3 or later (32-bit or 64-bit) or Anaconda 3 4.2 or later (32-bit or 64-bit). If a suitable Python interpreter isn't available, Visual Studio displays a warning. If you install a Python interpreter while Visual Studio is running, click the Home button on the Cookiecutter toolbar to detect the newly installed interpreter. (See [Python environments](python-environments.md) for more about environments in general.)
25+
Cookiecutter requires Python 3.3 or later (32-bit or 64-bit) or Anaconda 3 4.2 or later (32-bit or 64-bit). If a suitable Python interpreter isn't available, Visual Studio displays a warning. If you install a Python interpreter while Visual Studio is running, click the Home button on the Cookiecutter toolbar to detect the newly installed interpreter. (See [Python environments](managing-python-environments-in-visual-studio.md) for more about environments in general.)
2626

2727
Once installed, select **View > Cookiecutter Explorer** to open its window:
2828

docs/python/debugging-azure-remote.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ ms.workload:
2020

2121
# Remotely debugging Python code on Azure
2222

23-
[Python support in Visual Studio](installation.md) includes the ability to remotely debugging Python code that's running on Azure App Service. Unlike simple remote debugging, the target computer in this scenario is not directly accessible over TCP, so Visual Studio provides a proxy that exposes the debugger protocol over HTTP. Projects created using the Web template automatically configure this proxy in the generated `web.debug.config` file. Remote debugging is also enabled when you publish a Debug configuration of your project as described on [Publishing to Azure App Service](template-web.md#publishing-to-azure-app-service).
23+
[Python support in Visual Studio](installing-python-support-in-visual-studio.md) includes the ability to remotely debugging Python code that's running on Azure App Service. Unlike simple remote debugging, the target computer in this scenario is not directly accessible over TCP, so Visual Studio provides a proxy that exposes the debugger protocol over HTTP. Projects created using the Web template automatically configure this proxy in the generated `web.debug.config` file. Remote debugging is also enabled when you publish a Debug configuration of your project as described on [Publishing to Azure App Service](template-web.md#publishing-to-azure-app-service).
2424

2525
Because Azure remote debugging uses web sockets, sockets must be enabled for your App Service through the [Azure portal](https://portal.azure.com) by going to **Settings > Application settings** and turning **General settings > Web sockets** to **On**, then selecting **Save** to apply the change. (Note that the **Debugging** settings do not apply to debugging Python.)
2626

0 commit comments

Comments
 (0)