AWS transform documentation change
Summary
Restructured documentation about repository confirmation process, added repository summary report details, reorganized default settings section, and updated chat interaction instructions
Security assessment
Changes focus on workflow improvements and documentation clarity without mentioning security vulnerabilities, access controls, or data protection measures. The content deals with transformation plan customization and report analysis rather than security mechanisms.
Diff
diff --git a/transform/latest/userguide/dotnet-confirming-repos.md b/transform/latest/userguide/dotnet-confirming-repos.md index 43d3a8455..dc40a61d7 100644 --- a//transform/latest/userguide/dotnet-confirming-repos.md +++ b//transform/latest/userguide/dotnet-confirming-repos.md @@ -5 +5 @@ -Default SettingsUse the plan generated by AWS TransformUse AWS Transform chat to learn more Customize the transformation plan +Default SettingsReview the repository summary report @@ -9 +9 @@ Default SettingsUse the plan generated by AWS TransformUse AWS Transform chat to -After [Creating a source code repository connector](./dotnet-creating-repo-connector.html), you _Confirm your repositories_ as the first step of _Preparing for transformation_. You can review the AWS Transform generated transformation plan and select to use this plan or customize the transformation plan. You can customize the plan using the web app or by downloading a JSON file, modifying it, and uploading it to AWS Transform. +After [Creating a source code repository connector](./dotnet-creating-repo-connector.html), confirm your repositories as the first step of preparing for transformation. You can: @@ -11,3 +11 @@ After [Creating a source code repository connector](./dotnet-creating-repo-conne -## Default Settings - -In the **Job details** section of the **Collaboration** tab, you can set the following: + * Review and change Default Settings that affect the plan contents. @@ -15 +13 @@ In the **Job details** section of the **Collaboration** tab, you can set the fol - * Exclude .NET Standard projects from the transformation plan + * [ Review repository summaries](https://docs.aws.amazon.com/transform/latest/userguide/dotnet-confirming-repos.html#review-repository-summary) and chat with AWS Transform about its contents. @@ -17 +15 @@ In the **Job details** section of the **Collaboration** tab, you can set the fol -This setting is selected by default. When selected, AWS Transform excludes any .NET Standard projects from the transformation plan. If you deselect this setting, .NET Standard projects will be transformed, which will make them no longer compatible with the .NET Framework. + * [Use the plan generated by AWS Transform](./dotnet-web-app.html#use-generated-plan). @@ -19 +17 @@ This setting is selected by default. When selected, AWS Transform excludes any . - * Transform Model-View Controller (MVC) Razor Views to ASP.NET Core Razor + * [Customize the transformation plan](./dotnet-web-app.html#customize-plan) using the web app or by downloading a JSON file, modifying it, and uploading it to AWS Transform. @@ -21 +18,0 @@ This setting is selected by default. When selected, AWS Transform excludes any . -This setting is selected by default. When selected, AWS Transform handles the transformation of any MVC Razor View UI layers into ASP.NET Core Razor Views. If you deselect this option, you must transform these UI layers manually. @@ -23 +19,0 @@ This setting is selected by default. When selected, AWS Transform handles the tr -For the UI layer, only the transformation of MVC Razor Views to ASP.NET core is supported. UI Layers for WebForms (.aspx), MVC Views (.cshtml), Windows Presentation Foundation (WPF), WinForms, and Blazor UI components must be transformed manually. @@ -25,0 +22 @@ For the UI layer, only the transformation of MVC Razor Views to ASP.NET core is +## Default Settings @@ -26,0 +24 @@ For the UI layer, only the transformation of MVC Razor Views to ASP.NET core is +In the **Job details** section of the **Collaboration** tab, you can set the following: @@ -28 +26 @@ For the UI layer, only the transformation of MVC Razor Views to ASP.NET core is -On the _Collaboration_ tab, AWS Transform gives you two options: + * Exclude .NET Standard projects from the transformation plan @@ -30 +28 @@ On the _Collaboration_ tab, AWS Transform gives you two options: - * Use the plan generated by AWS Transform +This setting is selected by default. When selected, AWS Transform excludes any .NET Standard projects from the transformation plan. If you deselect this setting, .NET Standard projects will be transformed, which will make them no longer compatible with the .NET Framework. @@ -32 +30 @@ On the _Collaboration_ tab, AWS Transform gives you two options: - * Use AWS Transform chat to learn more + * Transform Model-View Controller (MVC) Razor Views to ASP.NET Core Razor @@ -33,0 +32 @@ On the _Collaboration_ tab, AWS Transform gives you two options: +This setting is selected by default. When selected, AWS Transform handles the transformation of any MVC Razor View UI layers into ASP.NET Core Razor Views. If you deselect this option, you must transform these UI layers manually. @@ -34,0 +34 @@ On the _Collaboration_ tab, AWS Transform gives you two options: +For the UI layer, only the transformation of MVC Razor Views to ASP.NET core is supported. UI Layers for WebForms (.aspx), MVC Views (.cshtml), Windows Presentation Foundation (WPF), WinForms, and Blazor UI components must be transformed manually. @@ -37 +36,0 @@ On the _Collaboration_ tab, AWS Transform gives you two options: -## Use the plan generated by AWS Transform @@ -39 +37,0 @@ On the _Collaboration_ tab, AWS Transform gives you two options: -You can choose to use the AWS Transform plan created from discovering repositories with a higher probability of transformation success, which includes the last modified, root, and cross-dependent repositories. @@ -41 +39 @@ You can choose to use the AWS Transform plan created from discovering repositori -AWS Transform lists some high level details about the transformation plan, which include: +## Review the repository summary report @@ -43 +41 @@ AWS Transform lists some high level details about the transformation plan, which - * _Total number of repositories discovered_ This number of legacy .NET repositories that AWS Transform discovered using your source code repository connector. AWS Transform can scan a maximum of 1,000 repositories in each job. If you have more repositories to scan or transform, you can create multiple transformation jobs. +The repository summmary report provides a tabular view of information about each repository detected by AWS Transform. This includes: @@ -45 +43 @@ AWS Transform lists some high level details about the transformation plan, which - * _Selected repositories_ The number of legacy .NET repositories that AWS Transform selected for transformation. + * Repository Owner @@ -47 +45 @@ AWS Transform lists some high level details about the transformation plan, which - * _Selected dependencies_ The number of dependencies that the selected repositories require, which AWS Transform auto-detected and added to the transformation plan. + * Assessed Branch @@ -48,0 +47 @@ AWS Transform lists some high level details about the transformation plan, which + * No. of solutions @@ -49,0 +49 @@ AWS Transform lists some high level details about the transformation plan, which + * No. of projects @@ -50,0 +51 @@ AWS Transform lists some high level details about the transformation plan, which + * Total Lines of Code @@ -52 +53 @@ AWS Transform lists some high level details about the transformation plan, which -The _Selected repositories_ table lists the selected repositories. You can search repositories by name, navigate to additional pages of repositories, and download a JSON formatted file that lists the selected repositories and their dependencies. You can make any changes in this view. + * Detected .NET Versions @@ -54 +55 @@ The _Selected repositories_ table lists the selected repositories. You can searc -The _Selected repositories_ table lists the following details about the repositories that AWS Transform selected for transformation: + * Detected Project Types @@ -56 +57 @@ The _Selected repositories_ table lists the following details about the reposito - * Repository name + * No. of Private Nuget Dependencies @@ -58 +59 @@ The _Selected repositories_ table lists the following details about the reposito - * Source branch + * No. of Public Nuget Dependencies @@ -60 +61 @@ The _Selected repositories_ table lists the following details about the reposito - * Last modified date and time + * Transformation Complexity @@ -62 +62,0 @@ The _Selected repositories_ table lists the following details about the reposito - * Lines of code This allows you to see if you're approaching your quota limits. For more information, see [Quotas for AWS Transform](./transform-limits.html). @@ -64 +63,0 @@ The _Selected repositories_ table lists the following details about the reposito - * Dependent repositories You can click on the number of dependent repositories to view more details about these dependencies. @@ -66,0 +66 @@ The _Selected repositories_ table lists the following details about the reposito +To download the file: @@ -67,0 +68 @@ The _Selected repositories_ table lists the following details about the reposito + 1. In your workspace, select the **Collaboration** tab. @@ -69 +70 @@ The _Selected repositories_ table lists the following details about the reposito -If you are happy with the AWS Transform generated transformation plan, select **Confirm repositories**. + 2. In the **Choose repositories** pane, select **Download** , and choose **Download as HTML** or **Download as JSON** @@ -71 +71,0 @@ If you are happy with the AWS Transform generated transformation plan, select ** -If you would like to make changes to the AWS Transform generated transformation plan, select Use AWS Transform chat to learn more . @@ -73 +72,0 @@ If you would like to make changes to the AWS Transform generated transformation -## Use AWS Transform chat to learn more @@ -75 +73,0 @@ If you would like to make changes to the AWS Transform generated transformation -Your transformation report is available for chat queries after a repository has been completely processed, or after the transformation job completes. The **Worklog** tab displays the message **Repository`repository_name` transformation details are now available in chat for queries** for each repository. @@ -77 +75 @@ Your transformation report is available for chat queries after a repository has -To open the chat click the purple hexagonal icon in the lower right corner of the web console. +### Chat about the repository summary report @@ -79 +77 @@ To open the chat click the purple hexagonal icon in the lower right corner of th -You can make requests such as: +Your repository summary may be very long. Use chat to better understand its contents. Your report is available for chat when you see this message on the **Worklog** tab: _Assessment report is now available in chat for queries_. To open the chat click the purple hexagonal icon in the lower right corner of the web console. Here are some example prompts: @@ -90,25 +87,0 @@ You can make requests such as: -## Customize the transformation plan - -If you choose not to Use the plan generated by AWS Transform, you can customize the list of repositories to transform using one of the following options: - - 1. Select repositories in the **Selected repositories** table. - - 1. When you add a repository to the plan, AWS Transform will select the repository's dependencies for you and automatically add them to the transformation plan. - - 2. You can also deselect repositories in the table. - - 2. Download the AWS Transform generated JSON list of repos and branches. - - 1. Selected _Download list_. - - 2. After you review and modify the JSON list, upload it here by selecting _Upload customized plan_. - - 3. If the JSON uploads successfully, the _Selected repositories_ table displays the selections you made. - - 3. You can select **Show dependent repos** to display the list of repositories that AWS Transform discovered are dependencies for the repositories you selected. - - 4. You can repeat these steps, if needed. When you are happy with your customized plan, select **Confirm repositories**. - - - -