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
Refactor documentation descriptions in JSON schemas to improve readability
- Updated descriptions in various JSON schema files to include line breaks for better formatting.
- Enhanced clarity in descriptions for processors and tools related to TFS migration.
- Adjusted code documentation in the ConsoleDataGenerator to utilize a new Markdown conversion method for XML documentation.
description: ExportUsersForMappingContext is a tool used to create a starter mapping file for users between the source and target systems. Use `ExportUsersForMappingConfig` to configure.
29
+
description: >-
30
+
ExportUsersForMappingContext is a tool used to create a starter mapping file for users between the source and target systems.
description: Set to `true`, if you want to export all users in source and target server. The lists of user can be useful, if you need tu manually edit mapping file. Users will be exported to file set in `UserExportFile`.
49
+
description: >-
50
+
Set to `true`, if you want to export all users in source and target server.
51
+
The lists of user can be useful, if you need tu manually edit mapping file.
52
+
Users will be exported to file set in `UserExportFile`.
description: Path to export file where all source and target servers' users will be exported. Users are exported only if `ExportAllUsers` is set to `true`.
82
+
description: >-
83
+
Path to export file where all source and target servers' users will be exported.
84
+
Users are exported only if `ExportAllUsers` is set to `true`.
description: Use user mapping file from TfsTeamSettingsTool when matching users when migrating capacities. By default, users in source are matched in target users by current display name. When this is set to `true`, users are matched also by mapped name from user mapping file.
97
+
description: >-
98
+
Use user mapping file from TfsTeamSettingsTool when matching users when migrating capacities.
99
+
By default, users in source are matched in target users by current display name. When this is set to `true`,
100
+
users are matched also by mapped name from user mapping file.
description: 'This flag filters all test plans and retains only the specified ones for migration. Pass the test plan IDs as an array. Example: "TestPlanIds": [123, 456, 789] Works optimally when "TestPlanQuery" is set to null.'
98
+
description: >-
99
+
This flag filters all test plans and retains only the specified ones for migration. Pass the test plan IDs as an array. Example: "TestPlanIds": [123, 456, 789]
100
+
Works optimally when "TestPlanQuery" is set to null.
description: This loads all of the work items already saved to the Target and removes them from the Source work item list prior to commencing the run. While this may take some time in large data sets it reduces the time of the overall migration significantly if you need to restart.
49
+
description: >-
50
+
This loads all of the work items already saved to the Target and removes them from the Source work item list prior to commencing the run.
51
+
While this may take some time in large data sets it reduces the time of the overall migration significantly if you need to restart.
description: '**beta** If set to a number greater than 0 work items that fail to save will retry after a number of seconds equal to the retry count. This allows for periodic network glitches not to end the process.'
93
+
description: >-
94
+
**beta** If set to a number greater than 0 work items that fail to save will retry after a number of seconds equal to the retry count.
95
+
This allows for periodic network glitches not to end the process.
description: The `WorkItemDelete` processor allows you to delete any amount of work items that meet the query. **DANGER:** This is not a recoverable action and should be use with extream caution.
30
+
description: >-
31
+
The `WorkItemDelete` processor allows you to delete any amount of work items that meet the query.
32
+
**DANGER:** This is not a recoverable action and should be use with extream caution.
description: WorkItemMigrationConfig is the main processor used to Migrate Work Items, Links, and Attachments. Use `WorkItemMigrationConfig` to configure.
73
+
description: >-
74
+
WorkItemMigrationConfig is the main processor used to Migrate Work Items, Links, and Attachments.
description: This loads all of the work items already saved to the Target and removes them from the Source work item list prior to commencing the run. While this may take some time in large data sets it reduces the time of the overall migration significantly if you need to restart.
99
+
description: >-
100
+
This loads all of the work items already saved to the Target and removes them from the Source work item list prior to commencing the run.
101
+
While this may take some time in large data sets it reduces the time of the overall migration significantly if you need to restart.
description: "**beta** If enabled this will fix any image attachments URL's, work item mention URL's or user mentions in the HTML fields as well as discussion comments. You must specify a PersonalAccessToken in the Source project for Azure DevOps; TFS should use integrated authentication."
107
+
description: >-
108
+
**beta** If enabled this will fix any image attachments URL's, work item mention URL's or user mentions in the HTML
109
+
fields as well as discussion comments. You must specify a PersonalAccessToken in the Source project for Azure DevOps;
description: The maximum number of failures to tolerate before the migration fails. When set above zero, a work item migration error is logged but the migration will continue until the number of failed items reaches the configured value, after which the migration fails.
122
+
description: >-
123
+
The maximum number of failures to tolerate before the migration fails. When set above zero, a work item migration error is logged but the migration will
124
+
continue until the number of failed items reaches the configured value, after which the migration fails.
description: "If this is enabled the creation process on the target project will create the items with the original creation date. (Important: The item history is always pointed to the date of the migration, it's change only the data column CreateDate, not the internal create date)"
166
+
description: >-
167
+
If this is enabled the creation process on the target project will create the items with the original creation date.
168
+
(Important: The item history is always pointed to the date of the migration, it's change only the data column CreateDate,
description: "If this is enabled the creation process on the target project will create the items with the original creation date. (Important: The item history is always pointed to the date of the migration, it's change only the data column CreateDate, not the internal create date)"
175
+
description: >-
176
+
If this is enabled the creation process on the target project will create the items with the original creation date.
177
+
(Important: The item history is always pointed to the date of the migration, it's change only the data column CreateDate,
description: '**beta** If set to a number greater than 0 work items that fail to save will retry after a number of seconds equal to the retry count. This allows for periodic network glitches not to end the process.'
190
+
description: >-
191
+
**beta** If set to a number greater than 0 work items that fail to save will retry after a number of seconds equal to the retry count.
192
+
This allows for periodic network glitches not to end the process.
description: This loads all of the work items already saved to the Target and removes them from the Source work item list prior to commencing the run. While this may take some time in large data sets it reduces the time of the overall migration significantly if you need to restart.
48
+
description: >-
49
+
This loads all of the work items already saved to the Target and removes them from the Source work item list prior to commencing the run.
50
+
While this may take some time in large data sets it reduces the time of the overall migration significantly if you need to restart.
description: '**beta** If set to a number greater than 0 work items that fail to save will retry after a number of seconds equal to the retry count. This allows for periodic network glitches not to end the process.'
86
+
description: >-
87
+
**beta** If set to a number greater than 0 work items that fail to save will retry after a number of seconds equal to the retry count.
88
+
This allows for periodic network glitches not to end the process.
description: Work item type validation processor. Basically it just runs the `TfsWorkItemTypeValidatorTool` to validate work item types. The validation is run always, even if the tool iself is disabled. Neither this processor, nor the tool do not perform any changes to the source or target system.
26
+
description: >-
27
+
Work item type validation processor. Basically it just runs the `TfsWorkItemTypeValidatorTool`
28
+
to validate work item types. The validation is run always, even if the tool iself is disabled.
29
+
Neither this processor, nor the tool do not perform any changes to the source or target system.
description: If set to `true`, migration process will stop if there are some validation errors. If set to `false`, migration process will continue, for example to support some other validation processors. Default value is `true`.
59
+
description: >-
60
+
If set to `true`, migration process will stop if there are some validation errors.
61
+
If set to `false`, migration process will continue, for example to support some other validation
description: '`AttachmentMigration` is set to true then you need to specify a max file size for upload in bites. For Azure DevOps Services the default is 480,000,000 bites (60mb), for TFS its 32,000,000 bites (4mb).'
69
+
description: >-
70
+
`AttachmentMigration` is set to true then you need to specify a max file size for upload in bites.
71
+
For Azure DevOps Services the default is 480,000,000 bites (60mb), for TFS its 32,000,000 bites (4mb).
description: By default, only child nodes in node structures are migrated. Turning this on migrates even the root node (default area/iteration). This is useful, when you do not have any child areas ion source, but want to migrate default area in source to some sub-area in target project. You have to set proper mapping for this to work. If after mapping the target node is still just root node (so it is not migrated under some child node), nothing happens – so migrating root nodes works only if the are remapped to some child node in target project.
118
+
description: >-
119
+
By default, only child nodes in node structures are migrated. Turning this on migrates even the root node
120
+
(default area/iteration). This is useful, when you do not have any child areas ion source, but want to migrate
121
+
default area in source to some sub-area in target project. You have to set proper mapping for this to work.
122
+
If after mapping the target node is still just root node (so it is not migrated under some child node),
123
+
nothing happens – so migrating root nodes works only if the are remapped to some child node in target project.
0 commit comments