generated from Kentico/repo-template
-
Notifications
You must be signed in to change notification settings - Fork 13
Docs/revamp #565
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
Merged
Merged
Docs/revamp #565
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 5538403
main README - first draft
dominikag2 7b7c83b
Migration flow diagram in png
dominikag2 090afcd
Migraton tool architecture and projects structure
dominikag2 12385c9
Migraton tool architecture and projects structure
dominikag2 0838509
projects structure diagram - bigger font
dominikag2 ca4a174
Repo structure adjustments
dominikag2 291014e
Add a README to every project
dominikag2 3d00a9e
Remove special GUIDES page
dominikag2 536f5ab
Customization readme and removing Migration protocol references (depr…
dominikag2 c841f4e
small adjustments to the main readme
dominikag2 efd6d48
bigger font in migration flow
dominikag2 83b451a
bigger font in migration flow
dominikag2 fd40ab6
migration-flow diagram - remove title
dominikag2 0d33bd6
Implement review suggestions - links and diagrams
dominikag2 e95870b
Implement review suggestions - the main README
dominikag2 06848e2
Implement review suggestions - other READMEs, part 1
dominikag2 1ee84c3
Implement review suggestions - Extensions README
dominikag2 40b96bb
Implement review suggestions, remove the mention of Migration Protoco…
dominikag2 65d0a08
Titles and information consistency, typos
dominikag2 8c722a6
Supported data - turn lists of data types (the first level) into head…
dominikag2 2ea30ed
Implement review suggestions:
dominikag2 5b93a70
Implement review suggestions - main readme
dominikag2 a107c47
Implement review suggestions - other readme files, admonitions ([!TIP…
dominikag2 d8f8aff
warnings back - some that shouldn't have got replaced
dominikag2 b3dbe64
Merge branch 'develop' into docs/revamp
dominikag2 3c3e91f
Couple more review suggestions implemented.
dominikag2 File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| 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. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| 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. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| 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 | ||
dominikag2 marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
| 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. | ||
This file was deleted.
Oops, something went wrong.
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.