Skip to content

Commit b7e8496

Browse files
authored
New Site fixes (#2834)
📝 (docs): enhance field map documentation with structured sections Add structured sections such as "Samples" and "Metadata" to the field-calculation-map and field-clear-map documentation. Introduce class-description and class-options for better content organization. Remove unnecessary horizontal rules for cleaner formatting. These changes improve the readability and usability of the documentation by providing clear, organized sections and examples, making it easier for users to understand and implement the field maps.
2 parents 8c7070f + 52c8869 commit b7e8496

File tree

66 files changed

+253
-129
lines changed

Some content is hidden

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

66 files changed

+253
-129
lines changed

.github/workflows/main.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -83,8 +83,8 @@ jobs:
8383
with:
8484
filters: |
8585
src:
86-
- 'src/**'
87-
- '!src/MigrationTools.Telemetery/**'
86+
- '**'
87+
- '!docs/**'
8888
docs:
8989
- 'docs/**'
9090
automation:

.powershell/docs/Update-Docs.ps1

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
# Helpers
2+
. ./.powershell/docs/_includes/IncludesForAll.ps1
3+
$levelSwitch.MinimumLevel = 'Information'
4+
5+
$hugoMarkdownObjects = Get-RecentHugoMarkdownResources -Path ".\docs\content\docs\"
6+
7+
foreach ($hugoMarkdown in $hugoMarkdownObjects) {
8+
9+
if ( $hugoMarkdown.FrontMatter.dataFile) {
10+
$classDataFile = (Join-Path "docs" $hugoMarkdown.FrontMatter.dataFile)
11+
if (Test-Path -Path $classDataFile) {
12+
$classData = Get-Content -Path $classDataFile -Raw | ConvertFrom-Yaml
13+
Write-InformationLog $classData.description
14+
if ($classData.description -ne "missing XML code comments") {
15+
$newDescription = $classData.description
16+
}
17+
}
18+
}
19+
20+
If ($newDescription -eq $null) {
21+
Write-ErrorLog "No description found for $($hugoMarkdown.FilePath)"
22+
continue
23+
}
24+
25+
26+
Update-Field -FieldName 'description' -FieldValue $newDescription -frontMatter $hugoMarkdown.frontMatter -addAfter "title"
27+
Save-HugoMarkdown -HugoMarkdown $hugoMarkdown -Path $hugoMarkdown.FilePath
28+
29+
30+
31+
32+
}

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

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
---
22
title: 'Tutorial: Get started with the Azure DevOps Migration Tools'
3+
description: Performs mathematical calculations on numeric fields using NCalc expressions during migration.
34
short_title: Get Started
45
weight: 1
56
aliases:

docs/content/docs/get-started/version-control/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
---
22
title: Getting Started with Git and TFVC Version Control
3-
short_title: Version Control
43
description: |
54
While we do not migrate source control for you, we do have tools to maintain the links between work items and source code.
5+
short_title: Version Control
66
aliases:
77
- /version-control/
88
date: 2025-06-24T12:07:31Z

docs/content/docs/how-to/_index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
---
22
title: How-To Guides for Azure DevOps Migration Tools
3-
short_title: How-To Guides
43
description: |
54
This section provides step-by-step guides on how to use the Azure DevOps Migration Tools effectively, covering various aspects of migration and configuration.
5+
short_title: How-To Guides
66
weight: 3
77
date: 2025-06-24T12:07:31Z
88
discussionId: 2826

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
@@ -1,12 +1,12 @@
11
---
2-
title: "How-To: Creating area and iteration maps"
3-
short_title: Creating area and iteration maps
2+
title: 'How-To: Creating area and iteration maps'
43
description: |
54
This guide explains how to create area and iteration maps for Azure DevOps Migration Tools, allowing you to adapt old locations to new ones during migration.
5+
short_title: Creating area and iteration maps
66
discussionId: 1846
77
date: 2025-06-24T12:07:31Z
8-
---
98

9+
---
1010
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.
1111

1212
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.

docs/content/docs/how-to/migrating-plans-and-suites/index.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
---
2-
title: "How-to: Migrating Plans and Suites"
3-
short_title: Migrating Plans and Suites
2+
title: 'How-to: Migrating Plans and Suites'
43
description: |
54
This guide explains how to migrate Test Plans and Suites in Azure DevOps, including handling Shared Steps and Shared Parameters, and rebuilding Test Plans and Suites.
5+
short_title: Migrating Plans and Suites
66
discussionId: 2049
77
date: 2025-06-24T12:07:31Z
8-
---
98

9+
---
1010
Migrating Plans and Suites is quite convoluted since Shared Steps, which we need to map, can't have a custom field.
1111

1212
1. Migrate Basic Work Items

docs/content/docs/how-to/user-mappings/index.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
---
2-
title: "How-To: User Mappings"
3-
short_title: User Mappings
2+
title: 'How-To: User Mappings'
43
description: |
54
This guide explains how to map users between source and target systems in Azure DevOps migrations, ensuring integrity across different systems.
5+
short_title: User Mappings
66
discussionId: 2266
77
date: 2025-06-24T12:07:31Z
8-
---
98

9+
---
1010
There was a request to have the ability to map users to try and maintain integrity across different systems. We added a `TfsUserMappingEnricher` that allows you to map users from Source to Target... this is not free and takes some work. Running the `ExportUsersForMappingConfig` to get the list of users will produce:
1111

1212
```
Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,17 @@
11
---
22
title: Reference for Azure DevOps Migration Tools
3+
description: Performs mathematical calculations on numeric fields using NCalc expressions during migration.
34
short_title: Reference
45
weight: 1000
56
date: 2025-06-24T12:07:31Z
67
discussionId: 2821
78
aliases:
8-
- /learn/azure-devops-migration-tools/reference/
9-
- /learn/azure-devops-migration-tools/reference/index.md
10-
- /learn/azure-devops-migration-tools/reference/_index.md
11-
- /learn/azure-devops-migration-tools/reference/overview/
12-
- /learn/azure-devops-migration-tools/reference/overview/index.md
13-
- /learn/azure-devops-migration-tools/Reference/
9+
- /learn/azure-devops-migration-tools/reference/
10+
- /learn/azure-devops-migration-tools/reference/index.md
11+
- /learn/azure-devops-migration-tools/reference/_index.md
12+
- /learn/azure-devops-migration-tools/reference/overview/
13+
- /learn/azure-devops-migration-tools/reference/overview/index.md
14+
- /learn/azure-devops-migration-tools/Reference/
15+
1416
---
1517

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,13 @@
11
---
22
title: Endpoints
3-
short_title: Endpoints
43
description: |
54
This section provides an overview of the endpoints used in the Azure DevOps Migration Tools, including their configuration and usage.Endpoints are used to define the access to TFS/Azure DevOps servers. They are used to connect to the source and target servers for migration.
5+
short_title: Endpoints
66
date: 2025-06-24T12:07:31Z
77
discussionId: 2799
88
aliases:
9-
- /learn/azure-devops-migration-tools/Reference/Endpoints/
10-
- /Reference/Processors/Endpoints/index.md
9+
- /learn/azure-devops-migration-tools/Reference/Endpoints/
10+
- /Reference/Processors/Endpoints/index.md
11+
1112
---
1213
Endpoints are defined in the `endpoints` section of the configuration file. Each endpoint must have a unique name and specify the type of server it connects to, such as Azure DevOps Services, Azure DevOps Server, or TFS.

0 commit comments

Comments
 (0)