generated from Kentico/repo-template
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #23 from Kentico/feature/docs
Feature/docs
- Loading branch information
Showing
14 changed files
with
1,668 additions
and
1,495 deletions.
There are no files selected for viewing
This file contains 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 |
|---|---|---|
| @@ -1 +1,2 @@ | ||
| * text eol=crlf | ||
| *.cs text eol=crlf | ||
| *.csproj text eol=crlf |
This file contains 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 |
|---|---|---|
| @@ -1,54 +1,52 @@ | ||
| # Xperience by Kentico: Sitefinity Migration Tool | ||
|
|
||
| [](https://github.com/Kentico/.github/blob/main/SUPPORT.md#labs-limited-support) [](https://github.com/Kentico/xperience-by-kentico-sitefinity-migration-tool/actions/workflows/ci.yml) | ||
|
|
||
| ## Description | ||
|
|
||
| This repository is part of the [Xperience by Kentico Migration Toolkit](https://github.com/Kentico/xperience-by-kentico-migration-toolkit). | ||
|
|
||
| The Sitefinity Migration Tool transfers content and other data from **Sitefinity** to **Xperience by Kentico**. | ||
|
|
||
| **Note:** This project currently falls under **Kentico Labs limited support** but will transition to **Full support by 7-day bug-fix policy** [when v1.0.0 is released](https://roadmap.kentico.com/c/218-sitefinity-migration-tool). | ||
|
|
||
| ## Screenshots | ||
|
|
||
| [](/images/xperience-by-kentico-migration-toolkit-sitefinity-migration-tool-embedded.jpg) | ||
|
|
||
| ## Library Version Matrix | ||
|
|
||
| | Xperience Version | Library Version | | ||
| | ----------------- | --------------- | | ||
| | >= 28.4.2 | 1.0.0 | | ||
|
|
||
| ### Dependencies | ||
|
|
||
| - [ASP.NET Core 8.0](https://dotnet.microsoft.com/en-us/download) | ||
| - [Xperience by Kentico](https://docs.kentico.com/changelog) | ||
|
|
||
| ## Quick Start | ||
|
|
||
| --- | ||
|
|
||
| ## Full Instructions | ||
|
|
||
| View the [Usage Guide](./docs/Usage-Guide.md) for more detailed instructions. | ||
|
|
||
| ## Contributing | ||
|
|
||
| To see the guidelines for Contributing to Kentico open source software, please see [Kentico's `CONTRIBUTING.md`](https://github.com/Kentico/.github/blob/main/CONTRIBUTING.md) for more information and follow the [Kentico's `CODE_OF_CONDUCT`](https://github.com/Kentico/.github/blob/main/CODE_OF_CONDUCT.md). | ||
|
|
||
| Instructions and technical details for contributing to **this** project can be found in [Contributing Setup](./docs/Contributing-Setup.md). | ||
|
|
||
| ## License | ||
|
|
||
| Distributed under the MIT License. See [`LICENSE.md`](./LICENSE.md) for more information. | ||
|
|
||
| ## Support | ||
|
|
||
| [](https://github.com/Kentico/.github/blob/main/SUPPORT.md#labs-limited-support) | ||
|
|
||
| This project has **Kentico Labs limited support**. | ||
|
|
||
| See [`SUPPORT.md`](https://github.com/Kentico/.github/blob/main/SUPPORT.md#labs-limited-support) for more information. | ||
|
|
||
| For any security issues see [`SECURITY.md`](https://github.com/Kentico/.github/blob/main/SECURITY.md). | ||
| # Xperience by Kentico: Sitefinity Migration Tool | ||
|
|
||
| [](https://github.com/Kentico/.github/blob/main/SUPPORT.md#labs-limited-support) [](https://github.com/Kentico/xperience-by-kentico-sitefinity-migration-tool/actions/workflows/ci.yml) | ||
|
|
||
| ## Description | ||
|
|
||
| This repository is part of the [Xperience by Kentico Migration Toolkit](https://github.com/Kentico/xperience-by-kentico-migration-toolkit). | ||
|
|
||
| The Sitefinity Migration Tool transfers content and other data from **Sitefinity** to **Xperience by Kentico**. | ||
|
|
||
| **Note:** This project currently falls under **Kentico Labs limited support** but will transition to **Full support by 7-day bug-fix policy** [when v1.0.0 is released](https://roadmap.kentico.com/c/218-sitefinity-migration-tool). | ||
|
|
||
| ## Screenshots | ||
|
|
||
| [](/images/xperience-by-kentico-migration-toolkit-sitefinity-migration-tool-embedded.jpg) | ||
|
|
||
| ## Library Version Matrix | ||
|
|
||
| | Xperience Version | Sitefinity Version | UMT Version | Library Version | | ||
| | ----------------- | ------------------ | ----------- | --------------- | | ||
| | >= 28.2.0 | 14.4.x | 1.2.0 | 1.0.0 | | ||
|
|
||
| ### Dependencies | ||
|
|
||
| - [ASP.NET Core 8.0](https://dotnet.microsoft.com/en-us/download) | ||
| - [Xperience by Kentico](https://docs.kentico.com/changelog) | ||
| - [Progress Sitefinity CMS 14.4](https://www.progress.com/documentation/sitefinity-cms/144/sitefinity-cms-documentation) | ||
| - [XbyK Universal Migration Tool](https://github.com/Kentico/xperience-by-kentico-universal-migration-tool) | ||
|
|
||
| ## Setup Instructions | ||
|
|
||
| View the [Usage Guide](./docs/Usage-Guide.md) for detailed instructions. | ||
|
|
||
| ## Contributing | ||
|
|
||
| To see the guidelines for Contributing to Kentico open source software, please see [Kentico's `CONTRIBUTING.md`](https://github.com/Kentico/.github/blob/main/CONTRIBUTING.md) for more information and follow the [Kentico's `CODE_OF_CONDUCT`](https://github.com/Kentico/.github/blob/main/CODE_OF_CONDUCT.md). | ||
|
|
||
| Instructions and technical details for contributing to **this** project can be found in [Contributing Setup](./docs/Contributing-Setup.md). | ||
|
|
||
| ## License | ||
|
|
||
| Distributed under the MIT License. See [`LICENSE.md`](./LICENSE.md) for more information. | ||
|
|
||
| ## Support | ||
|
|
||
| [](https://github.com/Kentico/.github/blob/main/SUPPORT.md#labs-limited-support) | ||
|
|
||
| This project has **Kentico Labs limited support**. | ||
|
|
||
| See [`SUPPORT.md`](https://github.com/Kentico/.github/blob/main/SUPPORT.md#labs-limited-support) for more information. | ||
|
|
||
| For any security issues see [`SECURITY.md`](https://github.com/Kentico/.github/blob/main/SECURITY.md). |
This file contains 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 |
|---|---|---|
| @@ -1,80 +1,80 @@ | ||
| # Contributing Setup | ||
|
|
||
| This documents the steps a maintainer or developer would follow to work on the library in their development environment | ||
|
|
||
| ## Required Software | ||
|
|
||
| The requirements to setup, develop, and build this project are listed below. | ||
|
|
||
| ### .NET Runtime | ||
|
|
||
| .NET SDK 8.0 or newer | ||
|
|
||
| - <https://dotnet.microsoft.com/en-us/download/dotnet/8.0> | ||
| - See `global.json` file for specific SDK requirements | ||
|
|
||
| ### Node.js Runtime | ||
|
|
||
| - [Node.js](https://nodejs.org/en/download) 20.10.0 or newer | ||
| - [NVM for Windows](https://github.com/coreybutler/nvm-windows) to manage multiple installed versions of Node.js | ||
| - See `engines` in the solution `package.json` for specific version requirements | ||
|
|
||
| ### C# Editor | ||
|
|
||
| - VS Code | ||
| - Visual Studio | ||
| - Rider | ||
|
|
||
| ### Database | ||
|
|
||
| SQL Server 2019 or newer compatible database | ||
|
|
||
| - [SQL Server Linux](https://learn.microsoft.com/en-us/sql/linux/sql-server-linux-setup?view=sql-server-ver15) | ||
| - [Azure SQL Edge](https://learn.microsoft.com/en-us/azure/azure-sql-edge/disconnected-deployment) | ||
|
|
||
| ### SQL Editor | ||
|
|
||
| - MS SQL Server Management Studio | ||
| - Azure Data Studio | ||
|
|
||
| ## Sample Project | ||
|
|
||
| ### Database Setup | ||
|
|
||
| Running the sample project requires creating a new Xperience by Kentico database using the included template. | ||
|
|
||
| Change directory in your console to `./examples/DancingGoat` and follow the instructions in the Xperience | ||
| documentation on [creating a new database](https://docs.xperience.io/xp26/developers-and-admins/installation#Installation-CreatetheprojectdatabaseCreateProjectDatabase). | ||
|
|
||
| ### Admin Customization | ||
|
|
||
| To run the Sample app Admin customization in development mode, add the following to your [User Secrets](https://learn.microsoft.com/en-us/aspnet/core/security/app-secrets?view=aspnetcore-7.0&tabs=windows#secret-manager) for the application. | ||
|
|
||
| ```json | ||
| "CMSAdminClientModuleSettings": { | ||
| "kentico-xperience-integrations-repotemplate": { | ||
| "Mode": "Proxy", | ||
| "Port": 3009 | ||
| } | ||
| } | ||
| ``` | ||
|
|
||
| ## Development Workflow | ||
|
|
||
| 1. Create a new branch with one of the following prefixes | ||
|
|
||
| - `feat/` - for new functionality | ||
| - `refactor/` - for restructuring of existing features | ||
| - `fix/` - for bugfixes | ||
|
|
||
| 1. Run `dotnet format` against the `src/Kentico.Xperience.RepoTemplate` project | ||
|
|
||
| > use `dotnet: format` VS Code task. | ||
| 1. Commit changes, with a commit message preferably following the [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/#summary) convention. | ||
|
|
||
| 1. Once ready, create a PR on GitHub. The PR will need to have all comments resolved and all tests passing before it will be merged. | ||
|
|
||
| - The PR should have a helpful description of the scope of changes being contributed. | ||
| - Include screenshots or video to reflect UX or UI updates | ||
| - Indicate if new settings need to be applied when the changes are merged - locally or in other environments | ||
| # Contributing Setup | ||
|
|
||
| This documents the steps a maintainer or developer would follow to work on the library in their development environment | ||
|
|
||
| ## Required Software | ||
|
|
||
| The requirements to setup, develop, and build this project are listed below. | ||
|
|
||
| ### .NET Runtime | ||
|
|
||
| .NET SDK 8.0 or newer | ||
|
|
||
| - <https://dotnet.microsoft.com/en-us/download/dotnet/8.0> | ||
| - See `global.json` file for specific SDK requirements | ||
|
|
||
| ### Node.js Runtime | ||
|
|
||
| - [Node.js](https://nodejs.org/en/download) 20.10.0 or newer | ||
| - [NVM for Windows](https://github.com/coreybutler/nvm-windows) to manage multiple installed versions of Node.js | ||
| - See `engines` in the solution `package.json` for specific version requirements | ||
|
|
||
| ### C# Editor | ||
|
|
||
| - VS Code | ||
| - Visual Studio | ||
| - Rider | ||
|
|
||
| ### Database | ||
|
|
||
| SQL Server 2019 or newer compatible database | ||
|
|
||
| - [SQL Server Linux](https://learn.microsoft.com/en-us/sql/linux/sql-server-linux-setup?view=sql-server-ver15) | ||
| - [Azure SQL Edge](https://learn.microsoft.com/en-us/azure/azure-sql-edge/disconnected-deployment) | ||
|
|
||
| ### SQL Editor | ||
|
|
||
| - MS SQL Server Management Studio | ||
| - Azure Data Studio | ||
|
|
||
| ## Sample Project | ||
|
|
||
| ### Database Setup | ||
|
|
||
| Running the sample project requires creating a new Xperience by Kentico database using the included template. | ||
|
|
||
| Change directory in your console to `./examples/DancingGoat` and follow the instructions in the Xperience | ||
| documentation on [creating a new database](https://docs.xperience.io/xp26/developers-and-admins/installation#Installation-CreatetheprojectdatabaseCreateProjectDatabase). | ||
|
|
||
| ### Admin Customization | ||
|
|
||
| To run the Sample app Admin customization in development mode, add the following to your [User Secrets](https://learn.microsoft.com/en-us/aspnet/core/security/app-secrets?view=aspnetcore-7.0&tabs=windows#secret-manager) for the application. | ||
|
|
||
| ```json | ||
| "CMSAdminClientModuleSettings": { | ||
| "kentico-xperience-integrations-repotemplate": { | ||
| "Mode": "Proxy", | ||
| "Port": 3009 | ||
| } | ||
| } | ||
| ``` | ||
|
|
||
| ## Development Workflow | ||
|
|
||
| 1. Create a new branch with one of the following prefixes | ||
|
|
||
| - `feat/` - for new functionality | ||
| - `refactor/` - for restructuring of existing features | ||
| - `fix/` - for bugfixes | ||
|
|
||
| 1. Run `dotnet format` against the `src/Kentico.Xperience.RepoTemplate` project | ||
|
|
||
| > use `dotnet: format` VS Code task. | ||
| 1. Commit changes, with a commit message preferably following the [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/#summary) convention. | ||
|
|
||
| 1. Once ready, create a PR on GitHub. The PR will need to have all comments resolved and all tests passing before it will be merged. | ||
|
|
||
| - The PR should have a helpful description of the scope of changes being contributed. | ||
| - Include screenshots or video to reflect UX or UI updates | ||
| - Indicate if new settings need to be applied when the changes are merged - locally or in other environments |
Oops, something went wrong.