Skip to content

Commit 5241537

Browse files
MrHinshMrHinsh
authored
Fix broken FieldMaps link in TfsWorkItemMigrationProcessor documentation (#2749)
The TfsWorkItemMigrationProcessor documentation contained a broken link to the FieldMaps reference that resulted in a 404 error when users tried to access it. ## Issue The link `[FieldMaps](../Reference/FieldMaps/index.md)` in the processor notes used an incorrect relative path. From the `/docs/Reference/Processors/` directory, the path `../Reference/FieldMaps/index.md` attempted to navigate to `/docs/Reference/Reference/FieldMaps/index.md` which doesn't exist. ## Solution - **Fixed the relative path**: Changed `../Reference/FieldMaps/index.md` to `../FieldMaps/index.md` in `TfsWorkItemMigrationProcessor-notes.md` - **Corrected ConsoleDataGenerator paths**: Fixed path resolution issues in `Program.cs` and `MarkdownLoader.cs` that prevented proper documentation regeneration - **Regenerated documentation**: Used the ConsoleDataGenerator to update all collections and data files with the corrected link ## Verification The fix ensures that: - The link correctly resolves from `/docs/Reference/Processors/` to `/docs/Reference/FieldMaps/index.md` - No broken FieldMaps links remain in the documentation - The target FieldMaps index page exists and is accessible - All generated documentation files contain the corrected link Users can now successfully navigate to the Field Maps documentation without encountering 404 errors. Fixes #2622. <!-- START COPILOT CODING AGENT TIPS --> --- 💬 Share your feedback on Copilot coding agent for the chance to win a $200 gift card! Click [here](https://survey.alchemer.com/s3/8343779/Copilot-Coding-agent) to start the survey.
2 parents eb60426 + d7c5946 commit 5241537

File tree

79 files changed

+175
-175
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

79 files changed

+175
-175
lines changed

‎docs/Reference/Processors/TfsWorkItemMigrationProcessor-notes.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ The above options allow you to bring over a sub-set of the WIs (using the `WIQLQ
4040

4141
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
4242

43-
A complete list of [FieldMaps](../Reference/FieldMaps/index.md) are available.
43+
A complete list of [FieldMaps](../FieldMaps/index.md) are available.
4444

4545
```
4646
"FieldMaps": [

‎docs/_data/reference.endpoints.azuredevopsendpoint.yaml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -66,5 +66,5 @@ options:
6666
defaultValue: missing XML code comments
6767
status: missing XML code comments
6868
processingTarget: missing XML code comments
69-
classFile: src/MigrationTools.Clients.AzureDevops.Rest/Endpoints/AzureDevOpsEndpoint.cs
69+
classFile: src/MigrationTools.Clients.AzureDevops.Rest/Endpoints/AzureDevOpsEndpointOptions.cs
7070
optionsClassFile: src/MigrationTools.Clients.AzureDevops.Rest/Endpoints/AzureDevOpsEndpointOptions.cs

‎docs/_data/reference.endpoints.tfsendpoint.yaml‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -117,5 +117,5 @@ options:
117117
defaultValue: missing XML code comments
118118
status: missing XML code comments
119119
processingTarget: missing XML code comments
120-
classFile: src/MigrationTools.Clients.TfsObjectModel/EndPoints/TfsEndpoint.cs
121-
optionsClassFile: src/MigrationTools.Clients.TfsObjectModel/EndPoints/TfsEndpointOptions.cs
120+
classFile: src/MigrationTools.Clients.TfsObjectModel/Endpoints/TfsEndpointOptions.cs
121+
optionsClassFile: src/MigrationTools.Clients.TfsObjectModel/Endpoints/TfsEndpointOptions.cs

‎docs/_data/reference.endpoints.tfsteamprojectendpoint.yaml‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -113,5 +113,5 @@ options:
113113
defaultValue: missing XML code comments
114114
status: missing XML code comments
115115
processingTarget: missing XML code comments
116-
classFile: src/MigrationTools.Clients.TfsObjectModel/EndPoints/TfsTeamProjectEndpoint.cs
117-
optionsClassFile: src/MigrationTools.Clients.TfsObjectModel/EndPoints/TfsTeamProjectEndPointOptions.cs
116+
classFile: src/MigrationTools.Clients.TfsObjectModel/Endpoints/TfsTeamProjectEndpoint.cs
117+
optionsClassFile: ''

‎docs/_data/reference.endpoints.tfsteamsettingsendpoint.yaml‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -54,5 +54,5 @@ options:
5454
defaultValue: missing XML code comments
5555
status: missing XML code comments
5656
processingTarget: missing XML code comments
57-
classFile: src/MigrationTools.Clients.TfsObjectModel/EndPoints/TfsTeamSettingsEndpoint.cs
58-
optionsClassFile: src/MigrationTools.Clients.TfsObjectModel/EndPoints/TfsTeamSettingsEndpointOptions.cs
57+
classFile: src/MigrationTools.Clients.TfsObjectModel/Endpoints/TfsTeamSettingsEndpointOptions.cs
58+
optionsClassFile: src/MigrationTools.Clients.TfsObjectModel/Endpoints/TfsTeamSettingsEndpointOptions.cs

‎docs/_data/reference.endpoints.tfsworkitemendpoint.yaml‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -59,5 +59,5 @@ options:
5959
defaultValue: missing XML code comments
6060
status: missing XML code comments
6161
processingTarget: missing XML code comments
62-
classFile: src/MigrationTools.Clients.TfsObjectModel/EndPoints/TfsWorkItemEndpoint.cs
63-
optionsClassFile: src/MigrationTools.Clients.TfsObjectModel/EndPoints/TfsWorkItemEndpointOptions.cs
62+
classFile: src/MigrationTools.Clients.TfsObjectModel/Endpoints/TfsWorkItemEndpoint.cs
63+
optionsClassFile: src/MigrationTools.Clients.TfsObjectModel/Endpoints/TfsWorkItemEndpointOptions.cs

‎docs/_data/reference.fieldmaps.fieldtofieldmap.yaml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -87,4 +87,4 @@ options:
8787
status: missing XML code comments
8888
processingTarget: missing XML code comments
8989
classFile: src/MigrationTools.Clients.TfsObjectModel/Tools/FieldMappingTool/FieldMaps/FieldToFieldMap.cs
90-
optionsClassFile: src/MigrationTools/Tools/FieldMappingTool/FieldMaps/FieldtoFieldMapOptions.cs
90+
optionsClassFile: ''

‎docs/_data/reference.fieldmaps.fieldtofieldmultimap.yaml‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -82,5 +82,5 @@ options:
8282
defaultValue: missing XML code comments
8383
status: missing XML code comments
8484
processingTarget: missing XML code comments
85-
classFile: src/MigrationTools.Clients.TfsObjectModel/Tools/FieldMappingTool/FieldMaps/FieldtoFieldMultiMap.cs
86-
optionsClassFile: src/MigrationTools/Tools/FieldMappingTool/FieldMaps/FieldtoFieldMultiMapOptions.cs
85+
classFile: ''
86+
optionsClassFile: ''

‎docs/_data/reference.processorenrichers.pauseaftereachitem.yaml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,5 +41,5 @@ options:
4141
defaultValue: missing XML code comments
4242
status: missing XML code comments
4343
processingTarget: missing XML code comments
44-
classFile: src/MigrationTools/Processors/Enrichers/PauseAfterEachItem.cs
44+
classFile: src/MigrationTools/Processors/Enrichers/PauseAfterEachItemOptions.cs
4545
optionsClassFile: src/MigrationTools/Processors/Enrichers/PauseAfterEachItemOptions.cs

‎docs/_data/reference.processors.azuredevopspipelineprocessor.yaml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -121,5 +121,5 @@ options:
121121
defaultValue: missing XML code comments
122122
status: Beta
123123
processingTarget: Pipelines
124-
classFile: src/MigrationTools.Clients.AzureDevops.Rest/Processors/AzureDevOpsPipelineProcessor.cs
124+
classFile: src/MigrationTools.Clients.AzureDevops.Rest/Processors/AzureDevOpsPipelineProcessorOptions.cs
125125
optionsClassFile: src/MigrationTools.Clients.AzureDevops.Rest/Processors/AzureDevOpsPipelineProcessorOptions.cs

0 commit comments

Comments
 (0)