You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: ToolGuides/toolkit-for-refactoring/01-Prerequisites/01-Setup.md
+2Lines changed: 2 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -13,3 +13,5 @@ In order to follow this guide, you will need to have a development environment.
13
13
This guide assumes that in addition to having Windows set up, you have already installed the tools listed above, and that you have configured access to your AWS Account for the command line. If you have not already done so, please complete the installation and configuration before proceeding.
Copy file name to clipboardExpand all lines: ToolGuides/toolkit-for-refactoring/01-Prerequisites/03-Sample-Tour.md
+2Lines changed: 2 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -43,3 +43,5 @@ You will then be brought back to the image list view. The image will no longer h
43
43
This completes the tour of the Media Catalog application. Feel free to spend more time looking around at the application and becoming familiar with the other functions that are available before moving on to the next part of the guide.
# Installing the AWS Toolkit for .NET Modernization
2
2
3
-
The AWS Toolkit for .NET Refactoring installs in Visual Studio as an Extension. If you don't have visual Studio open, start it now and select the option to continue without code.
3
+
The AWS Toolkit for .NET Refactoring installs in Visual Studio as an extension. If you don't have Visual Studio open, start it now and select the option to continue without code.
4
4
5
5
6
6
7
7
From Visual Studio, click on the Extensions menu item, and then click on Manage Extensions.
8
8
9
-
9
+
10
10
11
-
Make sure the option to search for “Online” extensions is selected. Then type “AWS” in the search field. Your extensions list will be filtered down. From this menu you can select the “AWS Toolkit for .NET Refactoring VA 2022” from the menu. Once selected, click the Download button.
11
+
Make sure the option to search for “Online” extensions is selected. Then type “AWS” in the search field. Your extensions list will be filtered down. From this menu you can select the “AWS Toolkit for .NET Refactoring VS 2022” from the menu. Once selected, click the Download button.
12
12
13
-
13
+
14
14
15
-
Once the download has been completed, you will receive a message that the changes will be scheduled once Visual Studio is closed. At this point click the Close button, and shut down visual Studio.
15
+
Once the download has been completed, you will receive a message that the changes will be scheduled once Visual Studio is closed. At this point, click the Close button, and shut down Visual Studio.
The first step in using the AWS Toolkit for .NET Refactoring to refactor your application from .NET Framewor 4.8 to .NET 6 is to perform
4
-
an assessment of the applciation. This assessment will scan through your application code, dependancies and NUGet packages to help determine
5
-
the level of complexity with converting your applciation.
3
+
The first step in using the AWS Toolkit for .NET Refactoring to refactor your application from .NET Framework 4.8 to .NET 6 is to perform
4
+
an assessment of the current application. This assessment will scan through your application code, dependencies and NuGet packages to help determine the level of complexity with converting your application.
6
5
7
-
The assessment is non destructive, the results of the assesssment is a report.
6
+
The assessment is nondestructive, the results of the assessment is a report.
If the tooklit does not automatically open the Getting started page below, you can manually launch the Getting started page by clicking on the Extensions menu, select the AWS Toolkit for .NET Refactoring, and then clicking on Getting Started.
14
+
If the toolkit does not automatically open the Getting Started page below, you can manually launch the Getting Started page by clicking on the extensions menu, select the AWS Toolkit for .NET Refactoring, and then clicking on Getting Started.
In order tp progress beyond the first page, you must click on the link under the End User License Agreement (EULA.) Click on this link and read the agreement on the linked page.
24
+
In order to progress beyond the first page, you must click on the link under the End User License Agreement (EULA.) Click on this link and read the agreement on the linked page.
26
25
27
-
The first configuration option is to select how the toolkit will connect to AWS. You have two options for these details. First you can specify a named profile that has been configured by the AWS Command Line. In this case you have an access key and a secret key configured on your machine. Typically these credentials are stored by using the command:
26
+
The first configuration option is to select how the toolkit will connect to AWS. You have two options for these details. First, you can specify a named profile that has been configured by the AWS Command Line. In this case you have an access key and a secret key configured on your machine. Typically, these credentials are stored by using the command:
28
27
```
29
28
aws configure
30
29
```
31
30
And then providing credentials.
32
31
33
-
The second option is to allow the tool to locate credentials automatically. This option will allow the tool to use credentials that have been imported via IAM Identity Center (Formerly SSO) or inherit credentials from an IAM Role for example.
32
+
The second option is to allow the tool to locate credentials automatically. This option will allow the tool to use credentials that were obtained via IAM Identity Center (Formerly SSO) or inherit credentials from an IAM Role attached to an EC2 Instance.
34
33
35
-
Functionality for the application will be identical with either method, as long as the selected method has valid credentials into your AWS account. If you are unsure of which option to use, consult with your AWS Account Administrator as they may have policies that determine the prefered method for obtaining AWS Credentials.
34
+
Functionality for the application will be identical with either method, as long as the selected method has valid credentials for your AWS account. If you are unsure of which option to use, consult with your AWS Account Administrator as they may have policies that determine which method is to be used for obtaining AWS Credentials.
36
35
37
-
The second configuration option that needs to be set is the region for test deployments. Currently for this option you can select either "US-EAST-2" or "EU-WEST-2." Note that this selection applies **only** to the test deployments conducted by the toolkit. You have the option to deploy your applications to any AWS region once you are happy with the refactoring.
36
+
The second configuration option that needs to be set is the region for test deployments. Currently, you can select either "US-EAST-2" or "EU-WEST-2." Note that this selection applies **only** to the test deployments conducted by the toolkit. You have the option to deploy your applications to any AWS region once you are happy with the refactoring.
38
37
39
-
Once all of these options have been completed, click Next.
38
+
Once these options have been completed, click Next.
40
39
41
40
## Starting the Assessment
42
41
43
-
After configuring the toolkit, and clicking next, you are presented with the Refactoring Dashboard.
42
+
After configuring the toolkit, you are presented with the Refactoring Dashboard.
44
43
45
44
46
45
47
-
At this point, the Assessment is listed as "Not Started." As a result other refacoting toolkit functionality may not be avaialble. In order to perform an assessment, you fist need to open one of the code files in the solution. Double click on the "HomeController.cs" file to open it, then click back on the the Dashboard Window.
46
+
At this point, the Assessment is listed as "Not Started." As a result other toolkit functionality may not be available. In order to perform an assessment, you fist need to open one of the code files in the solution. Double click on the "HomeController.cs" file to open it, then click back on the Dashboard Window.
48
47
49
48
50
49
51
-
From this window select the option to "Start Assessment" to begin the scanning process for your applciation.
50
+
From this window select the option to "Start Assessment" abd the toolkit will begin inspecting your application.
52
51
53
52
54
53
55
54
The status on the dashboard will change to "In Progress" while the scanning takes place.
56
55
57
56
58
57
59
-
Once your assessment has been completed, you will receive an assessment report below.
58
+
Once your assessment is complete, you will receive an assessment report below.
60
59
61
-
### Incompatable NuGet packages
60
+
### Incompatible NuGet packages
62
61
63
-
This lists the number of packages that as included in the solution that are not compatable with the terget version of .NET. In this case .NET 6. Note that for these packages, you will have to find alternatives for the incompatable functioanlity.
62
+
This lists the number of packages that as included in the solution that are not compatible with the target version of .NET in this case .NET 6. Note that for these packages, you will need to find alternatives for the required functionality.
64
63
65
-
### Incompatable APIs
64
+
### Incompatible APIs
66
65
67
-
This lists the number of API calls that are not portable to the new version of .NET. In some cases this may be locations where functionality has been depricated, the API Calls have changes, or other manual coding effort is requiredto make the code compatable with the new target version.
66
+
This lists the number of API calls that are not portable to the new version of .NET. This may be cases where functionality has been deprecated or the API calls have breaking changes. Manual coding effort will be required, after porting, to make the code compatible with the new target version of .NET.
68
67
69
-
These options represent the amount of manual work, that the toolkit was able to identify, that will be requred after the toolkit ports the applciation to the new version of .NET. It is important to understand that these are the incompatabbilities that the tool was able to identify, it is not nexessarily all of the changes that are necessary. You may find code that needs to be reworked after porting your solution.
68
+
These options provide hints to the amount of manual work, that the toolkit was able to identify, requred after the porting. It is important to understand that these are the incompatibilities that the tool was able to identify, it is not necessarily all of the changes that will be required. You may find code that needs to be reworked when you test your application after porting.
70
69
71
-
Further details of the incompatable code can be found by looking at the error list, and selecting to view Warnings. EEach item in the list indicates some manual effor thtta you will have to complete.
70
+
Further details of the incomparable code can be found by looking at the error list, and selecting to view Warnings. Each item in the list shows some manual effort that you will have to complete.
Once your assessment has been completed, you are able to port your project to the desired vbersion of .NET.
2
+
Once your assessment has been completed, you are able to port your project to the desired version of .NET.
3
3
4
4
## Warning:
5
-
Porting applciation code is destructive. You can't undo the changes once the pocess of porting your solution has begun. Before going down the path of porting your applciation code ensure that you have a backup copy of your source code.
5
+
Porting application code is destructive. You can't undo the changes once the process of porting your solution has begun. Backup all source code before progressing.
6
6
7
7
## Start porting your application
8
8
9
-
You start the porting process for your applciation from the assessment dashboard. The project to be ported in the Solution Explorer, then With the active project selected click the Port drop down, and thel click "Port selected project."
9
+
You start the porting process for your application from the assessment dashboard. Select the project to be ported in the Solution Explorer, then click the Port drop down, and click "Port selected project."
10
10
11
11
12
12
13
-
At this point you receive one final warning that the process is perminant.
13
+
At this point you receive one final warning that the process is permanent.
14
14
15
15
16
16
17
-
Check the confirmation and then click the Port button. The time required for portin your application will vary depending on the size of the solution, number of projects, etc. Once porting has been completed, you will receive a message indicating thet porting has been successful.
17
+
Check the confirmation and then click the Port button. The time required for porting your application will vary depending on the size of the solution, number of projects, etc. This sample project completes quickly. Once porting has been completed, you will receive a message showing that porting has been successful.
18
18
19
19
20
20
@@ -26,5 +26,8 @@ Once your project has been reloaded, the dashboard will look like this.
26
26
27
27
28
28
29
-
This completes the porting of your applciation. However if you attempt to run the applciation now, you will notice that the applciation does not compile. You will need to move onto the manual refactoring stage in order to complete the move to .NET 6.
29
+
This completes the porting of your application. However, if you attempt to run the application now, the application will not compile. You will need to move onto the manual refactoring stage in order to complete the move to .NET 6.
0 commit comments