Updat docs

nkdAgility · Sep 24, 2024 · 1463259 · 1463259
1 parent 6d3fe26
commit 1463259
Show file tree

Hide file tree

Showing 102 changed files with 478 additions and 17 deletions.
diff --git a/docs/Reference/Processors/TfsWorkItemMigrationProcessor-notes.md b/docs/Reference/Processors/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: >-
     {
@@ -25,6 +27,7 @@ configurationSamples:
     }
   sampleFor: MigrationTools.Endpoints.AzureDevOpsEndpointOptions
 - name: classic
+  order: 3
   description: 
   code: >-
     {

diff --git a/docs/_data/reference.endpoints.filesystemworkitemendpoint.yaml b/docs/_data/reference.endpoints.filesystemworkitemendpoint.yaml
@@ -2,14 +2,17 @@ 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: >-
     {

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: >-
     {
@@ -34,6 +35,7 @@ configurationSamples:
     }
   sampleFor: MigrationTools.Endpoints.TfsEndpointOptions
 - name: sample
+  order: 1
   description: 
   code: >-
     {
@@ -65,6 +67,7 @@ configurationSamples:
     }
   sampleFor: MigrationTools.Endpoints.TfsEndpointOptions
 - name: classic
+  order: 3
   description: 
   code: >-
     {

diff --git a/docs/_data/reference.endpoints.tfsteamprojectendpoint.yaml b/docs/_data/reference.endpoints.tfsteamprojectendpoint.yaml
@@ -2,6 +2,7 @@ optionsClassName: TfsTeamProjectEndpointOptions
 optionsClassFullName: MigrationTools.Endpoints.TfsTeamProjectEndpointOptions
 configurationSamples:
 - name: defaults
+  order: 2
   description: 
   code: >-
     {
@@ -34,6 +35,7 @@ configurationSamples:
     }
   sampleFor: MigrationTools.Endpoints.TfsTeamProjectEndpointOptions
 - name: sample
+  order: 1
   description: 
   code: >-
     {
@@ -61,6 +63,7 @@ configurationSamples:
     }
   sampleFor: MigrationTools.Endpoints.TfsTeamProjectEndpointOptions
 - name: classic
+  order: 3
   description: 
   code: >-
     {

diff --git a/docs/_data/reference.endpoints.tfsteamsettingsendpoint.yaml b/docs/_data/reference.endpoints.tfsteamsettingsendpoint.yaml
@@ -2,14 +2,17 @@ optionsClassName: TfsTeamSettingsEndpointOptions
 optionsClassFullName: MigrationTools.Endpoints.TfsTeamSettingsEndpointOptions
 configurationSamples:
 - name: defaults
+  order: 2
   description: 
   code: There are no defaults! Check the sample for options!
   sampleFor: MigrationTools.Endpoints.TfsTeamSettingsEndpointOptions
 - name: sample
+  order: 1
   description: 
   code: There is no sample, but you can check the classic below for a general feel.
   sampleFor: MigrationTools.Endpoints.TfsTeamSettingsEndpointOptions
 - name: classic
+  order: 3
   description: 
   code: >-
     {

diff --git a/docs/_data/reference.endpoints.tfsworkitemendpoint.yaml b/docs/_data/reference.endpoints.tfsworkitemendpoint.yaml
@@ -2,14 +2,17 @@ optionsClassName: TfsWorkItemEndpointOptions
 optionsClassFullName: MigrationTools.Endpoints.TfsWorkItemEndpointOptions
 configurationSamples:
 - name: defaults
+  order: 2
   description: 
   code: There are no defaults! Check the sample for options!
   sampleFor: MigrationTools.Endpoints.TfsWorkItemEndpointOptions
 - name: sample
+  order: 1
   description: 
   code: There is no sample, but you can check the classic below for a general feel.
   sampleFor: MigrationTools.Endpoints.TfsWorkItemEndpointOptions
 - name: classic
+  order: 3
   description: 
   code: >-
     {

diff --git a/docs/_data/reference.fieldmaps.fieldclearmap.yaml b/docs/_data/reference.fieldmaps.fieldclearmap.yaml
@@ -2,6 +2,7 @@ optionsClassName: FieldClearMapOptions
 optionsClassFullName: MigrationTools.Tools.FieldClearMapOptions
 configurationSamples:
 - name: defaults
+  order: 2
   description: 
   code: >-
     {
@@ -23,6 +24,7 @@ configurationSamples:
     }
   sampleFor: MigrationTools.Tools.FieldClearMapOptions
 - name: sample
+  order: 1
   description: 
   code: >-
     {
@@ -45,6 +47,7 @@ configurationSamples:
     }
   sampleFor: MigrationTools.Tools.FieldClearMapOptions
 - name: classic
+  order: 3
   description: 
   code: >-
     {

diff --git a/docs/_data/reference.fieldmaps.fieldliteralmap.yaml b/docs/_data/reference.fieldmaps.fieldliteralmap.yaml
@@ -2,6 +2,7 @@ optionsClassName: FieldLiteralMapOptions
 optionsClassFullName: MigrationTools.Tools.FieldLiteralMapOptions
 configurationSamples:
 - name: defaults
+  order: 2
   description: 
   code: >-
     {
@@ -23,6 +24,7 @@ configurationSamples:
     }
   sampleFor: MigrationTools.Tools.FieldLiteralMapOptions
 - name: sample
+  order: 1
   description: 
   code: >-
     {
@@ -46,6 +48,7 @@ configurationSamples:
     }
   sampleFor: MigrationTools.Tools.FieldLiteralMapOptions
 - name: classic
+  order: 3
   description: 
   code: >-
     {

diff --git a/docs/_data/reference.fieldmaps.fieldmergemap.yaml b/docs/_data/reference.fieldmaps.fieldmergemap.yaml
@@ -2,6 +2,7 @@ optionsClassName: FieldMergeMapOptions
 optionsClassFullName: MigrationTools.Tools.FieldMergeMapOptions
 configurationSamples:
 - name: defaults
+  order: 2
   description: 
   code: >-
     {
@@ -23,6 +24,7 @@ configurationSamples:
     }
   sampleFor: MigrationTools.Tools.FieldMergeMapOptions
 - name: sample
+  order: 1
   description: 
   code: >-
     {
@@ -50,6 +52,7 @@ configurationSamples:
     }
   sampleFor: MigrationTools.Tools.FieldMergeMapOptions
 - name: classic
+  order: 3
   description: 
   code: >-
     {

diff --git a/docs/_data/reference.fieldmaps.fieldskipmap.yaml b/docs/_data/reference.fieldmaps.fieldskipmap.yaml
@@ -2,6 +2,7 @@ optionsClassName: FieldSkipMapOptions
 optionsClassFullName: MigrationTools.Tools.FieldSkipMapOptions
 configurationSamples:
 - name: defaults
+  order: 2
   description: 
   code: >-
     {
@@ -23,10 +24,12 @@ configurationSamples:
     }
   sampleFor: MigrationTools.Tools.FieldSkipMapOptions
 - name: sample
+  order: 1
   description: 
   code: There is no sample, but you can check the classic below for a general feel.
   sampleFor: MigrationTools.Tools.FieldSkipMapOptions
 - name: classic
+  order: 3
   description: 
   code: >-
     {

diff --git a/docs/_data/reference.fieldmaps.fieldtofieldmap.yaml b/docs/_data/reference.fieldmaps.fieldtofieldmap.yaml
@@ -2,6 +2,7 @@ optionsClassName: FieldToFieldMapOptions
 optionsClassFullName: MigrationTools.Tools.FieldToFieldMapOptions
 configurationSamples:
 - name: defaults
+  order: 2
   description: 
   code: >-
     {
@@ -23,6 +24,7 @@ configurationSamples:
     }
   sampleFor: MigrationTools.Tools.FieldToFieldMapOptions
 - name: sample
+  order: 1
   description: 
   code: >-
     {
@@ -47,6 +49,7 @@ configurationSamples:
     }
   sampleFor: MigrationTools.Tools.FieldToFieldMapOptions
 - name: classic
+  order: 3
   description: 
   code: >-
     {

diff --git a/docs/_data/reference.fieldmaps.fieldtofieldmultimap.yaml b/docs/_data/reference.fieldmaps.fieldtofieldmultimap.yaml
@@ -2,6 +2,7 @@ optionsClassName: FieldToFieldMultiMapOptions
 optionsClassFullName: MigrationTools.Tools.FieldToFieldMultiMapOptions
 configurationSamples:
 - name: defaults
+  order: 2
   description: 
   code: >-
     {
@@ -23,6 +24,7 @@ configurationSamples:
     }
   sampleFor: MigrationTools.Tools.FieldToFieldMultiMapOptions
 - name: sample
+  order: 1
   description: 
   code: >-
     {
@@ -49,6 +51,7 @@ configurationSamples:
     }
   sampleFor: MigrationTools.Tools.FieldToFieldMultiMapOptions
 - name: classic
+  order: 3
   description: 
   code: >-
     {

diff --git a/docs/_data/reference.fieldmaps.fieldtotagfieldmap.yaml b/docs/_data/reference.fieldmaps.fieldtotagfieldmap.yaml
@@ -2,6 +2,7 @@ optionsClassName: FieldToTagFieldMapOptions
 optionsClassFullName: MigrationTools.Tools.FieldToTagFieldMapOptions
 configurationSamples:
 - name: defaults
+  order: 2
   description: 
   code: >-
     {
@@ -23,6 +24,7 @@ configurationSamples:
     }
   sampleFor: MigrationTools.Tools.FieldToTagFieldMapOptions
 - name: sample
+  order: 1
   description: 
   code: >-
     {
@@ -50,6 +52,7 @@ configurationSamples:
     }
   sampleFor: MigrationTools.Tools.FieldToTagFieldMapOptions
 - name: classic
+  order: 3
   description: 
   code: >-
     {

diff --git a/docs/_data/reference.fieldmaps.fieldvaluemap.yaml b/docs/_data/reference.fieldmaps.fieldvaluemap.yaml
@@ -2,6 +2,7 @@ optionsClassName: FieldValueMapOptions
 optionsClassFullName: MigrationTools.Tools.FieldValueMapOptions
 configurationSamples:
 - name: defaults
+  order: 2
   description: 
   code: >-
     {
@@ -23,6 +24,7 @@ configurationSamples:
     }
   sampleFor: MigrationTools.Tools.FieldValueMapOptions
 - name: sample
+  order: 1
   description: 
   code: >-
     {
@@ -50,6 +52,7 @@ configurationSamples:
     }
   sampleFor: MigrationTools.Tools.FieldValueMapOptions
 - name: classic
+  order: 3
   description: 
   code: >-
     {

diff --git a/docs/_data/reference.fieldmaps.multivalueconditionalmap.yaml b/docs/_data/reference.fieldmaps.multivalueconditionalmap.yaml
@@ -2,6 +2,7 @@ optionsClassName: MultiValueConditionalMapOptions
 optionsClassFullName: MigrationTools.Tools.MultiValueConditionalMapOptions
 configurationSamples:
 - name: defaults
+  order: 2
   description: 
   code: >-
     {
@@ -23,6 +24,7 @@ configurationSamples:
     }
   sampleFor: MigrationTools.Tools.MultiValueConditionalMapOptions
 - name: sample
+  order: 1
   description: 
   code: >-
     {
@@ -52,6 +54,7 @@ configurationSamples:
     }
   sampleFor: MigrationTools.Tools.MultiValueConditionalMapOptions
 - name: classic
+  order: 3
   description: 
   code: >-
     {

diff --git a/docs/_data/reference.fieldmaps.regexfieldmap.yaml b/docs/_data/reference.fieldmaps.regexfieldmap.yaml
@@ -2,6 +2,7 @@ optionsClassName: RegexFieldMapOptions
 optionsClassFullName: MigrationTools.Tools.RegexFieldMapOptions
 configurationSamples:
 - name: defaults
+  order: 2
   description: 
   code: >-
     {
@@ -23,6 +24,7 @@ configurationSamples:
     }
   sampleFor: MigrationTools.Tools.RegexFieldMapOptions
 - name: sample
+  order: 1
   description: 
   code: >-
     {
@@ -48,6 +50,7 @@ configurationSamples:
     }
   sampleFor: MigrationTools.Tools.RegexFieldMapOptions
 - name: classic
+  order: 3
   description: 
   code: >-
     {