Update Docs and Defaults (#2392)

It seams like LanguageMaps is really confusing for folks. I'm removing it from the Sample but keeping the defaults.
nkdAgility · Sep 24, 2024 · aa4680f · aa4680f
2 parents cf9e444 + 1463259
commit aa4680f
Show file tree

Hide file tree

Showing 114 changed files with 633 additions and 685 deletions.
diff --git a/appsettings.json b/appsettings.json
@@ -17,6 +17,7 @@
  "Collection": "",
  "Project": "",
  "AllowCrossProjectLinking": false,
+ "ReflectedWorkItemIdField": "Custom.ReflectedWorkItemId",
  "Authentication": {
  "AuthenticationMode": "AccessToken",
  "AccessToken": "",
@@ -36,6 +37,7 @@
  "Collection": "",
  "Project": "",
  "AllowCrossProjectLinking": false,
+ "ReflectedWorkItemIdField": "Custom.ReflectedWorkItemId",
  "Authentication": {
  "AuthenticationMode": "AccessToken",
  "AccessToken": "",
@@ -57,6 +59,7 @@
  "Collection": "https://dev.azure.com/nkdagility-preview/",
  "Project": "migrationSource1",
  "AllowCrossProjectLinking": false,
+ "ReflectedWorkItemIdField": "Custom.ReflectedWorkItemId",
  "Authentication": {
  "AuthenticationMode": "AccessToken",
  "AccessToken": "jklsadhjksahfkjsdhjksahsadjhksadhsad",
@@ -65,16 +68,13 @@
  "Password": "",
  "Domain": ""
  }
- },
- "LanguageMaps": {
- "AreaPath": "Area",
- "IterationPath": "Iteration"
  }
  },
  "TfsEndpoint": {
  "Collection": "https://dev.azure.com/nkdagility-preview/",
  "Project": "migrationSource1",
  "AllowCrossProjectLinking": false,
+ "ReflectedWorkItemIdField": "Custom.ReflectedWorkItemId",
  "Authentication": {
  "AuthenticationMode": "AccessToken",
  "AccessToken": "jklsadhjksahfkjsdhjksahsadjhksadhsad",
@@ -93,7 +93,8 @@
  "AuthenticationMode": "AccessToken",
  "AccessToken": "jklsadhjksahfkjsdhjksahsadjhksadhsad",
  "Organisation": "https://dev.azure.com/xxx/",
- "Project": "myProject"
+ "Project": "myProject",
+ "ReflectedWorkItemIdField": "Custom.ReflectedWorkItemId"
  }
  },
  "CommonTools": {
@@ -446,21 +447,10 @@
  },
  "TfsWorkItemMigrationProcessor": {
  "Enabled": false,
- "UpdateCreatedDate": true,
- "UpdateCreatedBy": true,
  "WIQLQuery": "SELECT [System.Id] FROM WorkItems WHERE [System.TeamProject] = @TeamProject AND [System.WorkItemType] NOT IN ('Test Suite', 'Test Plan','Shared Steps','Shared Parameter','Feedback Request') ORDER BY [System.ChangedDate] desc",
- "FixHtmlAttachmentLinks": true,
- "WorkItemCreateRetryLimit": 5,
  "FilterWorkItemsThatAlreadyExistInTarget": false,
- "PauseAfterEachWorkItem": false,
- "AttachRevisionHistory": false,
- "GenerateMigrationComment": true,
  "SourceName": "Source",
- "TargetName": "Target",
- "WorkItemIDs": [],
- "MaxGracefulFailures": 0,
- "SkipRevisionWithInvalidIterationPath": false,
- "SkipRevisionWithInvalidAreaPath": false
+ "TargetName": "Target"
  },
  "ExportUsersForMappingProcessor": {
  "Enabled": true,

diff --git a/docs/Reference/Generated/MigrationTools.Clients.TfsObjectModel.xml b/docs/Reference/Generated/MigrationTools.Clients.TfsObjectModel.xml
diff --git a/docs/Reference/Generated/MigrationTools.xml b/docs/Reference/Generated/MigrationTools.xml
diff --git a/...PlansAndSuitesMigrationProcessor-notes.md → ...PlansAndSuitesMigrationProcessor-notes.md b/...PlansAndSuitesMigrationProcessor-notes.md → ...PlansAndSuitesMigrationProcessor-notes.md
diff --git a/...orkItemMigrationProcessor-introduction.md → ...orkItemMigrationProcessor-introduction.md b/...orkItemMigrationProcessor-introduction.md → ...orkItemMigrationProcessor-introduction.md
diff --git a/...ssors/WorkItemMigrationProcessor-notes.md → ...rs/TfsWorkItemMigrationProcessor-notes.md b/...ssors/WorkItemMigrationProcessor-notes.md → ...rs/TfsWorkItemMigrationProcessor-notes.md
@@ -1,6 +1,6 @@
-## <a name="WIQLQueryBits"></a>WIQL Query Bits
+## <a name="WIQLQuery"></a>WIQL Query
 
-The Work Item queries are all built using Work Item [Query Language (WIQL)](https://docs.microsoft.com/en-us/azure/devops/boards/queries/wiql-syntax).
+The Work Item queries are all built using Work Item [Query Language (WIQL)](https://docs.microsoft.com/en-us/azure/devops/boards/queries/wiql-syntax). We only support flat quereis that have `FROM WorkItems` in the query. 
 
 > Note: A useful Azure DevOps Extension to explore WIQL is the [WIQL Editor](https://marketplace.visualstudio.com/items?itemName=ottostreifel.wiql-editor)
 
@@ -21,11 +21,11 @@ Scope to Area Path (Team data):
 
 ## <a name="NodeBasePath"></a>NodeBasePath Configuration 
 
-Moved to the ProcessorEnricher [TfsNodeStructure](/Reference/v2/ProcessorEnrichers/TfsNodeStructure/)
+Moved to the TfsNodeStructure
 
 # Iteration Maps and Area Maps
 
-Moved to the ProcessorEnricher [TfsNodeStructure](/Reference/v2/ProcessorEnrichers/TfsNodeStructure/)
+Moved to the TfsNodeStructure
 
 
 
@@ -34,7 +34,7 @@ The above options allow you to bring over a sub-set of the WIs (using the `WIQLQ
 
 Using the above sample structure, if you wanted to map the source project `Team 1` to target project `Team A` etc. you could add the field map as follows
 
-A complete list of [FieldMaps](../Reference/v1/FieldMaps/index.md) are available.
+A complete list of [FieldMaps](../Reference/FieldMaps/index.md) are available.
 
 ```
  "FieldMaps": [

diff --git a/docs/_data/reference.endpoints.azuredevopsendpoint.yaml b/docs/_data/reference.endpoints.azuredevopsendpoint.yaml
@@ -2,10 +2,12 @@ optionsClassName: AzureDevOpsEndpointOptions
 optionsClassFullName: MigrationTools.Endpoints.AzureDevOpsEndpointOptions
 configurationSamples:
 - name: defaults
+ order: 2
  description: 
  code: There are no defaults! Check the sample for options!
  sampleFor: MigrationTools.Endpoints.AzureDevOpsEndpointOptions
 - name: sample
+ order: 1
  description: 
  code: >-
  {
@@ -17,13 +19,15 @@ configurationSamples:
  "AccessToken": "jklsadhjksahfkjsdhjksahsadjhksadhsad",
  "AuthenticationMode": "AccessToken",
  "Organisation": "https://dev.azure.com/xxx/",
- "Project": "myProject"
+ "Project": "myProject",
+ "ReflectedWorkItemIdField": "Custom.ReflectedWorkItemId"
  }
  }
  }
  }
  sampleFor: MigrationTools.Endpoints.AzureDevOpsEndpointOptions
 - name: classic
+ order: 3
  description: 
  code: >-
  {
@@ -32,8 +36,7 @@ configurationSamples:
  "AccessToken": "jklsadhjksahfkjsdhjksahsadjhksadhsad",
  "Organisation": "https://dev.azure.com/xxx/",
  "Project": "myProject",
- "ReflectedWorkItemIdField": null,
- "EndpointEnrichers": null
+ "ReflectedWorkItemIdField": "Custom.ReflectedWorkItemId"
  }
  sampleFor: MigrationTools.Endpoints.AzureDevOpsEndpointOptions
 description: missing XML code comments
@@ -49,10 +52,6 @@ options:
  type: AuthenticationMode
  description: missing XML code comments
  defaultValue: missing XML code comments
-- parameterName: EndpointEnrichers
- type: List
- description: missing XML code comments
- defaultValue: missing XML code comments
 - parameterName: Organisation
  type: String
  description: missing XML code comments

diff --git a/docs/_data/reference.endpoints.filesystemworkitemendpoint.yaml b/docs/_data/reference.endpoints.filesystemworkitemendpoint.yaml
@@ -2,31 +2,29 @@ optionsClassName: FileSystemWorkItemEndpointOptions
 optionsClassFullName: MigrationTools.Endpoints.FileSystemWorkItemEndpointOptions
 configurationSamples:
 - name: defaults
+ order: 2
  description: 
  code: There are no defaults! Check the sample for options!
  sampleFor: MigrationTools.Endpoints.FileSystemWorkItemEndpointOptions
 - name: sample
+ order: 1
  description: 
  code: There is no sample, but you can check the classic below for a general feel.
  sampleFor: MigrationTools.Endpoints.FileSystemWorkItemEndpointOptions
 - name: classic
+ order: 3
  description: 
  code: >-
  {
  "$type": "FileSystemWorkItemEndpointOptions",
- "FileStore": null,
- "EndpointEnrichers": null
+ "FileStore": null
  }
  sampleFor: MigrationTools.Endpoints.FileSystemWorkItemEndpointOptions
 description: missing XML code comments
 className: FileSystemWorkItemEndpoint
 typeName: Endpoints
 architecture: 
 options:
-- parameterName: EndpointEnrichers
- type: List
- description: missing XML code comments
- defaultValue: missing XML code comments
 - parameterName: FileStore
  type: String
  description: missing XML code comments

diff --git a/docs/_data/reference.endpoints.tfsendpoint.yaml b/docs/_data/reference.endpoints.tfsendpoint.yaml
@@ -2,6 +2,7 @@ optionsClassName: TfsEndpointOptions
 optionsClassFullName: MigrationTools.Endpoints.TfsEndpointOptions
 configurationSamples:
 - name: defaults
+ order: 2
  description: 
  code: >-
  {
@@ -26,13 +27,15 @@ configurationSamples:
  "AreaPath": "Area",
  "IterationPath": "Iteration"
  },
- "Project": ""
+ "Project": "",
+ "ReflectedWorkItemIdField": "Custom.ReflectedWorkItemId"
  }
  }
  }
  }
  sampleFor: MigrationTools.Endpoints.TfsEndpointOptions
 - name: sample
+ order: 1
  description: 
  code: >-
  {
@@ -56,13 +59,15 @@ configurationSamples:
  "AreaPath": "Area",
  "IterationPath": "Iteration"
  },
- "Project": "migrationSource1"
+ "Project": "migrationSource1",
+ "ReflectedWorkItemIdField": "Custom.ReflectedWorkItemId"
  }
  }
  }
  }
  sampleFor: MigrationTools.Endpoints.TfsEndpointOptions
 - name: classic
+ order: 3
  description: 
  code: >-
  {
@@ -78,24 +83,18 @@ configurationSamples:
  },
  "AccessToken": "** removed as a secret ***"
  },
- "ReflectedWorkItemIdField": null,
- "AllowCrossProjectLinking": false,
+ "ReflectedWorkItemIdField": "Custom.ReflectedWorkItemId",
  "LanguageMaps": {
  "AreaPath": "Area",
  "IterationPath": "Iteration"
- },
- "EndpointEnrichers": null
+ }
  }
  sampleFor: MigrationTools.Endpoints.TfsEndpointOptions
 description: missing XML code comments
 className: TfsEndpoint
 typeName: Endpoints
 architecture: 
 options:
-- parameterName: AllowCrossProjectLinking
- type: Boolean
- description: missing XML code comments
- defaultValue: missing XML code comments
 - parameterName: Authentication
  type: TfsAuthenticationOptions
  description: missing XML code comments
@@ -104,10 +103,6 @@ options:
  type: Uri
  description: missing XML code comments
  defaultValue: missing XML code comments
-- parameterName: EndpointEnrichers
- type: List
- description: missing XML code comments
- defaultValue: missing XML code comments
 - parameterName: LanguageMaps
  type: TfsLanguageMapOptions
  description: missing XML code comments