Fix for Endpoint Samples not being rendered correctly in Docs (#2377)

nkdAgility · Sep 19, 2024 · 718c319 · 718c319
2 parents 76c49c7 + ab8aed0
commit 718c319
Show file tree

Hide file tree

Showing 12 changed files with 173 additions and 181 deletions.
diff --git a/MigrationTools.sln b/MigrationTools.sln
@@ -24,6 +24,7 @@ Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Solution Items", "Solution
  .editorconfig = .editorconfig
  .gitattributes = .gitattributes
  .gitignore = .gitignore
+ appsettings.json = appsettings.json
  configuration.json = configuration.json
  configuration2-wit.json = configuration2-wit.json
  configuration2.json = configuration2.json

diff --git a/appsettings.json b/appsettings.json
@@ -14,7 +14,6 @@
  "MigrationTools": {
  "EndpointDefaults": {
  "TfsEndpoint": {
- "EndpointType": "TfsTeamProjectEndpoint",
  "Collection": "",
  "Project": "",
  "AllowCrossProjectLinking": false,
@@ -34,7 +33,6 @@
  }
  },
  "TfsTeamProjectEndpoint": {
- "EndpointType": "TfsTeamProjectEndpoint",
  "Collection": "",
  "Project": "",
  "AllowCrossProjectLinking": false,
@@ -56,7 +54,6 @@
  },
  "EndpointSamples": {
  "TfsTeamProjectEndpoint": {
- "EndpointType": "TfsTeamProjectEndpoint",
  "Collection": "https://dev.azure.com/nkdagility-preview/",
  "Project": "migrationSource1",
  "AllowCrossProjectLinking": false,
@@ -75,7 +72,6 @@
  }
  },
  "TfsEndpoint": {
- "EndpointType": "TfsTeamProjectEndpoint",
  "Collection": "https://dev.azure.com/nkdagility-preview/",
  "Project": "migrationSource1",
  "AllowCrossProjectLinking": false,
@@ -94,7 +90,6 @@
  }
  },
  "AzureDevOpsEndpoint": {
- "EndpointType": "AzureDevOpsEndpoint",
  "AuthenticationMode": "AccessToken",
  "AccessToken": "jklsadhjksahfkjsdhjksahsadjhksadhsad",
  "Organisation": "https://dev.azure.com/xxx/",

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
@@ -13,13 +13,11 @@ configurationSamples:
  "Version": "16.0",
  "Endpoints": {
  "#KEY#": {
- "AzureDevOpsEndpoint": {
- "AccessToken": "jklsadhjksahfkjsdhjksahsadjhksadhsad",
- "AuthenticationMode": "AccessToken",
- "EndpointType": "AzureDevOpsEndpoint",
- "Organisation": "https://dev.azure.com/xxx/",
- "Project": "myProject"
- }
+ "EndpointType": "AzureDevOpsEndpoint",
+ "AccessToken": "jklsadhjksahfkjsdhjksahsadjhksadhsad",
+ "AuthenticationMode": "AccessToken",
+ "Organisation": "https://dev.azure.com/xxx/",
+ "Project": "myProject"
  }
  }
  }

diff --git a/docs/_data/reference.endpoints.tfsendpoint.yaml b/docs/_data/reference.endpoints.tfsendpoint.yaml
@@ -9,26 +9,24 @@ configurationSamples:
  "Version": "16.0",
  "Endpoints": {
  "#KEY#": {
- "TfsEndpoint": {
- "AllowCrossProjectLinking": "False",
- "Authentication": {
- "AccessToken": "",
- "AuthenticationMode": "AccessToken",
- "NetworkCredentials": {
- "Domain": "",
- "Password": "",
- "UserName": ""
- }
- },
+ "EndpointType": "TfsEndpoint",
+ "AllowCrossProjectLinking": "False",
+ "Authentication": {
+ "AccessToken": "",
  "AuthenticationMode": "AccessToken",
- "Collection": "",
- "EndpointType": "TfsTeamProjectEndpoint",
- "LanguageMaps": {
- "AreaPath": "Area",
- "IterationPath": "Iteration"
- },
- "Project": ""
- }
+ "NetworkCredentials": {
+ "Domain": "",
+ "Password": "",
+ "UserName": ""
+ }
+ },
+ "AuthenticationMode": "AccessToken",
+ "Collection": "",
+ "LanguageMaps": {
+ "AreaPath": "Area",
+ "IterationPath": "Iteration"
+ },
+ "Project": ""
  }
  }
  }
@@ -42,25 +40,23 @@ configurationSamples:
  "Version": "16.0",
  "Endpoints": {
  "#KEY#": {
- "TfsEndpoint": {
- "AllowCrossProjectLinking": "False",
- "Authentication": {
- "AccessToken": "jklsadhjksahfkjsdhjksahsadjhksadhsad",
- "AuthenticationMode": "AccessToken",
- "NetworkCredentials": {
- "Domain": "",
- "Password": "",
- "UserName": ""
- }
- },
- "Collection": "https://dev.azure.com/nkdagility-preview/",
- "EndpointType": "TfsTeamProjectEndpoint",
- "LanguageMaps": {
- "AreaPath": "Area",
- "IterationPath": "Iteration"
- },
- "Project": "migrationSource1"
- }
+ "EndpointType": "TfsEndpoint",
+ "AllowCrossProjectLinking": "False",
+ "Authentication": {
+ "AccessToken": "jklsadhjksahfkjsdhjksahsadjhksadhsad",
+ "AuthenticationMode": "AccessToken",
+ "NetworkCredentials": {
+ "Domain": "",
+ "Password": "",
+ "UserName": ""
+ }
+ },
+ "Collection": "https://dev.azure.com/nkdagility-preview/",
+ "LanguageMaps": {
+ "AreaPath": "Area",
+ "IterationPath": "Iteration"
+ },
+ "Project": "migrationSource1"
  }
  }
  }

diff --git a/docs/_data/reference.endpoints.tfsteamprojectendpoint.yaml b/docs/_data/reference.endpoints.tfsteamprojectendpoint.yaml
@@ -9,26 +9,24 @@ configurationSamples:
  "Version": "16.0",
  "Endpoints": {
  "#KEY#": {
- "TfsTeamProjectEndpoint": {
- "AllowCrossProjectLinking": "False",
- "Authentication": {
- "AccessToken": "",
- "AuthenticationMode": "AccessToken",
- "NetworkCredentials": {
- "Domain": "",
- "Password": "",
- "UserName": ""
- }
- },
+ "EndpointType": "TfsTeamProjectEndpoint",
+ "AllowCrossProjectLinking": "False",
+ "Authentication": {
+ "AccessToken": "",
  "AuthenticationMode": "AccessToken",
- "Collection": "",
- "EndpointType": "TfsTeamProjectEndpoint",
- "LanguageMaps": {
- "AreaPath": "Area",
- "IterationPath": "Iteration"
- },
- "Project": ""
- }
+ "NetworkCredentials": {
+ "Domain": "",
+ "Password": "",
+ "UserName": ""
+ }
+ },
+ "AuthenticationMode": "AccessToken",
+ "Collection": "",
+ "LanguageMaps": {
+ "AreaPath": "Area",
+ "IterationPath": "Iteration"
+ },
+ "Project": ""
  }
  }
  }
@@ -42,25 +40,23 @@ configurationSamples:
  "Version": "16.0",
  "Endpoints": {
  "#KEY#": {
- "TfsTeamProjectEndpoint": {
- "AllowCrossProjectLinking": "False",
- "Authentication": {
- "AccessToken": "jklsadhjksahfkjsdhjksahsadjhksadhsad",
- "AuthenticationMode": "AccessToken",
- "NetworkCredentials": {
- "Domain": "",
- "Password": "",
- "UserName": ""
- }
- },
- "Collection": "https://dev.azure.com/nkdagility-preview/",
- "EndpointType": "TfsTeamProjectEndpoint",
- "LanguageMaps": {
- "AreaPath": "Area",
- "IterationPath": "Iteration"
- },
- "Project": "migrationSource1"
- }
+ "EndpointType": "TfsTeamProjectEndpoint",
+ "AllowCrossProjectLinking": "False",
+ "Authentication": {
+ "AccessToken": "jklsadhjksahfkjsdhjksahsadjhksadhsad",
+ "AuthenticationMode": "AccessToken",
+ "NetworkCredentials": {
+ "Domain": "",
+ "Password": "",
+ "UserName": ""
+ }
+ },
+ "Collection": "https://dev.azure.com/nkdagility-preview/",
+ "LanguageMaps": {
+ "AreaPath": "Area",
+ "IterationPath": "Iteration"
+ },
+ "Project": "migrationSource1"
  }
  }
  }

diff --git a/docs/_data/reference.processors.keepoutboundlinktargetprocessor.yaml b/docs/_data/reference.processors.keepoutboundlinktargetprocessor.yaml
@@ -17,7 +17,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": "8e55d369-07c8-4e19-9313-fd2543544c73",
+ "TargetLinksToKeepProject": "cf9756e9-69e6-4c9a-b8f4-f4f620151478",
  "CleanupFileName": "c:/temp/OutboundLinkTargets.bat",
  "PrependCommand": "start",
  "DryRun": true,

diff --git a/docs/collections/_reference/reference.endpoints.azuredevopsendpoint.md b/docs/collections/_reference/reference.endpoints.azuredevopsendpoint.md
@@ -14,13 +14,11 @@ configurationSamples:
  "Version": "16.0",
  "Endpoints": {
  "#KEY#": {
- "AzureDevOpsEndpoint": {
- "AccessToken": "jklsadhjksahfkjsdhjksahsadjhksadhsad",
- "AuthenticationMode": "AccessToken",
- "EndpointType": "AzureDevOpsEndpoint",
- "Organisation": "https://dev.azure.com/xxx/",
- "Project": "myProject"
- }
+ "EndpointType": "AzureDevOpsEndpoint",
+ "AccessToken": "jklsadhjksahfkjsdhjksahsadjhksadhsad",
+ "AuthenticationMode": "AccessToken",
+ "Organisation": "https://dev.azure.com/xxx/",
+ "Project": "myProject"
  }
  }
  }