Skip to content

Commit f9446c4

Browse files
committed
Improve documentation for FixedTargetFields property in TfsWorkItemTypeValidatorToolOptions
1 parent 9d33900 commit f9446c4

File tree

3 files changed

+13
-10
lines changed

3 files changed

+13
-10
lines changed

docs/content/docs/how-to/creating-iteration-and-area-maps/index.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,13 +7,13 @@ discussionId: 1846
77
date: 2025-06-24T12:07:31Z
88

99
---
10-
As per the [documentation]({{< ref "docs/reference/tools/tfs-node-structure-tool" >}}), you need to add Iteration Maps and Area Maps that adapt the old locations to new ones that are valid in the Target.
10+
As per the [documentation]({{< ref "docs/reference/tools/tfsnodestructuretool" >}}), you need to add Iteration Maps and Area Maps that adapt the old locations to new ones that are valid in the Target.
1111

1212
**NOTE: It is NOT possible to migrate a work item if the Area or Iteration path does not exist on the target project. This is because the work item will be created with the same Area and Iteration path as the source work item. If the path does not exist, the work item will not be created. _There is no way around this!_**
1313

1414
Before your migration starts, it will validate that all of the Areas and Iterations from the **Source** work items revisions exist on the **Target**. Any that do not exist will be flagged in the logs, and if you have `"StopMigrationOnMissingAreaIterationNodes": true,` set, the migration will stop just after it outputs a list of the missing nodes.
1515

16-
Our algorithm that converts the Source nodes to Target nodes processes the [mappings]({{< ref "docs/reference/tools/tfs-node-structure-tool" >}}) at that time. This means that any valid mapped nodes will never be caught by the `This path is not anchored in the source project` message, as they are already altered to be valid.
16+
Our algorithm that converts the Source nodes to Target nodes processes the [mappings]({{< ref "docs/reference/tools/tfsnodestructuretool" >}}) at that time. This means that any valid mapped nodes will never be caught by the `This path is not anchored in the source project` message, as they are already altered to be valid.
1717

1818
> We recently updated the logging for this part of the system to more easily debug both your mappings and to see what the system is doing with the nodes and their current state. You can set `"LogLevel": "Debug"` to see the details.
1919
@@ -248,4 +248,4 @@ Here's a complete example showing the TfsNodeStructureTool configuration with bo
248248
}
249249
```
250250

251-
For more detailed information and advanced configuration options, refer to the complete [TFS Node Structure Tool documentation]({{< ref "docs/reference/tools/tfs-node-structure-tool" >}}).
251+
For more detailed information and advanced configuration options, refer to the complete [TFS Node Structure Tool documentation]({{< ref "docs/reference/tools/tfsnodestructuretool" >}}).

docs/content/docs/reference/processors/tfs-workitem-migration-processor/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -124,4 +124,4 @@ A complete list of [FieldMaps](../FieldMaps/index.md) are available.
124124
125125
## Removed Properties
126126

127-
- PrefixProjectToNodes - This option was removed in favour of the Area and Iteration Maps on [TfsNodeStructure]({{< ref "docs/reference/tools/tfs-node-structure-tool" >}})
127+
- PrefixProjectToNodes - This option was removed in favour of the Area and Iteration Maps on [TfsNodeStructure]({{< ref "docs/reference/tools/tfsnodestructuretool" >}})

src/MigrationTools.Clients.TfsObjectModel/Tools/TfsWorkItemTypeValidatorToolOptions.cs

Lines changed: 9 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -30,14 +30,17 @@ public class TfsWorkItemTypeValidatorToolOptions : ToolOptions
3030

3131
/// <summary>
3232
/// <para>
33-
/// List of target fields, that are considered as fixed. It means, even if the field is different against
34-
/// source field, no warning will be triggered, jus information about the differences.
35-
/// Use this list, whan you know about the differences between fields, but resolved it for example by
36-
/// using <see cref="FieldMappingTool"/>.
33+
/// List of target fields that are considered as <c>fixed</c>.
34+
/// A field marked as fixed will not stop the migration if differences are found.
35+
/// Instead of a warning, only an informational message will be logged.
3736
/// </para>
3837
/// <para>
39-
/// Key is target work item type name. As this name, you can use <c>*</c> to define fixed fields which will be applied
40-
/// to all work item types.
38+
/// Use this list when you already know about the differences and have resolved them,
39+
/// for example by using <see cref="FieldMappingTool"/>.
40+
/// </para>
41+
/// <para>
42+
/// The key is the target work item type name.
43+
/// You can also use <c>*</c> to define fixed fields that apply to all work item types.
4144
/// </para>
4245
/// </summary>
4346
public Dictionary<string, List<string>> FixedTargetFields { get; set; } = [];

0 commit comments

Comments
 (0)