Update and rebuild docs

nkdAgility · Aug 20, 2024 · 487bb1e · 487bb1e
1 parent af245e7
commit 487bb1e
Show file tree

Hide file tree

Showing 127 changed files with 2,405 additions and 172 deletions.
diff --git a/docs/Reference/Generated/MigrationTools.xml b/docs/Reference/Generated/MigrationTools.xml
diff --git a/docs/_data/reference.endpoints.azuredevopsendpoint.yaml b/docs/_data/reference.endpoints.azuredevopsendpoint.yaml
@@ -1,6 +1,31 @@
 optionsClassName: AzureDevOpsEndpointOptions
 optionsClassFullName: MigrationTools.Endpoints.AzureDevOpsEndpointOptions
 configurationSamples:
+- name: confinguration.json
+  description: 
+  code: >-
+    {
+      "MigrationTools": {
+        "Endpoints": {
+          "*": {
+            "AzureDevOpsEndpoint": [
+              {
+                "EndpointType": "AzureDevOpsEndpoint",
+                "Enabled": false,
+                "AuthenticationMode": 0,
+                "AccessToken": null,
+                "Organisation": null,
+                "Project": null,
+                "ReflectedWorkItemIdField": null,
+                "Name": null,
+                "EndpointEnrichers": null
+              }
+            ]
+          }
+        }
+      }
+    }
+  sampleFor: MigrationTools.Endpoints.AzureDevOpsEndpointOptions
 - name: defaults
   description: 
   code: >-

diff --git a/docs/_data/reference.endpoints.filesystemworkitemendpoint.yaml b/docs/_data/reference.endpoints.filesystemworkitemendpoint.yaml
@@ -1,6 +1,27 @@
 optionsClassName: FileSystemWorkItemEndpointOptions
 optionsClassFullName: MigrationTools.Endpoints.FileSystemWorkItemEndpointOptions
 configurationSamples:
+- name: confinguration.json
+  description: 
+  code: >-
+    {
+      "MigrationTools": {
+        "Endpoints": {
+          "*": {
+            "FileSystemWorkItemEndpoint": [
+              {
+                "EndpointType": "FileSystemWorkItemEndpoint",
+                "Enabled": false,
+                "FileStore": null,
+                "Name": null,
+                "EndpointEnrichers": null
+              }
+            ]
+          }
+        }
+      }
+    }
+  sampleFor: MigrationTools.Endpoints.FileSystemWorkItemEndpointOptions
 - name: defaults
   description: 
   code: >-

diff --git a/docs/_data/reference.endpoints.tfsendpoint.yaml b/docs/_data/reference.endpoints.tfsendpoint.yaml
@@ -1,6 +1,32 @@
 optionsClassName: TfsEndpointOptions
 optionsClassFullName: MigrationTools.Endpoints.TfsEndpointOptions
 configurationSamples:
+- name: confinguration.json
+  description: 
+  code: >-
+    {
+      "MigrationTools": {
+        "Endpoints": {
+          "*": {
+            "TfsEndpoint": [
+              {
+                "EndpointType": "TfsEndpoint",
+                "Organisation": null,
+                "Project": null,
+                "Enabled": false,
+                "AuthenticationMode": "AccessToken",
+                "AccessToken": null,
+                "ReflectedWorkItemIdField": null,
+                "LanguageMaps": null,
+                "Name": null,
+                "EndpointEnrichers": null
+              }
+            ]
+          }
+        }
+      }
+    }
+  sampleFor: MigrationTools.Endpoints.TfsEndpointOptions
 - name: defaults
   description: 
   code: >-

diff --git a/docs/_data/reference.endpoints.tfsteamsettingsendpoint.yaml b/docs/_data/reference.endpoints.tfsteamsettingsendpoint.yaml
@@ -1,6 +1,32 @@
 optionsClassName: TfsTeamSettingsEndpointOptions
 optionsClassFullName: MigrationTools.Endpoints.TfsTeamSettingsEndpointOptions
 configurationSamples:
+- name: confinguration.json
+  description: 
+  code: >-
+    {
+      "MigrationTools": {
+        "Endpoints": {
+          "*": {
+            "TfsTeamSettingsEndpoint": [
+              {
+                "EndpointType": "TfsTeamSettingsEndpoint",
+                "Organisation": null,
+                "Project": null,
+                "Enabled": false,
+                "AuthenticationMode": "AccessToken",
+                "AccessToken": null,
+                "ReflectedWorkItemIdField": null,
+                "LanguageMaps": null,
+                "Name": null,
+                "EndpointEnrichers": null
+              }
+            ]
+          }
+        }
+      }
+    }
+  sampleFor: MigrationTools.Endpoints.TfsTeamSettingsEndpointOptions
 - name: defaults
   description: 
   code: >-

diff --git a/docs/_data/reference.endpoints.tfsworkitemendpoint.yaml b/docs/_data/reference.endpoints.tfsworkitemendpoint.yaml
@@ -1,6 +1,33 @@
 optionsClassName: TfsWorkItemEndpointOptions
 optionsClassFullName: MigrationTools.Endpoints.TfsWorkItemEndpointOptions
 configurationSamples:
+- name: confinguration.json
+  description: 
+  code: >-
+    {
+      "MigrationTools": {
+        "Endpoints": {
+          "*": {
+            "TfsWorkItemEndpoint": [
+              {
+                "EndpointType": "TfsWorkItemEndpoint",
+                "Organisation": null,
+                "Project": null,
+                "Enabled": false,
+                "Query": null,
+                "AuthenticationMode": "AccessToken",
+                "AccessToken": null,
+                "ReflectedWorkItemIdField": null,
+                "LanguageMaps": null,
+                "Name": null,
+                "EndpointEnrichers": null
+              }
+            ]
+          }
+        }
+      }
+    }
+  sampleFor: MigrationTools.Endpoints.TfsWorkItemEndpointOptions
 - name: defaults
   description: 
   code: >-

diff --git a/docs/_data/reference.fieldmaps.fieldclearmap.yaml b/docs/_data/reference.fieldmaps.fieldclearmap.yaml
@@ -1,6 +1,27 @@
 optionsClassName: FieldClearMapOptions
 optionsClassFullName: MigrationTools.Tools.FieldClearMapOptions
 configurationSamples:
+- name: confinguration.json
+  description: 
+  code: >-
+    {
+      "MigrationTools": {
+        "CommonTools": {
+          "FieldMappingTool": {
+            "FieldMaps": [
+              {
+                "FieldMapType": "FieldClearMap",
+                "Enabled": false,
+                "targetField": null,
+                "ConfigurationCollectionItemPath": "MigrationTools:CommonTools:FieldMappingTool:FieldMaps:*:FieldClearMap",
+                "ApplyTo": null
+              }
+            ]
+          }
+        }
+      }
+    }
+  sampleFor: MigrationTools.Tools.FieldClearMapOptions
 - name: defaults
   description: 
   code: >-
@@ -22,8 +43,8 @@ configurationSamples:
     {
       "$type": "FieldClearMapOptions",
       "Enabled": false,
-      "WorkItemTypeName": null,
       "targetField": null,
+      "ConfigurationCollectionItemPath": "MigrationTools:CommonTools:FieldMappingTool:FieldMaps:*:FieldClearMap",
       "ApplyTo": null
     }
   sampleFor: MigrationTools.Tools.FieldClearMapOptions
@@ -36,6 +57,10 @@ options:
   type: List
   description: missng XML code comments
   defaultValue: missng XML code comments
+- parameterName: ConfigurationCollectionItemPath
+  type: String
+  description: missng XML code comments
+  defaultValue: missng XML code comments
 - parameterName: Enabled
   type: Boolean
   description: If set to `true` then the Fieldmap will run. Set to `false` and the processor will not run.
@@ -44,10 +69,6 @@ options:
   type: String
   description: missng XML code comments
   defaultValue: missng XML code comments
-- parameterName: WorkItemTypeName
-  type: String
-  description: missng XML code comments
-  defaultValue: missng XML code comments
 status: missng XML code comments
 processingTarget: missng XML code comments
 classFile: /src/MigrationTools.Clients.AzureDevops.ObjectModel/Tools/FieldMappingTool/FieldMaps/FieldClearMap.cs

diff --git a/docs/_data/reference.fieldmaps.fieldliteralmap.yaml b/docs/_data/reference.fieldmaps.fieldliteralmap.yaml
@@ -1,6 +1,28 @@
 optionsClassName: FieldLiteralMapOptions
 optionsClassFullName: MigrationTools.Tools.FieldLiteralMapOptions
 configurationSamples:
+- name: confinguration.json
+  description: 
+  code: >-
+    {
+      "MigrationTools": {
+        "CommonTools": {
+          "FieldMappingTool": {
+            "FieldMaps": [
+              {
+                "FieldMapType": "FieldLiteralMap",
+                "Enabled": false,
+                "targetField": null,
+                "value": null,
+                "ConfigurationCollectionItemPath": "MigrationTools:CommonTools:FieldMappingTool:FieldMaps:*:FieldLiteralMap",
+                "ApplyTo": null
+              }
+            ]
+          }
+        }
+      }
+    }
+  sampleFor: MigrationTools.Tools.FieldLiteralMapOptions
 - name: defaults
   description: 
   code: >-
@@ -22,9 +44,9 @@ configurationSamples:
     {
       "$type": "FieldLiteralMapOptions",
       "Enabled": false,
-      "WorkItemTypeName": null,
       "targetField": null,
       "value": null,
+      "ConfigurationCollectionItemPath": "MigrationTools:CommonTools:FieldMappingTool:FieldMaps:*:FieldLiteralMap",
       "ApplyTo": null
     }
   sampleFor: MigrationTools.Tools.FieldLiteralMapOptions
@@ -37,6 +59,10 @@ options:
   type: List
   description: missng XML code comments
   defaultValue: missng XML code comments
+- parameterName: ConfigurationCollectionItemPath
+  type: String
+  description: missng XML code comments
+  defaultValue: missng XML code comments
 - parameterName: Enabled
   type: Boolean
   description: If set to `true` then the Fieldmap will run. Set to `false` and the processor will not run.
@@ -49,10 +75,6 @@ options:
   type: String
   description: missng XML code comments
   defaultValue: missng XML code comments
-- parameterName: WorkItemTypeName
-  type: String
-  description: missng XML code comments
-  defaultValue: missng XML code comments
 status: missng XML code comments
 processingTarget: missng XML code comments
 classFile: /src/MigrationTools.Clients.AzureDevops.ObjectModel/Tools/FieldMappingTool/FieldMaps/FieldLiteralMap.cs

diff --git a/docs/_data/reference.fieldmaps.fieldmergemap.yaml b/docs/_data/reference.fieldmaps.fieldmergemap.yaml
@@ -1,6 +1,34 @@
 optionsClassName: FieldMergeMapOptions
 optionsClassFullName: MigrationTools.Tools.FieldMergeMapOptions
 configurationSamples:
+- name: confinguration.json
+  description: 
+  code: >-
+    {
+      "MigrationTools": {
+        "CommonTools": {
+          "FieldMappingTool": {
+            "FieldMaps": [
+              {
+                "FieldMapType": "FieldMergeMap",
+                "Enabled": false,
+                "sourceFields": [
+                  "System.Description",
+                  "Microsoft.VSTS.Common.AcceptanceCriteria"
+                ],
+                "targetField": "System.Description",
+                "formatExpression": "{0} <br/><br/><h3>Acceptance Criteria</h3>{1}",
+                "ConfigurationCollectionItemPath": "MigrationTools:CommonTools:FieldMappingTool:FieldMaps:*:FieldMergeMap",
+                "ApplyTo": [
+                  "SomeWorkItemType"
+                ]
+              }
+            ]
+          }
+        }
+      }
+    }
+  sampleFor: MigrationTools.Tools.FieldMergeMapOptions
 - name: defaults
   description: 
   code: >-
@@ -38,6 +66,7 @@ configurationSamples:
       ],
       "targetField": "System.Description",
       "formatExpression": "{0} <br/><br/><h3>Acceptance Criteria</h3>{1}",
+      "ConfigurationCollectionItemPath": "MigrationTools:CommonTools:FieldMappingTool:FieldMaps:*:FieldMergeMap",
       "ApplyTo": [
         "SomeWorkItemType"
       ]
@@ -52,6 +81,10 @@ options:
   type: List
   description: missng XML code comments
   defaultValue: missng XML code comments
+- parameterName: ConfigurationCollectionItemPath
+  type: String
+  description: missng XML code comments
+  defaultValue: missng XML code comments
 - parameterName: Enabled
   type: Boolean
   description: If set to `true` then the Fieldmap will run. Set to `false` and the processor will not run.