[Draft] Add docs for dotnet migration support for copilot cli #49730
Conversation
|
Adding @Caoxuyang to review and update |
There was a problem hiding this comment.
Pull Request Overview
This PR adds new documentation for .NET migration support in the GitHub Copilot CLI through App Modernization features. The document guides .NET developers through setting up and using the Copilot CLI to migrate applications to Azure directly from the terminal.
Key Changes
- New comprehensive guide covering prerequisites, setup, and migration workflow for Copilot CLI with App Modernization
- Documentation of MCP server configuration for .NET migration tasks
- Step-by-step instructions for executing migration tasks in the terminal environment
|
|
||
| ## Overview | ||
|
|
||
| This article provides an overview of how .NET developers can migrate their applications to Azure using **GitHub Copilot App Modernization** within the [**Copilot CLI**](https://docs.github.com/en/copilot/how-tos/use-copilot-agents/use-copilot-cli), enabling them to modernize applications wherever they code. It’s currently in public preview — give it a try and let us know if any [feedback](https://aka.ms/ghcp-appmod/feedback). |
There was a problem hiding this comment.
The phrase "give it a try and let us know if any [feedback]" uses passive construction. Per the Markdown style guidelines, use active voice and imperative mood. Rephrase to "Try it out and share your [feedback]" or "Try it and let us know your [feedback]".
| ## Why Use Copilot CLI with App Modernization | ||
| - Run modernization tasks directly from the terminal — no need to switch to an IDE | ||
| - Supports both interactive (human-in-the-loop) and batch workflows |
There was a problem hiding this comment.
The list items lack periods. Per the Markdown style guidelines, list items with more than three words must end with periods. Add periods to both list items.
|
|
||
| ## Prerequisites | ||
| - [Install Copilot CLI](https://docs.github.com/en/copilot/how-tos/set-up/install-copilot-cli) | ||
| - A GitHub Copilot subscription, See [Copilot plans](https://github.com/features/copilot/plans?ref_product=copilot) |
There was a problem hiding this comment.
Incorrect capitalization after comma. Change "See" to "see" (lowercase).
|
|
||
| ## Prerequisites | ||
| - [Install Copilot CLI](https://docs.github.com/en/copilot/how-tos/set-up/install-copilot-cli) | ||
| - A GitHub Copilot subscription, See [Copilot plans](https://github.com/features/copilot/plans?ref_product=copilot) |
There was a problem hiding this comment.
Missing period at end of list item. Per the Markdown style guidelines, list items with more than three words must end with periods.
| Copilot will ask you to confirm that you trust the files in this folder. Refer to [Using Copilot CLI](https://docs.github.com/en/copilot/how-tos/use-copilot-agents/use-copilot-cli#trusted-directories) | ||
| Choose one of the options: |
There was a problem hiding this comment.
Missing blank line between the paragraph and the list that follows. Per the Markdown style guidelines, add blank lines around Markdown elements. Add a blank line after line 40 before the list begins.
| For details on predefined migration tasks, see [migration tasks](predefined-tasks.md) | ||
| For example: |
There was a problem hiding this comment.
Missing blank line between the paragraph and the code block that follows. Per the Markdown style guidelines, add blank lines around Markdown elements.
| Migrate this app from local file IO to Azure Blob Storage | ||
| ``` | ||
|
|
||
| Then the migration task will be executed and showing progress in Copilot CLI |
There was a problem hiding this comment.
Grammatical error. The phrase "will be executed and showing" mixes future tense with present participle incorrectly. Change to "Then the migration task is executed and shows progress in Copilot CLI" or "The migration task executes and shows progress in Copilot CLI."
| Migrate this app from local file IO to Azure Blob Storage | ||
| ``` | ||
|
|
||
| Then the migration task will be executed and showing progress in Copilot CLI |
There was a problem hiding this comment.
Missing period at end of the sentence. Per the Markdown style guidelines, add a period at the end.
| Then the migration task will be executed and showing progress in Copilot CLI | ||
| :::image type="content" source="./media/migrate-details.png" lightbox="./media/migrate-details.png" alt-text="Screenshot of migrating .NET in Copilot CLI"::: | ||
|
|
||
| The project has been successfully migrated to Azure, with below summary: |
There was a problem hiding this comment.
Awkward phrasing. Change "with below summary" to "with the following summary" for clarity and proper grammar.
| If you have any feedback about GitHub Copilot CLI, please let us know your [feedback](https://aka.ms/AM4DFeedback). | ||
|
|
||
| ## Reference | ||
| - [Using GitHub Copilot CLI](https://docs.github.com/en/copilot/how-tos/use-copilot-agents/use-copilot-cli#using-copilot-cli). |
There was a problem hiding this comment.
List items should not end with periods when they are single links or fewer than three words. However, this contains more than three words as the link text, so the period is appropriate. The issue is the period should be outside the link, not as part of the markdown. Move the period outside the closing parenthesis to after it (already correct in the code). Actually reviewing more carefully, the period is already correctly placed outside. No change needed. However, for list items that are just links, the guideline is that list items with more than three words need periods. Since this is a single reference link, consider if this should have a period - reviewing the guidelines, yes it should since it's more than three words.
Summary
Adding document for enabling .NET migration App Mod in Copilot CLI - The content is still pending to be added, since MCP publish is just decided. This article provides an overview of how .NET developers can migrate their applications to Azure using GitHub Copilot App Modernization within the Copilot CLI, enabling them to modernize applications wherever they code.
Fixes #Issue_Number (if available)
Internal previews