Skip to content

Commit 01eb7d9

Browse files
MrHinshMrHinsh
committed
📝 (docs): update YAML documentation with detailed descriptions
Add detailed descriptions to YAML documentation files to improve clarity and usability. This includes specifying the purpose and functionality of various tools, processors, and field maps used in migration scenarios. The changes ensure that users have a better understanding of each component's role and configuration options, facilitating easier setup and customization of migration processes. 📝 (docs): update documentation for TFS tools and improve code structure Update descriptions in documentation files for various TFS tools to provide clearer explanations of their functionalities. This includes adding missing descriptions and correcting existing ones to better reflect the tools' purposes and configurations. Additionally, update file paths in the documentation to remove unnecessary leading slashes, ensuring consistency and correctness. ♻️ (code): refactor ConsoleDataGenerator for improved readability Refactor the ConsoleDataGenerator code to enhance readability and maintainability. This includes removing unused imports, converting fields to readonly where applicable, and improving path handling by using Path.Combine for constructing file paths. These changes aim to make the codebase cleaner and more efficient, reducing potential errors and improving the development experience.
1 parent 55bd081 commit 01eb7d9

File tree

104 files changed

+574
-535
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

104 files changed

+574
-535
lines changed

‎docs/_data/reference.endpoints.azuredevopsendpoint.yaml‎

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -39,32 +39,32 @@ configurationSamples:
3939
"ReflectedWorkItemIdField": "Custom.ReflectedWorkItemId"
4040
}
4141
sampleFor: MigrationTools.Endpoints.AzureDevOpsEndpointOptions
42-
description: missing XML code comments
42+
description: Azure DevOps REST API endpoint implementation for connecting to Azure DevOps organizations. Provides HTTP client access and pipeline-related API operations for migration scenarios.
4343
className: AzureDevOpsEndpoint
4444
typeName: Endpoints
4545
architecture:
4646
options:
4747
- parameterName: AccessToken
4848
type: String
49-
description: missing XML code comments
49+
description: Personal Access Token (PAT) or other authentication token for accessing the Azure DevOps organization. Required for API authentication.
5050
defaultValue: missing XML code comments
5151
- parameterName: AuthenticationMode
5252
type: AuthenticationMode
53-
description: missing XML code comments
53+
description: Authentication mode to use when connecting to Azure DevOps. Typically uses AccessToken for modern Azure DevOps organizations.
5454
defaultValue: missing XML code comments
5555
- parameterName: Organisation
5656
type: String
57-
description: missing XML code comments
57+
description: URL of the Azure DevOps organization (e.g., "https://dev.azure.com/myorganization/"). Must include the full organization URL.
5858
defaultValue: missing XML code comments
5959
- parameterName: Project
6060
type: String
61-
description: missing XML code comments
61+
description: Name of the Azure DevOps project within the organization to connect to. This is the project that will be used for migration operations.
6262
defaultValue: missing XML code comments
6363
- parameterName: ReflectedWorkItemIdField
6464
type: String
65-
description: missing XML code comments
65+
description: Name of the custom field used to store the reflected work item ID for tracking migrated items. Typically "Custom.ReflectedWorkItemId".
6666
defaultValue: missing XML code comments
6767
status: missing XML code comments
6868
processingTarget: missing XML code comments
69-
classFile: /src/MigrationTools.Clients.AzureDevops.Rest/Endpoints/AzureDevOpsEndpoint.cs
70-
optionsClassFile: /src/MigrationTools.Clients.AzureDevops.Rest/Endpoints/AzureDevOpsEndpointOptions.cs
69+
classFile: src/MigrationTools.Clients.AzureDevops.Rest/Endpoints/AzureDevOpsEndpoint.cs
70+
optionsClassFile: src/MigrationTools.Clients.AzureDevops.Rest/Endpoints/AzureDevOpsEndpointOptions.cs

‎docs/_data/reference.endpoints.filesystemworkitemendpoint.yaml‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -27,9 +27,9 @@ architecture:
2727
options:
2828
- parameterName: FileStore
2929
type: String
30-
description: missing XML code comments
30+
description: Path to the directory where work item data will be stored or read from. This should be a valid local file system path with appropriate read/write permissions.
3131
defaultValue: missing XML code comments
3232
status: missing XML code comments
3333
processingTarget: missing XML code comments
34-
classFile: /src/MigrationTools.Clients.FileSystem/Endpoints/FileSystemWorkItemEndpoint.cs
35-
optionsClassFile: /src/MigrationTools.Clients.FileSystem/Endpoints/FileSystemWorkItemEndpointOptions.cs
34+
classFile: src/MigrationTools.Clients.FileSystem/Endpoints/FileSystemWorkItemEndpoint.cs
35+
optionsClassFile: src/MigrationTools.Clients.FileSystem/Endpoints/FileSystemWorkItemEndpointOptions.cs

‎docs/_data/reference.endpoints.tfsendpoint.yaml‎

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -97,25 +97,25 @@ architecture:
9797
options:
9898
- parameterName: Authentication
9999
type: TfsAuthenticationOptions
100-
description: missing XML code comments
100+
description: Authentication configuration for connecting to the TFS server. Supports various authentication modes including Windows authentication and access tokens.
101101
defaultValue: missing XML code comments
102102
- parameterName: Collection
103103
type: Uri
104-
description: missing XML code comments
104+
description: URI of the TFS collection (e.g., "http://tfsserver:8080/tfs/DefaultCollection"). Must be a valid absolute URL pointing to the TFS collection.
105105
defaultValue: missing XML code comments
106106
- parameterName: LanguageMaps
107107
type: TfsLanguageMapOptions
108-
description: missing XML code comments
108+
description: Language mapping configuration for translating area and iteration path names between different language versions of TFS.
109109
defaultValue: missing XML code comments
110110
- parameterName: Project
111111
type: String
112-
description: missing XML code comments
112+
description: Name of the TFS project within the collection to connect to. This is the project that will be used for migration operations.
113113
defaultValue: missing XML code comments
114114
- parameterName: ReflectedWorkItemIdField
115115
type: String
116-
description: missing XML code comments
116+
description: Name of the custom field used to store the reflected work item ID for tracking migrated items. Typically "Custom.ReflectedWorkItemId".
117117
defaultValue: missing XML code comments
118118
status: missing XML code comments
119119
processingTarget: missing XML code comments
120-
classFile: /src/MigrationTools.Clients.TfsObjectModel/EndPoints/TfsEndpoint.cs
121-
optionsClassFile: /src/MigrationTools.Clients.TfsObjectModel/EndPoints/TfsEndpointOptions.cs
120+
classFile: src/MigrationTools.Clients.TfsObjectModel/EndPoints/TfsEndpoint.cs
121+
optionsClassFile: src/MigrationTools.Clients.TfsObjectModel/EndPoints/TfsEndpointOptions.cs

‎docs/_data/reference.endpoints.tfsteamprojectendpoint.yaml‎

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -93,25 +93,25 @@ architecture:
9393
options:
9494
- parameterName: Authentication
9595
type: TfsAuthenticationOptions
96-
description: missing XML code comments
96+
description: Authentication configuration for connecting to the TFS server. Supports various authentication modes including Windows authentication and access tokens.
9797
defaultValue: missing XML code comments
9898
- parameterName: Collection
9999
type: Uri
100-
description: missing XML code comments
100+
description: URI of the TFS collection (e.g., "http://tfsserver:8080/tfs/DefaultCollection"). Must be a valid absolute URL pointing to the TFS collection.
101101
defaultValue: missing XML code comments
102102
- parameterName: LanguageMaps
103103
type: TfsLanguageMapOptions
104-
description: missing XML code comments
104+
description: Language mapping configuration for translating area and iteration path names between different language versions of TFS.
105105
defaultValue: missing XML code comments
106106
- parameterName: Project
107107
type: String
108-
description: missing XML code comments
108+
description: Name of the TFS project within the collection to connect to. This is the project that will be used for migration operations.
109109
defaultValue: missing XML code comments
110110
- parameterName: ReflectedWorkItemIdField
111111
type: String
112-
description: missing XML code comments
112+
description: Name of the custom field used to store the reflected work item ID for tracking migrated items. Typically "Custom.ReflectedWorkItemId".
113113
defaultValue: missing XML code comments
114114
status: missing XML code comments
115115
processingTarget: missing XML code comments
116-
classFile: /src/MigrationTools.Clients.TfsObjectModel/EndPoints/TfsTeamProjectEndpoint.cs
117-
optionsClassFile: /src/MigrationTools.Clients.TfsObjectModel/EndPoints/TfsTeamProjectEndPointOptions.cs
116+
classFile: src/MigrationTools.Clients.TfsObjectModel/EndPoints/TfsTeamProjectEndpoint.cs
117+
optionsClassFile: src/MigrationTools.Clients.TfsObjectModel/EndPoints/TfsTeamProjectEndPointOptions.cs

‎docs/_data/reference.endpoints.tfsteamsettingsendpoint.yaml‎

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -34,25 +34,25 @@ architecture:
3434
options:
3535
- parameterName: Authentication
3636
type: TfsAuthenticationOptions
37-
description: missing XML code comments
37+
description: Authentication configuration for connecting to the TFS server. Supports various authentication modes including Windows authentication and access tokens.
3838
defaultValue: missing XML code comments
3939
- parameterName: Collection
4040
type: Uri
41-
description: missing XML code comments
41+
description: URI of the TFS collection (e.g., "http://tfsserver:8080/tfs/DefaultCollection"). Must be a valid absolute URL pointing to the TFS collection.
4242
defaultValue: missing XML code comments
4343
- parameterName: LanguageMaps
4444
type: TfsLanguageMapOptions
45-
description: missing XML code comments
45+
description: Language mapping configuration for translating area and iteration path names between different language versions of TFS.
4646
defaultValue: missing XML code comments
4747
- parameterName: Project
4848
type: String
49-
description: missing XML code comments
49+
description: Name of the TFS project within the collection to connect to. This is the project that will be used for migration operations.
5050
defaultValue: missing XML code comments
5151
- parameterName: ReflectedWorkItemIdField
5252
type: String
53-
description: missing XML code comments
53+
description: Name of the custom field used to store the reflected work item ID for tracking migrated items. Typically "Custom.ReflectedWorkItemId".
5454
defaultValue: missing XML code comments
5555
status: missing XML code comments
5656
processingTarget: missing XML code comments
57-
classFile: /src/MigrationTools.Clients.TfsObjectModel/EndPoints/TfsTeamSettingsEndpoint.cs
58-
optionsClassFile: /src/MigrationTools.Clients.TfsObjectModel/EndPoints/TfsTeamSettingsEndpointOptions.cs
57+
classFile: src/MigrationTools.Clients.TfsObjectModel/EndPoints/TfsTeamSettingsEndpoint.cs
58+
optionsClassFile: src/MigrationTools.Clients.TfsObjectModel/EndPoints/TfsTeamSettingsEndpointOptions.cs

‎docs/_data/reference.endpoints.tfsworkitemendpoint.yaml‎

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -35,29 +35,29 @@ architecture:
3535
options:
3636
- parameterName: Authentication
3737
type: TfsAuthenticationOptions
38-
description: missing XML code comments
38+
description: Authentication configuration for connecting to the TFS server. Supports various authentication modes including Windows authentication and access tokens.
3939
defaultValue: missing XML code comments
4040
- parameterName: Collection
4141
type: Uri
42-
description: missing XML code comments
42+
description: URI of the TFS collection (e.g., "http://tfsserver:8080/tfs/DefaultCollection"). Must be a valid absolute URL pointing to the TFS collection.
4343
defaultValue: missing XML code comments
4444
- parameterName: LanguageMaps
4545
type: TfsLanguageMapOptions
46-
description: missing XML code comments
46+
description: Language mapping configuration for translating area and iteration path names between different language versions of TFS.
4747
defaultValue: missing XML code comments
4848
- parameterName: Project
4949
type: String
50-
description: missing XML code comments
50+
description: Name of the TFS project within the collection to connect to. This is the project that will be used for migration operations.
5151
defaultValue: missing XML code comments
5252
- parameterName: Query
5353
type: QueryOptions
54-
description: missing XML code comments
54+
description: Gets or sets the query options that define which work items to retrieve from the source endpoint, including WIQL queries and parameters.
5555
defaultValue: missing XML code comments
5656
- parameterName: ReflectedWorkItemIdField
5757
type: String
58-
description: missing XML code comments
58+
description: Name of the custom field used to store the reflected work item ID for tracking migrated items. Typically "Custom.ReflectedWorkItemId".
5959
defaultValue: missing XML code comments
6060
status: missing XML code comments
6161
processingTarget: missing XML code comments
62-
classFile: /src/MigrationTools.Clients.TfsObjectModel/EndPoints/TfsWorkItemEndpoint.cs
63-
optionsClassFile: /src/MigrationTools.Clients.TfsObjectModel/EndPoints/TfsWorkItemEndpointOptions.cs
62+
classFile: src/MigrationTools.Clients.TfsObjectModel/EndPoints/TfsWorkItemEndpoint.cs
63+
optionsClassFile: src/MigrationTools.Clients.TfsObjectModel/EndPoints/TfsWorkItemEndpointOptions.cs

‎docs/_data/reference.fieldmaps.fieldclearmap.yaml‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,7 @@ configurationSamples:
5959
]
6060
}
6161
sampleFor: MigrationTools.Tools.FieldClearMapOptions
62-
description: missing XML code comments
62+
description: Clears a target field by setting its value to null, useful for removing data from specific fields during migration.
6363
className: FieldClearMap
6464
typeName: FieldMaps
6565
architecture:
@@ -70,9 +70,9 @@ options:
7070
defaultValue: missing XML code comments
7171
- parameterName: targetField
7272
type: String
73-
description: missing XML code comments
73+
description: Gets or sets the name of the target field to be cleared/set to null during work item migration.
7474
defaultValue: missing XML code comments
7575
status: missing XML code comments
7676
processingTarget: missing XML code comments
77-
classFile: /src/MigrationTools.Clients.TfsObjectModel/Tools/FieldMappingTool/FieldMaps/FieldClearMap.cs
78-
optionsClassFile: /src/MigrationTools/Tools/FieldMappingTool/FieldMaps/FieldClearMapOptions.cs
77+
classFile: src/MigrationTools.Clients.TfsObjectModel/Tools/FieldMappingTool/FieldMaps/FieldClearMap.cs
78+
optionsClassFile: src/MigrationTools/Tools/FieldMappingTool/FieldMaps/FieldClearMapOptions.cs

‎docs/_data/reference.fieldmaps.fieldliteralmap.yaml‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,7 @@ configurationSamples:
6161
]
6262
}
6363
sampleFor: MigrationTools.Tools.FieldLiteralMapOptions
64-
description: missing XML code comments
64+
description: Maps a literal (static) value to a target field, useful for setting constant values across all migrated work items.
6565
className: FieldLiteralMap
6666
typeName: FieldMaps
6767
architecture:
@@ -72,13 +72,13 @@ options:
7272
defaultValue: missing XML code comments
7373
- parameterName: targetField
7474
type: String
75-
description: missing XML code comments
75+
description: Gets or sets the name of the target field that will be set to the specified literal value.
7676
defaultValue: missing XML code comments
7777
- parameterName: value
7878
type: String
79-
description: missing XML code comments
79+
description: Gets or sets the literal value that will be assigned to the target field during migration.
8080
defaultValue: missing XML code comments
8181
status: missing XML code comments
8282
processingTarget: missing XML code comments
83-
classFile: /src/MigrationTools.Clients.TfsObjectModel/Tools/FieldMappingTool/FieldMaps/FieldLiteralMap.cs
84-
optionsClassFile: /src/MigrationTools/Tools/FieldMappingTool/FieldMaps/FieldLiteralMapOptions.cs
83+
classFile: src/MigrationTools.Clients.TfsObjectModel/Tools/FieldMappingTool/FieldMaps/FieldLiteralMap.cs
84+
optionsClassFile: src/MigrationTools/Tools/FieldMappingTool/FieldMaps/FieldLiteralMapOptions.cs

‎docs/_data/reference.fieldmaps.fieldmergemap.yaml‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -69,7 +69,7 @@ configurationSamples:
6969
]
7070
}
7171
sampleFor: MigrationTools.Tools.FieldMergeMapOptions
72-
description: missing XML code comments
72+
description: Merges values from multiple source fields into a single target field using a specified format template.
7373
className: FieldMergeMap
7474
typeName: FieldMaps
7575
architecture:
@@ -92,5 +92,5 @@ options:
9292
defaultValue: missing XML code comments
9393
status: missing XML code comments
9494
processingTarget: missing XML code comments
95-
classFile: /src/MigrationTools.Clients.TfsObjectModel/Tools/FieldMappingTool/FieldMaps/FieldMergeMap.cs
96-
optionsClassFile: /src/MigrationTools/Tools/FieldMappingTool/FieldMaps/FieldMergeMapOptions.cs
95+
classFile: src/MigrationTools.Clients.TfsObjectModel/Tools/FieldMappingTool/FieldMaps/FieldMergeMap.cs
96+
optionsClassFile: src/MigrationTools/Tools/FieldMappingTool/FieldMaps/FieldMergeMapOptions.cs

‎docs/_data/reference.fieldmaps.fieldskipmap.yaml‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ configurationSamples:
4040
]
4141
}
4242
sampleFor: MigrationTools.Tools.FieldSkipMapOptions
43-
description: missing XML code comments
43+
description: Skips field mapping for a specific target field, effectively leaving the field unchanged during migration.
4444
className: FieldSkipMap
4545
typeName: FieldMaps
4646
architecture:
@@ -51,9 +51,9 @@ options:
5151
defaultValue: missing XML code comments
5252
- parameterName: targetField
5353
type: String
54-
description: missing XML code comments
54+
description: Gets or sets the name of the target field that should be skipped during migration, resetting it to its original value.
5555
defaultValue: missing XML code comments
5656
status: missing XML code comments
5757
processingTarget: missing XML code comments
58-
classFile: /src/MigrationTools.Clients.TfsObjectModel/Tools/FieldMappingTool/FieldMaps/FieldSkipMap.cs
59-
optionsClassFile: /src/MigrationTools/Tools/FieldMappingTool/FieldMaps/FieldSkipMapOptions.cs
58+
classFile: src/MigrationTools.Clients.TfsObjectModel/Tools/FieldMappingTool/FieldMaps/FieldSkipMap.cs
59+
optionsClassFile: src/MigrationTools/Tools/FieldMappingTool/FieldMaps/FieldSkipMapOptions.cs

0 commit comments

Comments
 (0)