Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix documentation issues (mostly typos) #2587

Merged
merged 5 commits into from
Jan 24, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/bug.yml
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ body:
- type: markdown
attributes:
value: |
Thanks for taking the time to fill out this bug report! If you have questions or want to discus how the tool works then please [open a discussion](https://github.com/nkdAgility/azure-devops-migration-tools/discussions) instead of filing a bug report.
Thanks for taking the time to fill out this bug report! If you have questions or want to discuss how the tool works then please [open a discussion](https://github.com/nkdAgility/azure-devops-migration-tools/discussions) instead of filing a bug report.
- type: checkboxes
attributes:
label: Version
Expand Down
2 changes: 1 addition & 1 deletion .github/PULL_REQUEST_TEMPLATE/default.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ Fixes # (issue)

## Things to be aware of

- **Logging uses serilog** - All Logging should be in the format `"My message that contains {item} and {item2}", item, itesm2`! Do not use `$"My message that contains {item} and {item2}"` to pass text into the log strings as this disables [Serilog](https://serilog.net/)'s ability to pass that data as telemetry to Application Insights and for log highlighting.
- **Logging uses serilog** - All Logging should be in the format `"My message that contains {item} and {item2}", item, item2`! Do not use `$"My message that contains {item} and {item2}"` to pass text into the log strings as this disables [Serilog](https://serilog.net/)'s ability to pass that data as telemetry to Application Insights and for log highlighting.

## Type of change

Expand Down
2 changes: 1 addition & 1 deletion _config.yml
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
title: Azure DevOps Migration Tools
description: Azure DevOps Migration Tools allow you to migrate Teams, Backlogs, Tasks, Test Cases, and Plans & Suits from one Project to another in Azure DevOps / TFS both within the same Organisation, and between Organisations.
description: Azure DevOps Migration Tools allow you to migrate Teams, Backlogs, Tasks, Test Cases, and Plans & Suites from one Project to another in Azure DevOps / TFS both within the same Organisation, and between Organisations.
parent_title: The Azure DevOps Migration Tools allow you to bulk edit and migrate data between Team Projects on both Microsoft Team Foundation Server (TFS) and Azure DevOps Services.
parent_url: https://nkdagility.com

Expand Down
7 changes: 2 additions & 5 deletions docs/Reference/FieldMaps/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,12 +4,9 @@ layout: page
pageType: index
toc: true
pageStatus: published
discussionId:
discussionId:
---

These fieldMaps are provided to allow you to mondify the data as you do the migration.
These fieldMaps are provided to allow you to modify the data as you do the migration.

{% include content-collection-table.html collection = "reference" typeName = "FieldMaps" architecture = "v1" %}



30 changes: 14 additions & 16 deletions docs/Reference/ProcessorEnrichers/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,35 +6,33 @@ toc: true
pageStatus: published
---


Processor Enrichers are run within the context of the ProcessorProcessor that they are
configured for. Many Processor Enrichers are flexable, however there are also enrichers that only
Processor Enrichers are run within the context of the ProcessorProcessor that they are
configured for. Many Processor Enrichers are flexible, however there are also enrichers that only
work with certain Processors.

Processor Enricher | Processor(s) | Description
----------|-----------|------------
PauseAfterEachItem | Any | TBA
AppendMigrationToolSignatureFooter | WorkItem | TBA
FilterWorkItemsThatAlreadyExistInTarget | WorkItem | TBA
SkipToFinalRevisedWorkItemType | WorkItem | TBA
| Processor Enricher | Processor(s) | Description |
| --------------------------------------- | ------------ | ----------- |
| PauseAfterEachItem | Any | TBA |
| AppendMigrationToolSignatureFooter | WorkItem | TBA |
| FilterWorkItemsThatAlreadyExistInTarget | WorkItem | TBA |
| SkipToFinalRevisedWorkItemType | WorkItem | TBA |

### Processor Pipline

- ProcessorExecutionBegin
- ProcessorExecutionAfterSource
- ProcessorExecutionBeforeProcessWorkItem
- ProcessorExecutionAfterProcessWorkItem
- ProcessorExecutionEnd
- ProcessorExecutionBegin
- ProcessorExecutionAfterSource
- ProcessorExecutionBeforeProcessWorkItem
- ProcessorExecutionAfterProcessWorkItem
- ProcessorExecutionEnd

### Processor Enricher Options

All Processor Enrichers have a minimum set of options that are required to run.
All Processor Enrichers have a minimum set of options that are required to run.

#### Minimum Options to run

The `Enabled` options is common to all Processor Enrichers.


```JSON
{
"ObjectType": "ProcessorEnrichersOptions",
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@

## Additional Samples & Info

To run a full plans and suits you should run the three processors in this order below. `TestVariablesMigrationConfig` and `TestConfigurationsMigrationConfig` only need run once.
To run a full plans and suites you should run the three processors in this order below. `TestVariablesMigrationConfig` and `TestConfigurationsMigrationConfig` only need run once.

```json
"Processors": [
Expand Down Expand Up @@ -30,10 +29,11 @@ To run a full plans and suits you should run the three processors in this order
}
]
```

## Known working TestPlanQueryBit filter fields names

`AreaPath`, `PlanName` and `PlanState`

```json
"TestPlanQueryBit": "PlanName = 'ABC'"
```
```
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
## <a name="WIQLQuery"></a>WIQL Query

The Work Item queries are all built using Work Item [Query Language (WIQL)](https://docs.microsoft.com/en-us/azure/devops/boards/queries/wiql-syntax). We only support flat quereis that have `FROM WorkItems` in the query.
The Work Item queries are all built using Work Item [Query Language (WIQL)](https://docs.microsoft.com/en-us/azure/devops/boards/queries/wiql-syntax). We only support flat quereis that have `FROM WorkItems` in the query.

> Note: A useful Azure DevOps Extension to explore WIQL is the [WIQL Editor](https://marketplace.visualstudio.com/items?itemName=ottostreifel.wiql-editor)

Expand All @@ -13,26 +13,32 @@ A simple example config:
```
"WIQLQuery": "SELECT [System.Id] FROM WorkItems WHERE [System.TeamProject] = @TeamProject AND [System.WorkItemType] NOT IN ('Test Suite', 'Test Plan','Shared Steps','Shared Parameter','Feedback Request') ORDER BY [System.ChangedDate] desc"
```

Scope to Area Path (Team data):

```
"WIQLQuery": "SELECT [System.Id] FROM WorkItems WHERE [System.TeamProject] = @TeamProject AND [System.AreaPath] UNDER 'project\Team 1\' AND [System.WorkItemType] NOT IN ('Test Suite', 'Test Plan','Shared Steps','Shared Parameter','Feedback Request') ORDER BY [System.ChangedDate] desc"
```

## <a name="NodeBasePath"></a>NodeBasePath Configuration
Limit to specific work items (for testing purposes)

Moved to the TfsNodeStructure
```
"WIQLQuery": "SELECT [System.Id] FROM WorkItems WHERE [System.Id] in (123,456,789) AND [System.TeamProject] = @TeamProject AND [System.AreaPath] UNDER 'project\Team 1\' AND [System.WorkItemType] NOT IN ('Test Suite', 'Test Plan','Shared Steps','Shared Parameter','Feedback Request') ORDER BY [System.ChangedDate] desc"
```

# Iteration Maps and Area Maps
## <a name="NodeBasePath"></a>NodeBasePath Configuration

Moved to the TfsNodeStructure

# Iteration Maps and Area Maps

Moved to the TfsNodeStructure

## More Complex Team Migrations

The above options allow you to bring over a sub-set of the WIs (using the `WIQLQueryBit`) and move their area or iteration path to a default location. However you may wish to do something more complex e.g. re-map the team structure. This can be done with addition of a `FieldMaps` block to configuration in addition to the `NodeBasePaths`.

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

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

Expand All @@ -54,7 +60,7 @@ A complete list of [FieldMaps](../Reference/FieldMaps/index.md) are available.

```

> Note: This mappings could also be achieved with other forms of Field mapper e.g. `RegexFieldMapConfig`, but the value mapper as an example is easy to understand
> Note: These mappings could also be achieved with other forms of Field mapper e.g. `RegexFieldMapConfig`, but the value mapper as an example is easy to understand

# Removed Properties

Expand Down
27 changes: 13 additions & 14 deletions docs/Reference/Processors/index2.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,32 +4,31 @@ layout: page
pageType: index
toc: true
pageStatus: published
discussionId:
discussionId:
---

We provide a number of Processors that can be used to migrate diferent sorts of data.

| Processors | Status | Target | Usage |
|------------------------|---------|---------|------------------------------------------|
| [AzureDevOpsPipelineProcessor](AzureDevOpsPipelineProcessor.md) | Beta | Pipelines | Azure DevOps Processor that migrates Taskgroups, Build- and Release Pipelines. |
| [ProcessDefinitionProcessor](ProcessDefinitionProcessor.md) | Beta | Pipelines | Process definition processor used to keep processes between two orgs in sync |
| [TfsAreaAndIterationProcessor](TfsAreaAndIterationProcessor.md) | Beta | Work Items | The `TfsAreaAndIterationProcessor` migrates all of the Area nd Iteraion paths. |
| [TfsSharedQueryProcessor](TfsSharedQueryProcessor.md) | Beta | Queries | The TfsSharedQueryProcessor enabled you to migrate queries from one locatio nto another. |
| [TfsTeamSettingsProcessor](TfsTeamSettingsProcessor.md) | Beta | Teams | Native TFS Processor, does not work with any other Endpoints. |
| [WorkItemTrackingProcessor](WorkItemTrackingProcessor.md) | missng XML code comments | missng XML code comments | This processor is intended, with the aid of [ProcessorEnrichers](../ProcessorEnrichers/index.md), to allow the migration of Work Items between two [Endpoints](../Endpoints/index.md). |
We provide a number of Processors that can be used to migrate different sorts of data.

| Processors | Status | Target | Usage |
| --------------------------------------------------------------- | ------------------------- | ------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| [AzureDevOpsPipelineProcessor](AzureDevOpsPipelineProcessor.md) | Beta | Pipelines | Azure DevOps Processor that migrates Taskgroups, Build- and Release Pipelines. |
| [ProcessDefinitionProcessor](ProcessDefinitionProcessor.md) | Beta | Pipelines | Process definition processor used to keep processes between two orgs in sync |
| [TfsAreaAndIterationProcessor](TfsAreaAndIterationProcessor.md) | Beta | Work Items | The `TfsAreaAndIterationProcessor` migrates all of the Area nd Iteraion paths. |
| [TfsSharedQueryProcessor](TfsSharedQueryProcessor.md) | Beta | Queries | The TfsSharedQueryProcessor enabled you to migrate queries from one locatio nto another. |
| [TfsTeamSettingsProcessor](TfsTeamSettingsProcessor.md) | Beta | Teams | Native TFS Processor, does not work with any other Endpoints. |
| [WorkItemTrackingProcessor](WorkItemTrackingProcessor.md) | missing XML code comments | missing XML code comments | This processor is intended, with the aid of [ProcessorEnrichers](../ProcessorEnrichers/index.md), to allow the migration of Work Items between two [Endpoints](../Endpoints/index.md). |

### Processor Options

All processors have a minimum set of options that are required to run.
All processors have a minimum set of options that are required to run.

#### Minimum Options to run
The `Enabled` options is common to all processors.

The `Enabled` options is common to all processors.

```JSON
{
"ObjectType": "ProcessorOptions",
"Enabled": true,
}
```
```
Loading
Loading