📝 (docs): update configuration samples and documentation for processo…

…rs and tools Update the `TargetLinksToKeepProject` ID in the `keepoutboundlinktargetprocessor` configuration to reflect the correct project identifier. This change ensures that the documentation aligns with the current project setup. Remove the `RegexStringManipulator` from the `StringManipulatorTool` configuration samples. Setting `Manipulators` to `null` simplifies the configuration and reflects a decision to handle string manipulations differently, possibly through other means or tools. This change is reflected in both YAML and Markdown documentation to maintain consistency and accuracy.
nkdAgility · Nov 5, 2024 · ab1b240 · ab1b240
1 parent 8d1b1f3
commit ab1b240
Show file tree

Hide file tree

Showing 4 changed files with 4 additions and 32 deletions.
diff --git a/docs/_data/reference.processors.keepoutboundlinktargetprocessor.yaml b/docs/_data/reference.processors.keepoutboundlinktargetprocessor.yaml
@@ -20,7 +20,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": "35537ca4-fac4-4fe6-8dd1-62e6c6a0684d",
+      "TargetLinksToKeepProject": "332b7ec5-b938-4c13-8ab4-06d6c70ea68a",
       "CleanupFileName": "c:/temp/OutboundLinkTargets.bat",
       "PrependCommand": "start",
       "DryRun": true,

diff --git a/docs/_data/reference.tools.stringmanipulatortool.yaml b/docs/_data/reference.tools.stringmanipulatortool.yaml
@@ -11,15 +11,7 @@ configurationSamples:
         "CommonTools": {
           "StringManipulatorTool": {
             "Enabled": "True",
-            "Manipulators": [
-              {
-                "$type": "RegexStringManipulator",
-                "Description": "Remove invalid characters from the end of the string",
-                "Enabled": "True",
-                "Pattern": "[^( -~)\n\r\t]+",
-                "Replacement": ""
-              }
-            ],
+            "Manipulators": null,
             "MaxStringLength": "1000000"
           }
         }
@@ -60,12 +52,6 @@ configurationSamples:
       "Enabled": true,
       "MaxStringLength": 1000000,
       "Manipulators": [
-        {
-          "Enabled": true,
-          "Pattern": "[^( -~)\n\r\t]+",
-          "Replacement": "",
-          "Description": "Remove invalid characters from the end of the string"
-        },
         {
           "Enabled": true,
           "Pattern": "[^( -~)\n\r\t]+",

diff --git a/.../collections/_reference/reference.processors.keepoutboundlinktargetprocessor.md b/.../collections/_reference/reference.processors.keepoutboundlinktargetprocessor.md
@@ -21,7 +21,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": "35537ca4-fac4-4fe6-8dd1-62e6c6a0684d",
+      "TargetLinksToKeepProject": "332b7ec5-b938-4c13-8ab4-06d6c70ea68a",
       "CleanupFileName": "c:/temp/OutboundLinkTargets.bat",
       "PrependCommand": "start",
       "DryRun": true,

diff --git a/docs/collections/_reference/reference.tools.stringmanipulatortool.md b/docs/collections/_reference/reference.tools.stringmanipulatortool.md
@@ -12,15 +12,7 @@ configurationSamples:
         "CommonTools": {
           "StringManipulatorTool": {
             "Enabled": "True",
-            "Manipulators": [
-              {
-                "$type": "RegexStringManipulator",
-                "Description": "Remove invalid characters from the end of the string",
-                "Enabled": "True",
-                "Pattern": "[^( -~)\n\r\t]+",
-                "Replacement": ""
-              }
-            ],
+            "Manipulators": null,
             "MaxStringLength": "1000000"
           }
         }
@@ -61,12 +53,6 @@ configurationSamples:
       "Enabled": true,
       "MaxStringLength": 1000000,
       "Manipulators": [
-        {
-          "Enabled": true,
-          "Pattern": "[^( -~)\n\r\t]+",
-          "Replacement": "",
-          "Description": "Remove invalid characters from the end of the string"
-        },
         {
           "Enabled": true,
           "Pattern": "[^( -~)\n\r\t]+",