AWS transform documentation change
Summary
Added section about transformation summary reports and chat functionality, improved documentation structure, and fixed grammatical errors
Security assessment
Changes focus on reporting features and user interaction improvements rather than addressing security vulnerabilities or documenting security controls. The added content describes post-transformation analysis capabilities without mentioning security aspects, access controls, or vulnerability mitigation.
Diff
diff --git a/transform/latest/userguide/dotnet-transforming-code.md b/transform/latest/userguide/dotnet-transforming-code.md index 6105a945f..367a6ef98 100644 --- a//transform/latest/userguide/dotnet-transforming-code.md +++ b//transform/latest/userguide/dotnet-transforming-code.md @@ -4,0 +5,2 @@ +Review the transformation summary report + @@ -7 +9,3 @@ -After the AWS account administrator finishes [Reviewing your plan to prepare for transformation](./dotnet-reviewing-plan.html), in AWS Transform, on the _Dashboard_ tab of your transformation job, you can view the transformation progress. +After the AWS account administrator finishes [Reviewing your plan to prepare for transformation](./dotnet-reviewing-plan.html), you can view the transformation progress on the _Dashboard_ tab of your transformation job. + +###### Note @@ -33 +37 @@ You can also see the following icons: -The _Dashboard_ provides high level summary of the transformation. It shows metrics on number of jobs transformed, transformation applied, and estimated time to complete the transformation. +The _Dashboard_ provides a high level summary of the transformation. It shows metrics for the number of jobs transformed and transformation applied, and the estimated time to complete the transformation. @@ -35 +39 @@ The _Dashboard_ provides high level summary of the transformation. It shows metr -The _Dashboard_ includes the following: +The _Dashboard_ includes: @@ -37 +41 @@ The _Dashboard_ includes the following: - 1. The transformation _Job details_ section lists the default settings and details of the transformation job, which include: + 1. The transformation _Job details_ section, which lists the default settings and details of the transformation job, including: @@ -39 +43 @@ The _Dashboard_ includes the following: - 1. _Target branch destination_ To transform you code, AWS Transform creates a new branch for the transformed code in your code repo. + 1. _Target branch destination_ To transform your code, AWS Transform creates a new branch for the transformed code in your code repo. @@ -57 +61 @@ The _Dashboard_ includes the following: - 3. The total lines of codes in these repositories and projects. + 3. The total lines of codes in these repositories and projects @@ -62 +66,3 @@ The _Dashboard_ includes the following: -After the transformation starts, pie charts appear in the _Repository status_ , _Package status_ , and _Unit test status_ sections showing you the number transformed in real time. The _Unit test status_ shows the status of unit tests located in your repositories that AWS Transforms runs after transformation to test the transformed code. AWS Transform will share the executed test results, along with individual test name for customers to review the list of unit tests passed and failed. +After the transformation starts, pie charts appear in the _Repository status_ , _Package status_ , and _Unit test status_ sections displaying progress in real time. The _Unit test status_ shows the status of unit tests located in your repositories that AWS Transforms runs after transformation to test the transformed code. AWS Transform shares the executed test results, along with individual test name for customers to review the list of unit tests passed and failed. + +###### Note @@ -65,0 +72,44 @@ The _Repositories_ section lists the repositories that AWS Transform recommends +## Review the transformation summary report + +After a transformation finishes for a repository, or when the transformation job completes, you can download a transformation summary report. + +Download the transformation summary report from the **Dashboard** tab. Select **Download** , and choose **Download as HTML** or **Download as JSON**. This report provides an overview of the transformation, and information specific to each repository that was transformed, including: + + * Job Details + + * Transformation job overview + + * Transformation results overview + + * Files overview + + * Repositories list, and for each repository: + + * `repository_name` overview + + * Solution Transformation Summary + + * Project Details, including Status, Type, .NET Version, Total Lines of Code, Transformed Lines of Code, and Files Changed + + + + +### Chat with AWS Transform about the transformation report + +You can chat with AWS Transform about the transformation report after a repository has been completely processed or after the transformation job is completed. The **Worklog** tab displays this message for each repository that is available for chat: _Repository`repository_name` transformation details are now available in chat for queries_. It displays this message when the transformation job is completed: _AWS Transform transformation job is completed_. + +To open the chat click the purple hexagonal icon in the lower right corner of the web console. + +Here are some example prompts: + + * Which projects were successfully transformed? + + * Which projects were partially ported? + + * What changes were made to the `repo_name` repository? + + * What packages were upgraded in the `project_name` project? + + + +