Skip to content

Commit 0184c62

Browse files
authored
Fixes for navigation and schema discoverability (#2861)
This pull request focuses on restructuring and enhancing the documentation for Azure DevOps Migration Tools. Key changes include the addition of new metadata and schema sections, file renaming for better organization, and updates to links and aliases for improved navigation. ### Documentation Structure and Metadata Enhancements: * Added a new metadata section (`aliases`, `schema`) to multiple endpoint and field map documentation files, improving usability and schema visibility. [[1]](diffhunk://#diff-fba96ce250e1fa9ee52fdd8b14aa2b464a66d879436f1b606c4d199fc08c38b5R76-R79) [[2]](diffhunk://#diff-6735008a68d43be644815c277e34f9eaf43edcf5d665de9966ae7d2023329e35R39-R42) [[3]](diffhunk://#diff-ae316b227c65702fc96aef5173f8c82050e5457922bd4481a785ce25b9b2dc04R39-R42) [[4]](diffhunk://#diff-cda004d80a7014bc1ac0e3a94230aebc6498733af10ace4e3d7f5f3263c3e3fdR39-R42) [[5]](diffhunk://#diff-b48c36a2c2d9802d1df9b14eccae8522fdd55c902ea1567084f5b955bb6b7f2eR39-R42) [[6]](diffhunk://#diff-8d561afe52efa89d9d50e55317e87af7a1776749c61216e8c8314efa36de9149R39-R42) [[7]](diffhunk://#diff-01abf087b405883c4621bb109e6ca33556707c55f16df7521cf51ba076bc2511R93-R96) [[8]](diffhunk://#diff-909c057a0a9fcbef9e70057e5ae36d5b3a781f1381fbab03b20cb4b16e6575cbR68-R71) [[9]](diffhunk://#diff-67a218a3d9dab515cd9ca9553907b88eb4b1d19b2e4e2f38cbdad84fed9dccc6R38-R41) [[10]](diffhunk://#diff-d7e22a50195a059952de5e4ca22d9e3ca2e534610a8df8e87503d08a998cc3f0R38-R41) [[11]](diffhunk://#diff-18dc2e7ef22861eeaa30abf2d3068d5a600ce6ded9ca6693f52c0d50675237e2R38-R41) [[12]](diffhunk://#diff-44502d5464a9d8c1c9f06e5a644190b222dcf627722220234b593cc1914e07deR38-R41) [[13]](diffhunk://#diff-0b41b81e7c8fba7f3e840dc4abc44dafcc027210824fc8813429b307a9f922c0R38-R41) [[14]](diffhunk://#diff-49f391d06122a21853d2b5404d39f8b159483f2740d2ef3bd33b7315bd1db246R38-R41) ### File Renaming and Organization: * Renamed files such as `docs/content/docs/config-wizard.md` to `docs/content/docs/config/config-wizard/index.md` and `docs/content/schema/_index.md` to `docs/content/docs/config/schema/index.md` for better logical grouping and consistency. [[1]](diffhunk://#diff-08cc4b304924b438ec87ba9f623500f292b1b258ab0288dc2019b0252a88aaffL2-R3) [[2]](diffhunk://#diff-7da6088cf5fac1a52b351c46205ad57e48c12e73a015a8ef988ac04c40794dd3R6-R14) ### Content Updates: * Updated titles and descriptions to clarify the purpose of each document, such as refining the title of the configuration wizard to "Interactive Configuration Wizard for the Azure DevOps Migration Tools." [[1]](diffhunk://#diff-08cc4b304924b438ec87ba9f623500f292b1b258ab0288dc2019b0252a88aaffL2-R3) [[2]](diffhunk://#diff-ea82be9980451b292537f643907453dbf591b4a8d0d45f3505b7601873535f95R1-R8) * Corrected and updated internal links, such as pointing the "Interactive Configuration Wizard" link in the Getting Started guide to its new location. ### Minor Fixes: * Removed redundant blank lines and improved formatting in several documentation files for consistency. [[1]](diffhunk://#diff-01abf087b405883c4621bb109e6ca33556707c55f16df7521cf51ba076bc2511L30) [[2]](diffhunk://#diff-909c057a0a9fcbef9e70057e5ae36d5b3a781f1381fbab03b20cb4b16e6575cbL52) [[3]](diffhunk://#diff-909c057a0a9fcbef9e70057e5ae36d5b3a781f1381fbab03b20cb4b16e6575cbL38) These changes collectively improve the structure, readability, and usability of the documentation for users of Azure DevOps Migration Tools.
2 parents 77fa186 + 696ec94 commit 0184c62

File tree

56 files changed

+546
-299
lines changed

Some content is hidden

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

56 files changed

+546
-299
lines changed

docs/content/docs/config/_index.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
---
2+
title: Configuration for Azure DevOps Migration Tools
3+
description: |
4+
Learn how to configure Azure DevOps Migration Tools for your migration projects. This guide covers the main configuration schema, component schemas, and usage examples.
5+
short_title: Configuration
6+
weight: 50
7+
date: 2025-06-24T12:07:31Z
8+
---

docs/content/docs/config-wizard.md renamed to docs/content/docs/config/config-wizard/index.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
---
2-
title: Interactive Configuration Wizard
2+
title: Interactive Configuration Wizard for the Azur eDevOps Migration Tools
3+
short_title: Config Wizard
34
description: Build your Azure DevOps Migration Tools configuration with our interactive step-by-step wizard supporting three migration type architectures
45
weight: 50
56
date: 2025-06-26T12:00:00Z
Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,21 +3,23 @@ title: "JSON Schemas"
33
description: "JSON Schema definitions for Azure DevOps Migration Tools configuration"
44
weight: 10
55
outputs: ["html", "schema-catalog"]
6+
aliases:
7+
- /schema/
68
---
79

810
The Azure DevOps Migration Tools provide JSON Schema definitions for configuration validation and IDE support.
911

1012
## Main Configuration Schema
1113

12-
- **[Configuration Schema](configuration.schema.json)** - Complete configuration schema for Azure DevOps Migration Tools
14+
- **[Configuration Schema](/schema/configuration.schema.json)** - Complete configuration schema for Azure DevOps Migration Tools
1315

1416
## Component Schemas
1517

1618
### Processors
1719

1820
{{< schema-list type="processors" >}}
1921

20-
### Tools
22+
### Tools
2123

2224
{{< schema-list type="tools" >}}
2325

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

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
11
---
2-
title: 'Tutorial: Get started with the Azure DevOps Migration Tools'
2+
title: "Tutorial: Get started with the Azure DevOps Migration Tools"
33
description: Performs mathematical calculations on numeric fields using NCalc expressions during migration.
44
short_title: Get Started
55
weight: 1
66
aliases:
7-
- /getting-started/
7+
- /getting-started/
88
date: 2025-06-24T12:07:31Z
99
discussionId: 2828
10-
1110
---
11+
1212
If you want to perform a bulk edit or a migration then you need to start here. This tool has been tested on updating from 100 to 250,000 work items by its users.
1313

1414
Watch the [Video Overview](https://youtu.be/RCJsST0xBCE) to get started in 30 minutes. This tool is complicated and it's not always easy to discover what you need to do.
@@ -23,7 +23,7 @@ Watch the [Video Overview](https://youtu.be/RCJsST0xBCE) to get started in 30 mi
2323

2424
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.
2525

26-
> **New to migration tools?** Try our [Interactive Configuration Wizard]({{< ref "docs/config-wizard" >}}) to build your configuration step-by-step with guided explanations!
26+
> **New to migration tools?** Try our [Interactive Configuration Wizard]({{< ref "docs/config/config-wizard" >}}) to build your configuration step-by-step with guided explanations!
2727
2828
### 1. Create a default configuration file
2929

docs/content/docs/reference/endpoints/azure-devops-endpoint/index.md

Lines changed: 9 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -4,14 +4,14 @@ description: Azure DevOps REST API endpoint implementation for connecting to Azu
44
dataFile: reference.endpoints.azuredevopsendpoint.yaml
55
slug: azure-devops-endpoint
66
aliases:
7-
- /docs/Reference/Endpoints/AzureDevOpsEndpoint
8-
- /Reference/Endpoints/AzureDevOpsEndpoint
9-
- /learn/azure-devops-migration-tools/Reference/Endpoints/AzureDevOpsEndpoint
10-
- /learn/azure-devops-migration-tools/Reference/Endpoints/AzureDevOpsEndpoint/index.md
7+
- /docs/Reference/Endpoints/AzureDevOpsEndpoint
8+
- /Reference/Endpoints/AzureDevOpsEndpoint
9+
- /learn/azure-devops-migration-tools/Reference/Endpoints/AzureDevOpsEndpoint
10+
- /learn/azure-devops-migration-tools/Reference/Endpoints/AzureDevOpsEndpoint/index.md
1111
date: 2025-06-24T12:07:31Z
1212
discussionId: 2702
13-
1413
---
14+
1515
The Azure DevOps Endpoint is a critical component of the Azure DevOps Migration Tools that facilitates seamless connectivity between your migration processes and Azure DevOps organizations. This endpoint leverages the Azure DevOps REST API to provide comprehensive access to projects, work items, and other Azure DevOps resources.
1616

1717
## Purpose and Use Cases
@@ -73,3 +73,7 @@ Be aware of these limitations when using the Azure DevOps Endpoint:
7373
## Metadata
7474

7575
{{< class-metadata >}}
76+
77+
## Schema
78+
79+
{{< class-schema >}}

docs/content/docs/reference/endpoints/file-system-work-item-endpoint/index.md

Lines changed: 9 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -5,14 +5,14 @@ description: |
55
dataFile: reference.endpoints.filesystemworkitemendpoint.yaml
66
slug: file-system-work-item-endpoint
77
aliases:
8-
- /docs/Reference/Endpoints/FileSystemWorkItemEndpoint
9-
- /Reference/Endpoints/FileSystemWorkItemEndpoint
10-
- /learn/azure-devops-migration-tools/Reference/Endpoints/FileSystemWorkItemEndpoint
11-
- /learn/azure-devops-migration-tools/Reference/Endpoints/FileSystemWorkItemEndpoint/index.md
8+
- /docs/Reference/Endpoints/FileSystemWorkItemEndpoint
9+
- /Reference/Endpoints/FileSystemWorkItemEndpoint
10+
- /learn/azure-devops-migration-tools/Reference/Endpoints/FileSystemWorkItemEndpoint
11+
- /learn/azure-devops-migration-tools/Reference/Endpoints/FileSystemWorkItemEndpoint/index.md
1212
date: 2025-06-24T12:07:31Z
1313
discussionId: 2797
14-
1514
---
15+
1616
{{< class-description >}}
1717

1818
## Options
@@ -36,3 +36,7 @@ discussionId: 2797
3636
## Metadata
3737

3838
{{< class-metadata >}}
39+
40+
## Schema
41+
42+
{{< class-schema >}}

docs/content/docs/reference/endpoints/tfs-endpoint/index.md

Lines changed: 9 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -5,14 +5,14 @@ description: |
55
dataFile: reference.endpoints.tfsendpoint.yaml
66
slug: tfs-endpoint
77
aliases:
8-
- /docs/Reference/Endpoints/TfsEndpoint
9-
- /Reference/Endpoints/TfsEndpoint
10-
- /learn/azure-devops-migration-tools/Reference/Endpoints/TfsEndpoint
11-
- /learn/azure-devops-migration-tools/Reference/Endpoints/TfsEndpoint/index.md
8+
- /docs/Reference/Endpoints/TfsEndpoint
9+
- /Reference/Endpoints/TfsEndpoint
10+
- /learn/azure-devops-migration-tools/Reference/Endpoints/TfsEndpoint
11+
- /learn/azure-devops-migration-tools/Reference/Endpoints/TfsEndpoint/index.md
1212
date: 2025-06-24T12:07:31Z
1313
discussionId: 2796
14-
1514
---
15+
1616
{{< class-description >}}
1717

1818
## Options
@@ -36,3 +36,7 @@ discussionId: 2796
3636
## Metadata
3737

3838
{{< class-metadata >}}
39+
40+
## Schema
41+
42+
{{< class-schema >}}

docs/content/docs/reference/endpoints/tfs-team-project-endpoint/index.md

Lines changed: 9 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -5,14 +5,14 @@ description: |
55
dataFile: reference.endpoints.tfsteamprojectendpoint.yaml
66
slug: tfs-team-project-endpoint
77
aliases:
8-
- /docs/Reference/Endpoints/TfsTeamProjectEndpoint
9-
- /Reference/Endpoints/TfsTeamProjectEndpoint
10-
- /learn/azure-devops-migration-tools/Reference/Endpoints/TfsTeamProjectEndpoint
11-
- /learn/azure-devops-migration-tools/Reference/Endpoints/TfsTeamProjectEndpoint/index.md
8+
- /docs/Reference/Endpoints/TfsTeamProjectEndpoint
9+
- /Reference/Endpoints/TfsTeamProjectEndpoint
10+
- /learn/azure-devops-migration-tools/Reference/Endpoints/TfsTeamProjectEndpoint
11+
- /learn/azure-devops-migration-tools/Reference/Endpoints/TfsTeamProjectEndpoint/index.md
1212
date: 2025-06-24T12:07:31Z
1313
discussionId: 2795
14-
1514
---
15+
1616
{{< class-description >}}
1717

1818
## Options
@@ -36,3 +36,7 @@ discussionId: 2795
3636
## Metadata
3737

3838
{{< class-metadata >}}
39+
40+
## Schema
41+
42+
{{< class-schema >}}

docs/content/docs/reference/endpoints/tfs-team-settings-endpoint/index.md

Lines changed: 9 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -5,14 +5,14 @@ description: |
55
dataFile: reference.endpoints.tfsteamsettingsendpoint.yaml
66
slug: tfs-team-settings-endpoint
77
aliases:
8-
- /docs/Reference/Endpoints/TfsTeamSettingsEndpoint
9-
- /Reference/Endpoints/TfsTeamSettingsEndpoint
10-
- /learn/azure-devops-migration-tools/Reference/Endpoints/TfsTeamSettingsEndpoint
11-
- /learn/azure-devops-migration-tools/Reference/Endpoints/TfsTeamSettingsEndpoint/index.md
8+
- /docs/Reference/Endpoints/TfsTeamSettingsEndpoint
9+
- /Reference/Endpoints/TfsTeamSettingsEndpoint
10+
- /learn/azure-devops-migration-tools/Reference/Endpoints/TfsTeamSettingsEndpoint
11+
- /learn/azure-devops-migration-tools/Reference/Endpoints/TfsTeamSettingsEndpoint/index.md
1212
date: 2025-06-24T12:07:31Z
1313
discussionId: 2794
14-
1514
---
15+
1616
{{< class-description >}}
1717

1818
## Options
@@ -36,3 +36,7 @@ discussionId: 2794
3636
## Metadata
3737

3838
{{< class-metadata >}}
39+
40+
## Schema
41+
42+
{{< class-schema >}}

docs/content/docs/reference/endpoints/tfs-work-item-endpoint/index.md

Lines changed: 9 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -5,14 +5,14 @@ description: |
55
dataFile: reference.endpoints.tfsworkitemendpoint.yaml
66
slug: tfs-work-item-endpoint
77
aliases:
8-
- /docs/Reference/Endpoints/TfsWorkItemEndpoint
9-
- /Reference/Endpoints/TfsWorkItemEndpoint
10-
- /learn/azure-devops-migration-tools/Reference/Endpoints/TfsWorkItemEndpoint
11-
- /learn/azure-devops-migration-tools/Reference/Endpoints/TfsWorkItemEndpoint/index.md
8+
- /docs/Reference/Endpoints/TfsWorkItemEndpoint
9+
- /Reference/Endpoints/TfsWorkItemEndpoint
10+
- /learn/azure-devops-migration-tools/Reference/Endpoints/TfsWorkItemEndpoint
11+
- /learn/azure-devops-migration-tools/Reference/Endpoints/TfsWorkItemEndpoint/index.md
1212
date: 2025-06-24T12:07:31Z
1313
discussionId: 2793
14-
1514
---
15+
1616
{{< class-description >}}
1717

1818
## Options
@@ -36,3 +36,7 @@ discussionId: 2793
3636
## Metadata
3737

3838
{{< class-metadata >}}
39+
40+
## Schema
41+
42+
{{< class-schema >}}

0 commit comments

Comments
 (0)