Skip to content

Commit

Permalink
Update docs!
Browse files Browse the repository at this point in the history
  • Loading branch information
MrHinsh committed Aug 19, 2024
1 parent 2c1a6e6 commit 93c75a3
Show file tree
Hide file tree
Showing 101 changed files with 3,786 additions and 801 deletions.
12 changes: 6 additions & 6 deletions docs/Reference/Generated/MigrationTools.xml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

54 changes: 54 additions & 0 deletions docs/_data/reference.fieldmaps.fieldclearmapoptions.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,54 @@
optionsClassName: FieldClearMapOptions
optionsClassFullName: MigrationTools.Tools.FieldClearMapOptions
configurationSamples:
- name: defaults
description:
code: >-
{
"MigrationTools": {
"CommonTools": {
"FieldMappingTool": {
"FieldDefaults": {
"FieldClearMap": {}
}
}
}
}
}
sampleFor: MigrationTools.Tools.FieldClearMapOptions
- name: Classic
description:
code: >-
{
"$type": "FieldClearMapOptions",
"WorkItemTypeName": null,
"targetField": null,
"Enabled": false,
"ApplyTo": null
}
sampleFor: MigrationTools.Tools.FieldClearMapOptions
description: Allows you to set an already populated field to Null. This will only work with fields that support null.
className: FieldClearMapOptions
typeName: FieldMaps
architecture: v1
options:
- parameterName: ApplyTo
type: List
description: missng XML code comments
defaultValue: missng XML code comments
- parameterName: Enabled
type: Boolean
description: If set to `true` then the Fieldmap will run. Set to `false` and the processor will not run.
defaultValue: missng XML code comments
- parameterName: targetField
type: String
description: missng XML code comments
defaultValue: missng XML code comments
- parameterName: WorkItemTypeName
type: String
description: missng XML code comments
defaultValue: missng XML code comments
status: ready
processingTarget: Work Item
classFile: /src/MigrationTools/Tools/FieldMappingTool/FieldMaps/FieldClearMapOptions.cs
optionsClassFile: /src/MigrationTools/Tools/FieldMappingTool/FieldMaps/FieldClearMapOptions.cs
59 changes: 59 additions & 0 deletions docs/_data/reference.fieldmaps.fieldliteralmapoptions.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,59 @@
optionsClassName: FieldLiteralMapOptions
optionsClassFullName: MigrationTools.Tools.FieldLiteralMapOptions
configurationSamples:
- name: defaults
description:
code: >-
{
"MigrationTools": {
"CommonTools": {
"FieldMappingTool": {
"FieldDefaults": {
"FieldLiteralMap": {}
}
}
}
}
}
sampleFor: MigrationTools.Tools.FieldLiteralMapOptions
- name: Classic
description:
code: >-
{
"$type": "FieldLiteralMapOptions",
"WorkItemTypeName": null,
"targetField": null,
"value": null,
"Enabled": false,
"ApplyTo": null
}
sampleFor: MigrationTools.Tools.FieldLiteralMapOptions
description: Sets a field on the `target` to b a specific value.
className: FieldLiteralMapOptions
typeName: FieldMaps
architecture: v1
options:
- parameterName: ApplyTo
type: List
description: missng XML code comments
defaultValue: missng XML code comments
- parameterName: Enabled
type: Boolean
description: If set to `true` then the Fieldmap will run. Set to `false` and the processor will not run.
defaultValue: missng XML code comments
- parameterName: targetField
type: String
description: missng XML code comments
defaultValue: missng XML code comments
- parameterName: value
type: String
description: missng XML code comments
defaultValue: missng XML code comments
- parameterName: WorkItemTypeName
type: String
description: missng XML code comments
defaultValue: missng XML code comments
status: ready
processingTarget: Work Item Field
classFile: /src/MigrationTools/Tools/FieldMappingTool/FieldMaps/FieldLiteralMapOptions.cs
optionsClassFile: /src/MigrationTools/Tools/FieldMappingTool/FieldMaps/FieldLiteralMapOptions.cs
64 changes: 64 additions & 0 deletions docs/_data/reference.fieldmaps.fieldmergemapoptions.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,64 @@
optionsClassName: FieldMergeMapOptions
optionsClassFullName: MigrationTools.Tools.FieldMergeMapOptions
configurationSamples:
- name: defaults
description:
code: >-
{
"MigrationTools": {
"CommonTools": {
"FieldMappingTool": {
"FieldDefaults": {
"FieldMergeMap": {}
}
}
}
}
}
sampleFor: MigrationTools.Tools.FieldMergeMapOptions
- name: Classic
description:
code: >-
{
"$type": "FieldMergeMapOptions",
"WorkItemTypeName": null,
"sourceFields": null,
"targetField": null,
"formatExpression": null,
"Enabled": false,
"ApplyTo": null
}
sampleFor: MigrationTools.Tools.FieldMergeMapOptions
description: Ever wanted to merge two or three fields? This mapping will let you do just that.
className: FieldMergeMapOptions
typeName: FieldMaps
architecture: v1
options:
- parameterName: ApplyTo
type: List
description: missng XML code comments
defaultValue: missng XML code comments
- parameterName: Enabled
type: Boolean
description: If set to `true` then the Fieldmap will run. Set to `false` and the processor will not run.
defaultValue: missng XML code comments
- parameterName: formatExpression
type: String
description: missng XML code comments
defaultValue: missng XML code comments
- parameterName: sourceFields
type: List
description: missng XML code comments
defaultValue: missng XML code comments
- parameterName: targetField
type: String
description: missng XML code comments
defaultValue: missng XML code comments
- parameterName: WorkItemTypeName
type: String
description: missng XML code comments
defaultValue: missng XML code comments
status: ready
processingTarget: Work Item Field
classFile: /src/MigrationTools/Tools/FieldMappingTool/FieldMaps/FieldMergeMapOptions.cs
optionsClassFile: /src/MigrationTools/Tools/FieldMappingTool/FieldMaps/FieldMergeMapOptions.cs
54 changes: 54 additions & 0 deletions docs/_data/reference.fieldmaps.fieldskipmapoptions.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,54 @@
optionsClassName: FieldSkipMapOptions
optionsClassFullName: MigrationTools.Tools.FieldSkipMapOptions
configurationSamples:
- name: defaults
description:
code: >-
{
"MigrationTools": {
"CommonTools": {
"FieldMappingTool": {
"FieldDefaults": {
"FieldSkipMap": {}
}
}
}
}
}
sampleFor: MigrationTools.Tools.FieldSkipMapOptions
- name: Classic
description:
code: >-
{
"$type": "FieldSkipMapOptions",
"WorkItemTypeName": null,
"targetField": null,
"Enabled": false,
"ApplyTo": null
}
sampleFor: MigrationTools.Tools.FieldSkipMapOptions
description: Allows you to skip populating an existing field. Value in target with be reset to its OriginalValue.
className: FieldSkipMapOptions
typeName: FieldMaps
architecture: v1
options:
- parameterName: ApplyTo
type: List
description: missng XML code comments
defaultValue: missng XML code comments
- parameterName: Enabled
type: Boolean
description: If set to `true` then the Fieldmap will run. Set to `false` and the processor will not run.
defaultValue: missng XML code comments
- parameterName: targetField
type: String
description: missng XML code comments
defaultValue: missng XML code comments
- parameterName: WorkItemTypeName
type: String
description: missng XML code comments
defaultValue: missng XML code comments
status: ready
processingTarget: Work Item
classFile: /src/MigrationTools/Tools/FieldMappingTool/FieldMaps/FieldSkipMapOptions.cs
optionsClassFile: /src/MigrationTools/Tools/FieldMappingTool/FieldMaps/FieldSkipMapOptions.cs
64 changes: 64 additions & 0 deletions docs/_data/reference.fieldmaps.fieldtofieldmapoptions.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,64 @@
optionsClassName: FieldtoFieldMapOptions
optionsClassFullName: MigrationTools.Tools.FieldtoFieldMapOptions
configurationSamples:
- name: defaults
description:
code: >-
{
"MigrationTools": {
"CommonTools": {
"FieldMappingTool": {
"FieldDefaults": {
"FieldtoFieldMap": {}
}
}
}
}
}
sampleFor: MigrationTools.Tools.FieldtoFieldMapOptions
- name: Classic
description:
code: >-
{
"$type": "FieldtoFieldMapOptions",
"WorkItemTypeName": null,
"sourceField": null,
"targetField": null,
"defaultValue": null,
"Enabled": false,
"ApplyTo": null
}
sampleFor: MigrationTools.Tools.FieldtoFieldMapOptions
description: Just want to map one field to another? This is the one for you.
className: FieldtoFieldMapOptions
typeName: FieldMaps
architecture: v1
options:
- parameterName: ApplyTo
type: List
description: missng XML code comments
defaultValue: missng XML code comments
- parameterName: defaultValue
type: String
description: missng XML code comments
defaultValue: missng XML code comments
- parameterName: Enabled
type: Boolean
description: If set to `true` then the Fieldmap will run. Set to `false` and the processor will not run.
defaultValue: missng XML code comments
- parameterName: sourceField
type: String
description: missng XML code comments
defaultValue: missng XML code comments
- parameterName: targetField
type: String
description: missng XML code comments
defaultValue: missng XML code comments
- parameterName: WorkItemTypeName
type: String
description: missng XML code comments
defaultValue: missng XML code comments
status: ready
processingTarget: Work Item Field
classFile: /src/MigrationTools/Tools/FieldMappingTool/FieldMaps/FieldtoFieldMapOptions.cs
optionsClassFile: /src/MigrationTools/Tools/FieldMappingTool/FieldMaps/FieldtoFieldMapOptions.cs
54 changes: 54 additions & 0 deletions docs/_data/reference.fieldmaps.fieldtofieldmultimapoptions.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,54 @@
optionsClassName: FieldtoFieldMultiMapOptions
optionsClassFullName: MigrationTools.Tools.FieldtoFieldMultiMapOptions
configurationSamples:
- name: defaults
description:
code: >-
{
"MigrationTools": {
"CommonTools": {
"FieldMappingTool": {
"FieldDefaults": {
"FieldtoFieldMultiMap": {}
}
}
}
}
}
sampleFor: MigrationTools.Tools.FieldtoFieldMultiMapOptions
- name: Classic
description:
code: >-
{
"$type": "FieldtoFieldMultiMapOptions",
"WorkItemTypeName": null,
"SourceToTargetMappings": null,
"Enabled": false,
"ApplyTo": null
}
sampleFor: MigrationTools.Tools.FieldtoFieldMultiMapOptions
description: Want to setup a bunch of field maps in a single go. Use this shortcut!
className: FieldtoFieldMultiMapOptions
typeName: FieldMaps
architecture: v1
options:
- parameterName: ApplyTo
type: List
description: missng XML code comments
defaultValue: missng XML code comments
- parameterName: Enabled
type: Boolean
description: If set to `true` then the Fieldmap will run. Set to `false` and the processor will not run.
defaultValue: missng XML code comments
- parameterName: SourceToTargetMappings
type: Dictionary
description: missng XML code comments
defaultValue: missng XML code comments
- parameterName: WorkItemTypeName
type: String
description: missng XML code comments
defaultValue: missng XML code comments
status: ready
processingTarget: Work Item Field
classFile: /src/MigrationTools/Tools/FieldMappingTool/FieldMaps/FieldtoFieldMultiMapOptions.cs
optionsClassFile: /src/MigrationTools/Tools/FieldMappingTool/FieldMaps/FieldtoFieldMultiMapOptions.cs
Loading

0 comments on commit 93c75a3

Please sign in to comment.