Skip to content

Commit faf81b1

Browse files
authored
Add validation process documentation to getting started guide (#2966)
This pull request enhances the Azure DevOps Migration Tools documentation by introducing and emphasizing a new "Validation Process" section. The main goal is to guide users through the built-in validation steps that help catch configuration and data issues early, improving migration reliability and reducing errors. **New Validation Process Documentation:** * Added a dedicated `validation` page that explains the two-step validation process (pre-data-load and post-data-load), detailing the roles of `TfsWorkItemTypeValidatorTool` and `TfsValidateRequiredFieldTool`. This helps users understand how to verify their setup before migrating data. **References and Guidance Updates:** * Added a prominent note and section to the getting started guide, directing users to review the new validation process documentation before beginning migration. This helps prevent common mistakes and saves time. * Updated troubleshooting advice to include a link to the validation process documentation, ensuring users are aware of the full validation workflow and resources available.
2 parents bb6f4ec + 91e2365 commit faf81b1

File tree

2 files changed

+47
-0
lines changed

2 files changed

+47
-0
lines changed

docs/content/docs/get-started/getting-started/index.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,11 @@ Watch the [Video Overview](https://youtu.be/RCJsST0xBCE) to get started in 30 mi
1919
2. Check that you have the required [Permissions]({{< ref "docs/setup/permissions" >}}) to run the tools.
2020
3. Get to grips with the [Configuration]({{< ref "docs/reference" >}}) to understand how to configure the tool. (you can skip this for now and come back to it later)
2121

22+
23+
## Validation Process
24+
25+
> **Before you begin migration, review the [Validation Process documentation]({{< ref "docs/get-started/validation" >}}) to understand how the tools automatically check your configuration and data for common issues. This can save you significant time and help avoid common migration errors.**
26+
2227
## Getting Started
2328

2429
This is going to be a crash course and I really recommend watching [What can go wrong and what can go right with a migration via Azure DevOps](https://youtu.be/3jYFD-6_kZk?si=xxvBoljBWjGAOVuv) and then [Basic Work Item Migration with the Azure DevOps Migration Tools](https://youtu.be/Qt1Ywu_KLrc?si=uEXjLS2pwe244ugV) before you get started! This will prep you for the journey ahead.
@@ -106,6 +111,9 @@ Missing field 'Microsoft.VSTS.Common.CustomField' in 'User Story'.
106111
- **Solution 2:** Configure field mapping to map to an existing field
107112
- **Solution 3:** Exclude the field from validation if it's not needed
108113

114+
115+
For a complete overview of the validation process—including both pre-migration and pre-data-load validation steps—see the [Validation Process documentation]({{< ref "docs/get-started/validation" >}}).
116+
109117
For detailed troubleshooting and configuration options, see the [TfsWorkItemTypeValidatorTool documentation]({{< ref "docs/reference/tools/tfsworkitemtypevalidatortool" >}}).
110118

111119
**Remember:** If you want a processor to run, its `Enabled` attribute must be set to `true`.
Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
---
2+
title: "Validating your Azure DevOps Migration Tools migration"
3+
description: This tutorial covers the steps to validate and verify your migration using the Azure DevOps Migration Tools.
4+
short_title: Get Validated
5+
weight: 10
6+
aliases:
7+
- /validation/
8+
date: 2025-09-01T09:00:00Z
9+
10+
---
11+
12+
The Azure DevOps Migration Tools use a two-step validation process to ensure a smooth and successful migration. This process helps catch configuration or data issues early, saving time and preventing unnecessary data loading when migration cannot proceed.
13+
14+
## 1. Pre-Data-Load Validation
15+
16+
Before any data is loaded, the tool runs the [`TfsWorkItemTypeValidatorTool`]({{< ref "/docs/reference/tools/tfsworkitemtypevalidatortool/" >}}). This validator checks that all required work item types exist and are correctly mapped between the source and target systems. If any issues are found at this stage, the migration process stops immediately, preventing wasted effort on loading data that cannot be migrated.
17+
18+
**Key Points:**
19+
- Ensures work item types are valid and mapped before loading data
20+
- Prevents unnecessary data processing if migration cannot continue
21+
- Fast feedback for configuration issues
22+
23+
24+
## 2. Post-Data-Load Validation (Before Migration)
25+
26+
Before any data is actually migrated, the [`TfsValidateRequiredFieldTool`]({{< ref "/docs/reference/tools/tfsvalidaterequiredfieldtool/" >}}) runs. This validator checks that all required fields are present and populated in the data to be migrated. Running this validation step before migration helps minimize errors and ensures that the migration process will not fail due to missing or incomplete required fields.
27+
28+
**Key Points:**
29+
- Validates required fields before migration begins
30+
- Ensures all work items to be migrated meet requirements
31+
- Minimizes migration errors by catching issues early
32+
33+
## Why This Matters
34+
35+
By running validation both before and after data loading, the migration process minimizes wasted effort and maximizes the chances of a successful migration. Early detection of issues allows for quick resolution, while post-load validation ensures data quality and compliance.
36+
37+
For more details on each validator, see their dedicated documentation pages:
38+
- [`TfsWorkItemTypeValidatorTool`]({{< ref "/docs/reference/tools/tfsworkitemtypevalidatortool/" >}})
39+
- [`TfsValidateRequiredFieldTool`]({{< ref "/docs/reference/tools/tfsvalidaterequiredfieldtool/" >}})

0 commit comments

Comments
 (0)