Update docs

nkdAgility · Aug 23, 2024 · d73564c · d73564c
1 parent 3bbc12c
commit d73564c
Show file tree

Hide file tree

Showing 18 changed files with 94 additions and 89 deletions.
diff --git a/appsettings.json b/appsettings.json
@@ -178,10 +178,9 @@
       "TfsEmbededImagesTool": {
         "Enabled": true
       },
-      "GitRepoMappingTool": {
+      "TfsGitRepositoryTool": {
         "Enabled": true,
         "Mappings": {
-          "Source Repo Name": "Target Repo Name"
         }
       }
     },
@@ -297,7 +296,7 @@
             "^7473924d-c47f-4089-8f5c-077c728b576e([\\\\]?.*)$": "MigrationTest5$1"
           }
         },
-        "Iteration": {
+        "Iterations": {
           "Filters": [ "*\\Sprint*", "*\\Sprint*\\**" ],
           "Mappings": {
             "^migrationSource1([\\\\]?.*)$": "MigrationTest5$1",
@@ -313,7 +312,7 @@
         "MigrateTeamSettings": true,
         "UpdateTeamSettings": true,
         "MigrateTeamCapacities": true,
-        "Teams": ["Team 1", "Team 2"]
+        "Teams": [ "Team 1", "Team 2" ]
       },
       "TfsWorkItemLinkTool": {
         "Enabled": true,
@@ -368,7 +367,7 @@
       "TfsEmbededImagesTool": {
         "Enabled": true
       },
-      "GitRepoMappingTool": {
+      "TfsGitRepositoryTool": {
         "Enabled": true,
         "Mappings": {
           "Repo1": "Repo2"

diff --git a/docs/Reference/Generated/MigrationTools.Clients.AzureDevops.ObjectModel.xml b/docs/Reference/Generated/MigrationTools.Clients.AzureDevops.ObjectModel.xml
diff --git a/docs/_data/reference.endpoints.tfsendpoint.yaml b/docs/_data/reference.endpoints.tfsendpoint.yaml
@@ -28,9 +28,9 @@ configurationSamples:
   code: >-
     {
       "$type": "TfsEndpointOptions",
+      "Enabled": false,
       "Organisation": null,
       "Project": null,
-      "Enabled": false,
       "AuthenticationMode": "AccessToken",
       "AccessToken": null,
       "ReflectedWorkItemIdField": null,

diff --git a/docs/_data/reference.endpoints.tfsteamsettingsendpoint.yaml b/docs/_data/reference.endpoints.tfsteamsettingsendpoint.yaml
@@ -28,9 +28,9 @@ configurationSamples:
   code: >-
     {
       "$type": "TfsTeamSettingsEndpointOptions",
+      "Enabled": false,
       "Organisation": null,
       "Project": null,
-      "Enabled": false,
       "AuthenticationMode": "AccessToken",
       "AccessToken": null,
       "ReflectedWorkItemIdField": null,

diff --git a/docs/_data/reference.endpoints.tfsworkitemendpoint.yaml b/docs/_data/reference.endpoints.tfsworkitemendpoint.yaml
@@ -28,9 +28,9 @@ configurationSamples:
   code: >-
     {
       "$type": "TfsWorkItemEndpointOptions",
+      "Enabled": false,
       "Organisation": null,
       "Project": null,
-      "Enabled": false,
       "Query": null,
       "AuthenticationMode": "AccessToken",
       "AccessToken": null,

diff --git a/docs/_data/reference.processors.keepoutboundlinktargetprocessor.yaml b/docs/_data/reference.processors.keepoutboundlinktargetprocessor.yaml
@@ -31,7 +31,7 @@ configurationSamples:
       "Enabled": false,
       "WIQLQuery": "Select [System.Id] From WorkItems Where [System.TeamProject] = @project and not [System.WorkItemType] contains 'Test Suite, Test Plan,Shared Steps,Shared Parameter,Feedback Request'",
       "TargetLinksToKeepOrganization": "https://dev.azure.com/nkdagility",
-      "TargetLinksToKeepProject": "cf8fdd9b-ca8e-47d7-bf9c-9e2fe8020b74",
+      "TargetLinksToKeepProject": "3e0aa570-3d0f-4034-a6ec-8616f08cdcb6",
       "CleanupFileName": "c:/temp/OutboundLinkTargets.bat",
       "PrependCommand": "start",
       "DryRun": true,

diff --git a/docs/_data/reference.processors.tfsworkitemmigrationprocessor.yaml b/docs/_data/reference.processors.tfsworkitemmigrationprocessor.yaml
@@ -132,5 +132,5 @@ options:
   defaultValue: '[]'
 status: ready
 processingTarget: Work Items
-classFile: ''
-optionsClassFile: ''
+classFile: /src/MigrationTools.Clients.AzureDevops.ObjectModel/Processors/TfsWorkItemMigrationProcessor.cs
+optionsClassFile: /src/MigrationTools.Clients.AzureDevops.ObjectModel/Processors/TfsWorkItemMigrationProcessorOptions.cs
diff --git a/docs/_data/reference.tools.gitrepomappingtool.yaml b/docs/_data/reference.tools.gitrepomappingtool.yaml
@@ -7,12 +7,7 @@ configurationSamples:
     {
       "MigrationTools": {
         "CommonTools": {
-          "GitRepoMappingTool": {
-            "Enabled": "True",
-            "Mappings": {
-              "Source Repo Name": "Target Repo Name"
-            }
-          }
+          "GitRepoMappingTool": []
         }
       }
     }
@@ -23,12 +18,7 @@ configurationSamples:
     {
       "MigrationTools": {
         "CommonTools": {
-          "GitRepoMappingTool": {
-            "Enabled": "True",
-            "Mappings": {
-              "Repo1": "Repo2"
-            }
-          }
+          "GitRepoMappingTool": []
         }
       }
     }
@@ -38,11 +28,8 @@ configurationSamples:
   code: >-
     {
       "$type": "GitRepoMappingToolOptions",
-      "Enabled": true,
-      "Mappings": {
-        "Source Repo Name": "Target Repo Name",
-        "Repo1": "Repo2"
-      }
+      "Enabled": false,
+      "Mappings": null
     }
   sampleFor: MigrationTools.Tools.GitRepoMappingToolOptions
 description: Used to process the String fields of a work item. This is useful for cleaning up data. It will limit fields to a max length and apply regex replacements based on what is configured. Each regex replacement is applied in order and can be enabled or disabled.

diff --git a/docs/_data/reference.tools.tfsgitrepositorytool.yaml b/docs/_data/reference.tools.tfsgitrepositorytool.yaml
@@ -7,7 +7,10 @@ configurationSamples:
     {
       "MigrationTools": {
         "CommonTools": {
-          "TfsGitRepositoryTool": []
+          "TfsGitRepositoryTool": {
+            "Enabled": "True",
+            "Mappings": null
+          }
         }
       }
     }
@@ -18,7 +21,12 @@ configurationSamples:
     {
       "MigrationTools": {
         "CommonTools": {
-          "TfsGitRepositoryTool": []
+          "TfsGitRepositoryTool": {
+            "Enabled": "True",
+            "Mappings": {
+              "Repo1": "Repo2"
+            }
+          }
         }
       }
     }
@@ -28,7 +36,7 @@ configurationSamples:
   code: >-
     {
       "$type": "TfsGitRepositoryToolOptions",
-      "Enabled": false
+      "Enabled": true
     }
   sampleFor: MigrationTools.Tools.TfsGitRepositoryToolOptions
 description: missng XML code comments

diff --git a/docs/_data/reference.tools.tfsnodestructuretool.yaml b/docs/_data/reference.tools.tfsnodestructuretool.yaml
@@ -10,16 +10,12 @@ configurationSamples:
           "TfsNodeStructureTool": {
             "Areas": {
               "Filters": null,
-              "Mappings": {
-                "^migrationSource1([\\\\]?.*)$": "MigrationTest5$1"
-              }
+              "Mappings": null
             },
             "Enabled": "True",
-            "Iteration": {
+            "Iterations": {
               "Filters": null,
-              "Mappings": {
-                "^migrationSource1([\\\\]?.*)$": "MigrationTest5$1"
-              }
+              "Mappings": null
             },
             "ReplicateAllExistingNodes": "True",
             "ShouldCreateMissingRevisionPaths": "True"
@@ -41,17 +37,19 @@ configurationSamples:
               ],
               "Mappings": {
                 "^7473924d-c47f-4089-8f5c-077c728b576e([\\\\]?.*)$": "MigrationTest5$1",
+                "^migrationSource1([\\\\]?.*)$": "MigrationTest5$1",
                 "^Skypoint Cloud([\\\\]?.*)$": "MigrationTest5$1"
               }
             },
             "Enabled": "True",
-            "Iteration": {
+            "Iterations": {
               "Filters": [
                 "*\\Sprint*",
                 "*\\Sprint*\\**"
               ],
               "Mappings": {
                 "^7473924d-c47f-4089-8f5c-077c728b576e([\\\\]?.*)$": "MigrationTest5$1",
+                "^migrationSource1([\\\\]?.*)$": "MigrationTest5$1",
                 "^Skypoint Cloud([\\\\]?.*)$": "MigrationTest5$1"
               }
             },
@@ -73,12 +71,22 @@ configurationSamples:
           "*\\Team 1,*\\Team 1\\**"
         ],
         "Mappings": {
+          "^7473924d-c47f-4089-8f5c-077c728b576e([\\\\]?.*)$": "MigrationTest5$1",
           "^migrationSource1([\\\\]?.*)$": "MigrationTest5$1",
+          "^Skypoint Cloud([\\\\]?.*)$": "MigrationTest5$1"
+        }
+      },
+      "Iterations": {
+        "Filters": [
+          "*\\Sprint*",
+          "*\\Sprint*\\**"
+        ],
+        "Mappings": {
           "^7473924d-c47f-4089-8f5c-077c728b576e([\\\\]?.*)$": "MigrationTest5$1",
+          "^migrationSource1([\\\\]?.*)$": "MigrationTest5$1",
           "^Skypoint Cloud([\\\\]?.*)$": "MigrationTest5$1"
         }
       },
-      "Iterations": null,
       "ShouldCreateMissingRevisionPaths": true,
       "ReplicateAllExistingNodes": true
     }

diff --git a/docs/collections/_reference/reference.endpoints.tfsendpoint.md b/docs/collections/_reference/reference.endpoints.tfsendpoint.md
@@ -29,9 +29,9 @@ configurationSamples:
   code: >-
     {
       "$type": "TfsEndpointOptions",
+      "Enabled": false,
       "Organisation": null,
       "Project": null,
-      "Enabled": false,
       "AuthenticationMode": "AccessToken",
       "AccessToken": null,
       "ReflectedWorkItemIdField": null,

diff --git a/docs/collections/_reference/reference.endpoints.tfsteamsettingsendpoint.md b/docs/collections/_reference/reference.endpoints.tfsteamsettingsendpoint.md
@@ -29,9 +29,9 @@ configurationSamples:
   code: >-
     {
       "$type": "TfsTeamSettingsEndpointOptions",
+      "Enabled": false,
       "Organisation": null,
       "Project": null,
-      "Enabled": false,
       "AuthenticationMode": "AccessToken",
       "AccessToken": null,
       "ReflectedWorkItemIdField": null,

diff --git a/docs/collections/_reference/reference.endpoints.tfsworkitemendpoint.md b/docs/collections/_reference/reference.endpoints.tfsworkitemendpoint.md
@@ -29,9 +29,9 @@ configurationSamples:
   code: >-
     {
       "$type": "TfsWorkItemEndpointOptions",
+      "Enabled": false,
       "Organisation": null,
       "Project": null,
-      "Enabled": false,
       "Query": null,
       "AuthenticationMode": "AccessToken",
       "AccessToken": null,

diff --git a/.../collections/_reference/reference.processors.keepoutboundlinktargetprocessor.md b/.../collections/_reference/reference.processors.keepoutboundlinktargetprocessor.md
@@ -32,7 +32,7 @@ configurationSamples:
       "Enabled": false,
       "WIQLQuery": "Select [System.Id] From WorkItems Where [System.TeamProject] = @project and not [System.WorkItemType] contains 'Test Suite, Test Plan,Shared Steps,Shared Parameter,Feedback Request'",
       "TargetLinksToKeepOrganization": "https://dev.azure.com/nkdagility",
-      "TargetLinksToKeepProject": "cf8fdd9b-ca8e-47d7-bf9c-9e2fe8020b74",
+      "TargetLinksToKeepProject": "3e0aa570-3d0f-4034-a6ec-8616f08cdcb6",
       "CleanupFileName": "c:/temp/OutboundLinkTargets.bat",
       "PrependCommand": "start",
       "DryRun": true,

diff --git a/docs/collections/_reference/reference.processors.tfsworkitemmigrationprocessor.md b/docs/collections/_reference/reference.processors.tfsworkitemmigrationprocessor.md
@@ -133,8 +133,8 @@ options:
   defaultValue: '[]'
 status: ready
 processingTarget: Work Items
-classFile: ''
-optionsClassFile: ''
+classFile: /src/MigrationTools.Clients.AzureDevops.ObjectModel/Processors/TfsWorkItemMigrationProcessor.cs
+optionsClassFile: /src/MigrationTools.Clients.AzureDevops.ObjectModel/Processors/TfsWorkItemMigrationProcessorOptions.cs
 
 redirectFrom:
 - /Reference/Processors/TfsWorkItemMigrationProcessorOptions/

diff --git a/docs/collections/_reference/reference.tools.gitrepomappingtool.md b/docs/collections/_reference/reference.tools.gitrepomappingtool.md
@@ -8,12 +8,7 @@ configurationSamples:
     {
       "MigrationTools": {
         "CommonTools": {
-          "GitRepoMappingTool": {
-            "Enabled": "True",
-            "Mappings": {
-              "Source Repo Name": "Target Repo Name"
-            }
-          }
+          "GitRepoMappingTool": []
         }
       }
     }
@@ -24,12 +19,7 @@ configurationSamples:
     {
       "MigrationTools": {
         "CommonTools": {
-          "GitRepoMappingTool": {
-            "Enabled": "True",
-            "Mappings": {
-              "Repo1": "Repo2"
-            }
-          }
+          "GitRepoMappingTool": []
         }
       }
     }
@@ -39,11 +29,8 @@ configurationSamples:
   code: >-
     {
       "$type": "GitRepoMappingToolOptions",
-      "Enabled": true,
-      "Mappings": {
-        "Source Repo Name": "Target Repo Name",
-        "Repo1": "Repo2"
-      }
+      "Enabled": false,
+      "Mappings": null
     }
   sampleFor: MigrationTools.Tools.GitRepoMappingToolOptions
 description: Used to process the String fields of a work item. This is useful for cleaning up data. It will limit fields to a max length and apply regex replacements based on what is configured. Each regex replacement is applied in order and can be enabled or disabled.