Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
27 commits
Select commit Hold shift + click to select a range
9003f5e
WIP - to be combed through
dominikag2 Dec 17, 2025
5538403
main README - first draft
dominikag2 Dec 18, 2025
7b7c83b
Migration flow diagram in png
dominikag2 Dec 18, 2025
090afcd
Migraton tool architecture and projects structure
dominikag2 Dec 18, 2025
12385c9
Migraton tool architecture and projects structure
dominikag2 Dec 18, 2025
0838509
projects structure diagram - bigger font
dominikag2 Dec 18, 2025
ca4a174
Repo structure adjustments
dominikag2 Dec 18, 2025
291014e
Add a README to every project
dominikag2 Dec 18, 2025
3d00a9e
Remove special GUIDES page
dominikag2 Dec 18, 2025
536f5ab
Customization readme and removing Migration protocol references (depr…
dominikag2 Dec 19, 2025
c841f4e
small adjustments to the main readme
dominikag2 Dec 19, 2025
efd6d48
bigger font in migration flow
dominikag2 Dec 19, 2025
83b451a
bigger font in migration flow
dominikag2 Dec 19, 2025
fd40ab6
migration-flow diagram - remove title
dominikag2 Dec 19, 2025
0d33bd6
Implement review suggestions - links and diagrams
dominikag2 Dec 29, 2025
e95870b
Implement review suggestions - the main README
dominikag2 Dec 31, 2025
06848e2
Implement review suggestions - other READMEs, part 1
dominikag2 Jan 3, 2026
1ee84c3
Implement review suggestions - Extensions README
dominikag2 Jan 5, 2026
40b96bb
Implement review suggestions, remove the mention of Migration Protoco…
dominikag2 Jan 5, 2026
65d0a08
Titles and information consistency, typos
dominikag2 Jan 5, 2026
8c722a6
Supported data - turn lists of data types (the first level) into head…
dominikag2 Jan 12, 2026
2ea30ed
Implement review suggestions:
dominikag2 Jan 12, 2026
5b93a70
Implement review suggestions - main readme
dominikag2 Jan 14, 2026
a107c47
Implement review suggestions - other readme files, admonitions ([!TIP…
dominikag2 Jan 14, 2026
d8f8aff
warnings back - some that shouldn't have got replaced
dominikag2 Jan 14, 2026
b3dbe64
Merge branch 'develop' into docs/revamp
dominikag2 Jan 14, 2026
3c3e91f
Couple more review suggestions implemented.
dominikag2 Jan 14, 2026
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_report.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ What went wrong?

## Output logs

Please include the command line output log file and migration protocol generated for your `Migration.Tool.CLI.exe migrate` command.
Please include the command line output log file generated for your `Migration.Tool.CLI.exe migrate` command.

### Repro steps

Expand Down
31 changes: 31 additions & 0 deletions KVA/Migration.Tool.Source/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
# Migration.Tool.Source (KVA/)

> **Advanced Customization:** This is an internal abstraction layer. Most users do not need to modify this project. Only modify this if you are contributing to the migration tool itself or need to customize advanced features like [automatic image optimization during migration](https://docs.kentico.com/x/optimize_images_during_upgrade_guides).

## Purpose

Provides version-agnostic abstractions and shared interfaces used by all version-specific Core projects (K11/KX12/KX13). This acts as a bridge between the core infrastructure (Common) and version-specific implementations.

Located in the `KVA/` solution folder to indicate it's part of the Kentico Version Abstraction layer.

## Key Components

- **Source Entity Abstractions** - Interfaces defining common properties across K11/KX12/KX13 entities
- **Repository Patterns** - Shared patterns for querying source databases
- **Source API Contracts** - Common interfaces for source instance API calls (e.g., widget metadata discovery)
- **Mapping Helpers** - Utility functions used across all version-specific implementations
- **Source Configuration** - Source instance connection and configuration models

## Architecture Role

```
Migration.Tool.Common
Migration.Tool.Source ← Abstraction layer (this project)
Core.K11 / Core.KX12 / Core.KX13 ← Version-specific implementations
K11 / KX12 / KX13 ← Source database models
```

This allows Core projects to share common logic while implementing version-specific behavior where source CMS versions differ.
26 changes: 26 additions & 0 deletions KX13.Extensions/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
# KX13.Extensions

> **Minimal User Interaction:** This project provides API controllers that you deploy to your KX13 source instance for widget metadata discovery. Most users only need to copy the controller file to their source instance - no modification required.

## Purpose

Required when migrating **Page Builder widgets** from KX13. Provides ASP.NET Core API controllers that expose widget metadata (available properties, data types, default values) from your source instance. The migration tool calls these APIs to retrieve Page Builder widget configurations that are not stored in the database.

## Setup

For complete setup instructions, see [Source instance API discovery](../Migration.Tool.CLI/README.md#api-discovery-setup) in the Migration.Tool.CLI README.

**Quick summary:**
1. Copy `ToolApiController.cs` to your KX13 source instance's `Controllers` folder
2. Register the controller route in `Startup.cs` or `Program.cs`
3. Set a secret value in the controller
4. Configure the migration tool's `appsettings.json` with the matching secret

## Technical Details

- ASP.NET Core 3.1+ compatible (use `ToolApiController.NET48.cs` for .NET Framework 4.8 projects)
- Reads widget registrations from the Kentico API
- Returns JSON metadata consumed by the migration tool
- Requires matching secret between controller and migration tool configuration

Most users will not need to modify this code. Contributors may extend it to expose additional widget metadata or handle custom widget registration patterns.
26 changes: 26 additions & 0 deletions KX13.NET48.Extensions/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
# KX13.NET48.Extensions

> **Minimal User Interaction:** This project provides API controllers for .NET Framework 4.8 KX13 instances. Most users only need to copy the controller file to their source instance - no modification required.

## Purpose

Required when migrating **Page Builder widgets** from KX13 instances running on **.NET Framework 4.8** (not ASP.NET Core). Provides ASP.NET MVC API controllers that expose widget metadata (available properties, data types, default values) from your source instance. If your KX13 instance runs on ASP.NET Core, use the `KX13.Extensions` project instead.

## Setup

For complete setup instructions, see [Source instance API discovery](../Migration.Tool.CLI/README.md#api-discovery-setup) in the Migration.Tool.CLI README.

**Quick summary:**
1. Copy `ToolApiController.NET48.cs` to your KX13 source instance's `Controllers` folder
2. Register the controller route in `/App_Start/RouteConfig.cs`
3. Set a secret value in the controller
4. Configure the migration tool's `appsettings.json` with the matching secret

## Technical Details

- ASP.NET MVC (not Core) - for .NET Framework 4.8
- Uses `System.Web.Http` instead of `Microsoft.AspNetCore.Mvc`
- Returns JSON metadata consumed by the migration tool
- Requires matching secret between controller and migration tool configuration

Most users will not need to modify this code. Use this project only if your KX13 source instance runs on .NET Framework 4.8 instead of ASP.NET Core.
37 changes: 0 additions & 37 deletions Migration.Tool.CLI/MIGRATION_PROTOCOL_REFERENCE.md

This file was deleted.

Loading
Loading