From cfb94dc1e56dd0c000ead5209d2e9ba1409a0db3 Mon Sep 17 00:00:00 2001 From: "Alina-Magdalena Tincas (Umbraco HQ)" Date: Fri, 5 Jan 2024 14:10:02 +0100 Subject: [PATCH] restructure umbraco packages navigation docs --- 10/umbraco-commerce/.gitbook.yaml | 11 +- 10/umbraco-commerce/SUMMARY.md | 22 +- .../getting-started/upgrading/README.md | 37 --- 10/umbraco-commerce/how-to-guides/overview.md | 3 +- .../README.md => installation/install.md} | 4 +- .../licensing-model.md | 228 ++++++++-------- 10/umbraco-commerce/release-notes.md | 9 +- .../README.md | 0 .../migrate-custom-payment-providers.md | 0 .../migrate-umbraco-commerce-checkout.md | 0 .../umbraco-commerce/upgrading/upgrade.md | 2 +- .../upgrading/version-specific-upgrades.md | 4 +- 10/umbraco-deploy/.gitbook.yaml | 18 +- 10/umbraco-deploy/README.md | 14 +- 10/umbraco-deploy/SUMMARY.md | 29 ++- .../deployment-workflow/content-transfer.md | 6 +- .../deployment-workflow/deploy-dashboard.md | 2 +- .../deploying-deletions.md | 2 +- .../{ => getting-started}/deploy-settings.md | 0 .../{ => getting-started}/extending.md | 0 .../get-started-with-deploy.md | 10 +- .../handling-cache-refresher-notifications.md | 0 .../{ => getting-started}/troubleshooting.md | 0 .../install-configure.md | 2 +- .../{ => installation}/the-licensing-model.md | 0 10/umbraco-deploy/release-notes.md | 13 +- 10/umbraco-forms/.gitbook.yaml | 6 +- 10/umbraco-forms/README.md | 4 +- 10/umbraco-forms/SUMMARY.md | 9 +- .../developer/extending/adding-a-fieldtype.md | 2 +- .../{ => installation}/the-licensing-model.md | 0 10/umbraco-forms/release-notes.md | 7 +- .../manualupgrade.md | 2 +- .../version-specific.md | 0 10/umbraco-ui-builder/.gitbook.yaml | 9 +- 10/umbraco-ui-builder/SUMMARY.md | 16 +- .../installation.md | 0 .../licensing-model.md | 0 10/umbraco-ui-builder/release-notes.md | 7 +- ...ng-from-konstrukt-to-umbraco-ui-builder.md | 0 .../umbraco-ui-builder/upgrading/upgrade.md | 0 .../version-specific.md} | 4 +- 10/umbraco-workflow/.gitbook.yaml | 13 +- 10/umbraco-workflow/README.md | 2 +- 10/umbraco-workflow/SUMMARY.md | 17 +- .../getting-started/dashboards-and-buttons.md | 8 +- .../{ => installation}/installing-workflow.md | 0 .../{ => installation}/licensing.md | 0 10/umbraco-workflow/release-notes.md | 7 +- .../migrating-workflow.md | 4 +- .../upgrading.md | 0 12/umbraco-commerce/.gitbook.yaml | 11 +- 12/umbraco-commerce/SUMMARY.md | 22 +- 12/umbraco-commerce/how-to-guides/overview.md | 2 +- .../README.md => installation/install.md} | 4 +- .../licensing-model.md | 230 ++++++++--------- 12/umbraco-commerce/release-notes.md | 9 +- .../README.md | 0 .../migrate-custom-payment-providers.md | 0 .../migrate-umbraco-commerce-checkout.md | 0 .../upgrading.md => upgrading/upgrade.md} | 2 +- .../upgrading/version-specific-upgrades.md | 7 +- 12/umbraco-deploy/.gitbook.yaml | 20 +- 12/umbraco-deploy/README.md | 14 +- 12/umbraco-deploy/SUMMARY.md | 29 ++- .../deployment-workflow/content-transfer.md | 4 +- .../deployment-workflow/deploy-dashboard.md | 2 +- .../deploying-deletions.md | 2 +- .../{ => getting-started}/deploy-settings.md | 0 .../{ => getting-started}/extending.md | 0 .../get-started-with-deploy.md | 10 +- .../handling-cache-refresher-notifications.md | 0 .../{ => getting-started}/troubleshooting.md | 2 +- .../install-configure.md | 2 +- .../{ => installation}/the-licensing-model.md | 0 12/umbraco-deploy/release-notes.md | 9 +- .../upgrades/version-specific.md | 3 +- 12/umbraco-forms/.gitbook.yaml | 6 +- 12/umbraco-forms/README.md | 4 +- 12/umbraco-forms/SUMMARY.md | 9 +- .../developer/extending/adding-a-fieldtype.md | 2 +- .../{ => installation}/the-licensing-model.md | 0 12/umbraco-forms/release-notes.md | 9 +- .../manualupgrade.md | 2 +- .../version-specific.md | 0 12/umbraco-ui-builder/.gitbook.yaml | 9 +- 12/umbraco-ui-builder/SUMMARY.md | 16 +- .../installation.md | 0 .../licensing-model.md | 0 12/umbraco-ui-builder/release-notes.md | 9 +- ...ng-from-konstrukt-to-umbraco-ui-builder.md | 244 +++++++++--------- .../README.md => upgrading/upgrade.md} | 2 +- .../version-specific.md} | 6 +- 12/umbraco-workflow/.gitbook.yaml | 13 +- 12/umbraco-workflow/README.md | 2 +- 12/umbraco-workflow/SUMMARY.md | 19 +- .../getting-started/dashboards-and-buttons.md | 6 +- .../{ => installation}/installing-workflow.md | 0 .../{ => installation}/licensing.md | 0 12/umbraco-workflow/release-notes.md | 9 +- .../migrating-workflow.md | 4 +- .../upgrading.md | 0 .../version-specific.md} | 2 +- 13/umbraco-commerce/.gitbook.yaml | 2 +- 13/umbraco-commerce/SUMMARY.md | 4 +- .../{manualupgrade.md => upgrade.md} | 0 .../get-started-with-deploy.md | 2 +- 13/umbraco-forms/upgrading/manualupgrade.md | 2 +- 13/umbraco-ui-builder/.gitbook.yaml | 2 +- 13/umbraco-ui-builder/SUMMARY.md | 3 +- .../umbraco-ui-builder-vs-ui-o-matic.md | 2 - .../umbraco-ui-builder/upgrading/upgrade.md | 90 +++---- .../upgrading/version-specific.md | 2 +- .../getting-started/dashboards-and-buttons.md | 6 +- 114 files changed, 712 insertions(+), 693 deletions(-) delete mode 100644 10/umbraco-commerce/getting-started/upgrading/README.md rename 10/umbraco-commerce/{getting-started/installation/README.md => installation/install.md} (94%) rename 10/umbraco-commerce/{getting-started => installation}/licensing-model.md (98%) rename 10/umbraco-commerce/{how-to-guides => upgrading}/migrate-from-vendr-to-umbraco-commerce/README.md (100%) rename 10/umbraco-commerce/{how-to-guides => upgrading}/migrate-from-vendr-to-umbraco-commerce/migrate-custom-payment-providers.md (100%) rename 10/umbraco-commerce/{how-to-guides => upgrading}/migrate-from-vendr-to-umbraco-commerce/migrate-umbraco-commerce-checkout.md (100%) rename 12/umbraco-commerce/getting-started/upgrading/README.md => 10/umbraco-commerce/upgrading/upgrade.md (94%) rename 10/umbraco-commerce/{getting-started => }/upgrading/version-specific-upgrades.md (83%) rename 10/umbraco-deploy/{ => getting-started}/deploy-settings.md (100%) rename 10/umbraco-deploy/{ => getting-started}/extending.md (100%) rename 10/umbraco-deploy/{ => getting-started}/get-started-with-deploy.md (85%) rename 10/umbraco-deploy/{ => getting-started}/handling-cache-refresher-notifications.md (100%) rename 10/umbraco-deploy/{ => getting-started}/troubleshooting.md (100%) rename 10/umbraco-deploy/{getting-started => installation}/install-configure.md (98%) rename 10/umbraco-deploy/{ => installation}/the-licensing-model.md (100%) rename 10/umbraco-forms/{ => installation}/the-licensing-model.md (100%) rename 10/umbraco-forms/{installation => upgrading}/manualupgrade.md (95%) rename 10/umbraco-forms/{installation => upgrading}/version-specific.md (100%) rename 10/umbraco-ui-builder/{getting-started => installation}/installation.md (100%) rename 10/umbraco-ui-builder/{getting-started => installation}/licensing-model.md (100%) rename {12/umbraco-ui-builder/guides => 10/umbraco-ui-builder/upgrading}/migrating-from-konstrukt-to-umbraco-ui-builder.md (100%) rename 13/umbraco-ui-builder/upgrading/manualupgrade.md => 10/umbraco-ui-builder/upgrading/upgrade.md (100%) rename 10/umbraco-ui-builder/{getting-started/upgrading/version-specific-upgrades.md => upgrading/version-specific.md} (90%) rename 10/umbraco-workflow/{ => installation}/installing-workflow.md (100%) rename 10/umbraco-workflow/{ => installation}/licensing.md (100%) rename 10/umbraco-workflow/{upgrading-workflow => upgrading}/migrating-workflow.md (92%) rename 10/umbraco-workflow/{upgrading-workflow => upgrading}/upgrading.md (100%) rename 12/umbraco-commerce/{getting-started/installation/README.md => installation/install.md} (94%) rename 12/umbraco-commerce/{getting-started => installation}/licensing-model.md (98%) rename 12/umbraco-commerce/{how-to-guides => upgrading}/migrate-from-vendr-to-umbraco-commerce/README.md (100%) rename 12/umbraco-commerce/{how-to-guides => upgrading}/migrate-from-vendr-to-umbraco-commerce/migrate-custom-payment-providers.md (100%) rename 12/umbraco-commerce/{how-to-guides => upgrading}/migrate-from-vendr-to-umbraco-commerce/migrate-umbraco-commerce-checkout.md (100%) rename 12/umbraco-commerce/{getting-started/upgrading.md => upgrading/upgrade.md} (94%) rename 12/umbraco-commerce/{getting-started => }/upgrading/version-specific-upgrades.md (80%) rename 12/umbraco-deploy/{ => getting-started}/deploy-settings.md (100%) rename 12/umbraco-deploy/{ => getting-started}/extending.md (100%) rename 12/umbraco-deploy/{ => getting-started}/get-started-with-deploy.md (84%) rename 12/umbraco-deploy/{ => getting-started}/handling-cache-refresher-notifications.md (100%) rename 12/umbraco-deploy/{ => getting-started}/troubleshooting.md (99%) rename 12/umbraco-deploy/{getting-started => installation}/install-configure.md (99%) rename 12/umbraco-deploy/{ => installation}/the-licensing-model.md (100%) rename 12/umbraco-forms/{ => installation}/the-licensing-model.md (100%) rename 12/umbraco-forms/{installation => upgrading}/manualupgrade.md (93%) rename 12/umbraco-forms/{installation => upgrading}/version-specific.md (100%) rename 12/umbraco-ui-builder/{getting-started => installation}/installation.md (100%) rename 12/umbraco-ui-builder/{getting-started => installation}/licensing-model.md (100%) rename {10/umbraco-ui-builder/guides => 12/umbraco-ui-builder/upgrading}/migrating-from-konstrukt-to-umbraco-ui-builder.md (97%) rename 12/umbraco-ui-builder/{getting-started/upgrading/README.md => upgrading/upgrade.md} (94%) rename 12/umbraco-ui-builder/{getting-started/upgrading/version-specific-upgrades.md => upgrading/version-specific.md} (85%) rename 12/umbraco-workflow/{ => installation}/installing-workflow.md (100%) rename 12/umbraco-workflow/{ => installation}/licensing.md (100%) rename 12/umbraco-workflow/{upgrading-workflow => upgrading}/migrating-workflow.md (92%) rename 12/umbraco-workflow/{upgrading-workflow => upgrading}/upgrading.md (100%) rename 12/umbraco-workflow/{version-specific-upgrade-notes.md => upgrading/version-specific.md} (99%) rename 13/umbraco-commerce/upgrading/{manualupgrade.md => upgrade.md} (100%) delete mode 100644 13/umbraco-ui-builder/miscellaneous/umbraco-ui-builder-vs-ui-o-matic.md rename 10/umbraco-ui-builder/getting-started/upgrading/README.md => 13/umbraco-ui-builder/upgrading/upgrade.md (92%) diff --git a/10/umbraco-commerce/.gitbook.yaml b/10/umbraco-commerce/.gitbook.yaml index 90e32539d53..329d7593bf6 100644 --- a/10/umbraco-commerce/.gitbook.yaml +++ b/10/umbraco-commerce/.gitbook.yaml @@ -1,9 +1,14 @@ root: ./ -​structure: +​structure: readme: README.md summary: SUMMARY.md redirects: - -getting-started/installation/version-specific-upgrades: getting-started/upgrading/version-specific-upgrades.md +getting-started/installation/README: installation/install.md +getting-started/licensing-model: installation/licensing-model.md +getting-started/upgrading/README: upgrading/upgrade.md +getting-started/upgrading/version-specific-upgrades: upgrading/version-specific-upgrades.md +how-to-guides/migrate-from-vendr-to-umbraco-commerce/migrate-custom-payment-providers: upgrading/migrate-from-vendr-to-umbraco-commerce/migrate-custom-payment-providers.md +how-to-guides/migrate-from-vendr-to-umbraco-commerce/migrate-umbraco-commerce-checkout: upgrading/migrate-from-vendr-to-umbraco-commerce/migrate-umbraco-commerce-checkout.md +how-to-guides/migrate-from-vendr-to-umbraco-commerce/README: upgrading/migrate-from-vendr-to-umbraco-commerce/README.md diff --git a/10/umbraco-commerce/SUMMARY.md b/10/umbraco-commerce/SUMMARY.md index cf9b73c9555..4243443ebbf 100644 --- a/10/umbraco-commerce/SUMMARY.md +++ b/10/umbraco-commerce/SUMMARY.md @@ -1,26 +1,32 @@ # Table of contents -* [What is Umbraco Commerce?](README.md) +* [Umbraco Commerce Documentation](README.md) * [Commerce Packages](https://docs.umbraco.com/umbraco-commerce-packages) * [Commerce Payment Providers](https://docs.umbraco.com/umbraco-commerce-payment-providers) * [Release Notes](release-notes.md) +## Installation + +* [Installing Umbraco Commerce](installation/install.md) +* [Licensing](installation/licensing-model.md) + +## Upgrading + +* [Upgrading Umbraco Commerce](upgrading/upgrade.md) +* [Version Specific Upgrade Notes](upgrading/version-specific-upgrades.md) +* [Migrate from Vendr to Umbraco Commerce](upgrading/migrate-from-vendr-to-umbraco-commerce/README.md) + * [Migrate Umbraco Commerce Checkout](upgrading/migrate-from-vendr-to-umbraco-commerce/migrate-umbraco-commerce-checkout.md) + * [Migrate custom Payment Providers](upgrading/migrate-from-vendr-to-umbraco-commerce/migrate-custom-payment-providers.md) + ## Getting Started * [Introduction](getting-started/introduction.md) -* [Installation](getting-started/installation/README.md) -* [Upgrading](getting-started/upgrading/README.md) - * [Version Specific Upgrade Notes](getting-started/upgrading/version-specific-upgrades.md) * [Umbraco Configuration](getting-started/umbraco-configuration.md) * [User Interface](getting-started/user-interface.md) -* [Licensing](getting-started/licensing-model.md) ## How-To Guides * [Overview](how-to-guides/overview.md) -* [Migrate from Vendr to Umbraco Commerce](how-to-guides/migrate-from-vendr-to-umbraco-commerce/README.md) - * [Migrate Umbraco Commerce Checkout](how-to-guides/migrate-from-vendr-to-umbraco-commerce/migrate-umbraco-commerce-checkout.md) - * [Migrate custom Payment Providers](how-to-guides/migrate-from-vendr-to-umbraco-commerce/migrate-custom-payment-providers.md) * [Configure SQLite support](how-to-guides/configure-sqlite-support.md) * [Limit Order Line Quantity](how-to-guides/limit-orderline-quantity.md) * [Use an Alternative Database for Umbraco Commerce Tables](how-to-guides/use-an-alternative-database-for-umbraco-commerce-tables.md) diff --git a/10/umbraco-commerce/getting-started/upgrading/README.md b/10/umbraco-commerce/getting-started/upgrading/README.md deleted file mode 100644 index 1481bb91872..00000000000 --- a/10/umbraco-commerce/getting-started/upgrading/README.md +++ /dev/null @@ -1,37 +0,0 @@ -# Upgrading Umbraco Commerce - -This article shows how to manually upgrade Umbraco Commerce to run the latest version. -When upgrading Umbraco Commerce, be sure to also consult the [version specific upgrade](/10/umbraco-commerce/getting-started/upgrading/version-specific-upgrades.md) notes to learn about potential breaking changes and common pitfalls. - -{% hint style="warning" %} -Before upgrading, it is always advisable to take a complete backup of your site and database. -{% endhint %} - -## Get the latest version of Umbraco Commerce - -To upgrade to the latest version of Umbraco Commerce you can use: -- NuGet -- Visual Studio - -### NuGet - -- NuGet installs the latest version of the package when you use the `dotnet add package Umbraco.Commerce` command unless you specify a package version: `dotnet add package Umbraco.Commerce --version ` - -- After you have added a package reference to your project by executing the `dotnet add package Umbraco.Commerce` command in the directory that contains your project file, run `dotnet restore` to install the package. - - -### Visual Studio - -1. Go to `Tools` -> `NuGet Package Manager` -> `Manage NuGet Packages for Solution...` in Visual Studio, to upgrade Umbraco Commerce: -2. Select **Umbraco.Commerce**. -3. Select the latest version from the Version drop-down and click Install. -4. When the command completes, open the **.csproj** file to make sure the package reference is updated: -```xml - - - -``` - -If you are using one or more of the below sub-packages, they also need to be upgraded as well: - -
Sub-packageDescription
Umbraco.Commerce.CommonA shared project of common, non-Commerce-specific patterns and helpers.
Umbraco.Commerce.CoreCore Commerce functionality that doesn't require any infrastructure-specific dependencies.
Umbraco.Commerce.InfrastructureInfrastructure-specific project containing implementations of core Commerce functionality.
Umbraco.Commerce.Persistence.SqlServerPersistence-specific project containing implementations of core Commerce persistence functionality for SQL Server.
Umbraco.Commerce.Persistence.SqllitePersistence-specific project containing implementations of core Commerce persistence functionality for SQLite.
Umbraco.Commerce.WebCore Commerce functionality that requires a web context.
Umbraco.Commerce.CmsCore Commerce functionality that requires an Umbraco dependency.
Umbraco.Commerce.Cms.WebThe Commerce functionality for the Umbraco presentation layer.
Umbraco.Commerce.Cms.Web.UIThe static Commerce assets for the Umbraco presentation layer.
Umbraco.Commerce.Cms.StartupThe Commerce functionality for registering Commerce with Umbraco.
Umbraco.CommerceThe main Commerce package entry point package.
diff --git a/10/umbraco-commerce/how-to-guides/overview.md b/10/umbraco-commerce/how-to-guides/overview.md index 95c8df58a19..87db6f5ac16 100644 --- a/10/umbraco-commerce/how-to-guides/overview.md +++ b/10/umbraco-commerce/how-to-guides/overview.md @@ -8,5 +8,4 @@ In this section, we will provide a series of How-To Guides, showcasing how to pe ## Available guides -
Migrate from Vendr to Umbraco Commercemigrate-from-vendr-to-umbraco-commerce
Configure SQLite supportconfigure-sqlite-support.md
Limit Ordere Line Quantitylimit-orderline-quantity.md
Use an alternative database for Umbraco Commerce tablesuse-an-alternative-database-for-umbraco-commerce-tables.md
- +
Migrate from Vendr to Umbraco Commercemigrate-from-vendr-to-umbraco-commerce
Configure SQLite supportconfigure-sqlite-support.md
Limit Ordere Line Quantitylimit-orderline-quantity.md
Use an alternative database for Umbraco Commerce tablesuse-an-alternative-database-for-umbraco-commerce-tables.md
diff --git a/10/umbraco-commerce/getting-started/installation/README.md b/10/umbraco-commerce/installation/install.md similarity index 94% rename from 10/umbraco-commerce/getting-started/installation/README.md rename to 10/umbraco-commerce/installation/install.md index 8bf90273d12..bc8251955a7 100644 --- a/10/umbraco-commerce/getting-started/installation/README.md +++ b/10/umbraco-commerce/installation/install.md @@ -21,7 +21,7 @@ PM> dotnet add package Umbraco.Commerce Alternatively, you can also find and install the NuGet package via the NuGet Package Manager in Visual Studio. You will see a number of packages available, however, you will want to install the main **Umbraco Commerce** package. -![Installing Umbraco Commerce via the NuGet Package Manager](../../media/nuget-packages-overview.png) +![Installing Umbraco Commerce via the NuGet Package Manager](../media/nuget-packages-overview.png) For most sites using a single solution, the above will be all you need to install Umbraco Commerce into your project. When you have a more complex solution structure consisting of multiple projects, Umbraco Commerce is available in multiple sub-packages with varying dependencies. @@ -29,4 +29,4 @@ For most sites using a single solution, the above will be all you need to instal ## Installing a License -See the [Licensing page](../licensing-model.md#installing-your-license) for details on how to install a license. +See the [Licensing page](../installation/licensing-model.md#installing-your-license) for details on how to install a license. diff --git a/10/umbraco-commerce/getting-started/licensing-model.md b/10/umbraco-commerce/installation/licensing-model.md similarity index 98% rename from 10/umbraco-commerce/getting-started/licensing-model.md rename to 10/umbraco-commerce/installation/licensing-model.md index 101c1772ca1..142e5594ae1 100644 --- a/10/umbraco-commerce/getting-started/licensing-model.md +++ b/10/umbraco-commerce/installation/licensing-model.md @@ -1,114 +1,114 @@ -# Licensing - -Umbraco Commerce is a commercial product. You can run an Umbraco Commerce unrestricted locally without the need a license. Running Umbraco Commerce on a public domain will display a warning banner in the backoffice and will limit the maximum number of orders (20). To remove these restrictions, you'll need to have a **valid license**. - -## How does it work? - -Licenses are sold per backoffice domain and will also work on all subdomains. If you have alternative staging/qa environment domains, additional domains can be added to the license on request. - -{% hint style="info" %} -The licenses are not bound to a specific product version. They will work for all versions of the related product. -{% endhint %} - -Let's say that you have a license configured for your domain, `mysite.com`, and you've requested two development domains, `devdomain.com` and `devdomain2.com`. - -The license will cover the following domains: - -* `localhost` -* `*.local` -* `*.mysite.com` -* `www.mysite.com` -* `devdomain.com` -* `www.devdomain.com` -* `devdomain2.com` -* `www.devdomain2.com` - -{% hint style="info" %} -You can have only 1 license per Umbraco installation. -{% endhint %} - -## What does a license cover? - -There are a few differences as to what the licenses cover: - -* A single license covers the installation of Umbraco Commerce in 1 production backoffice domain, as well as in any requested development domains. -* The production domain includes **all subdomains** (e.g. `*.mysite.com`). -* The development domains work with or without the `www` subdomain. -* The license allows for an unlimited number of orders. -* The license also includes `localhost` and `*.local` as a valid domain. - -{% hint style="info" %} -If you have multiple backoffice domains pointing at the same installation, you have the option to purchase and [add **additional domains**](licensing-model.md#add-additional-domains) to your license. - -This is an add-on domain for existing licenses. Refunds will not be given for this product. -{% endhint %} - -## Configuring your license - -You can purchase a license via the [Umbraco Commerce](https://umbraco.com/products/umbraco-commerce/) project page. A member of the [SUITS team](mailto:suits@umbraco.com) will manage this process. In the process, you will need to provide all domains you wish to have covered by the license such as primary and staging/qa domains. You should then receive a license code to be installed in your solution. - -### Add additional domains - -If you require to add addition domains to the license, please reach out to a member of the [SUITS team](mailto:suits@umbraco.com) with your request and they will manage this process. - -## Installing your license - -Once you have received your license code it needs to be installed on your site. - -1. Open the root directory for your project files. -2. Locate and open the `appSettings.json` file. -3. Add your Umbraco Commerce license key to `Umbraco:Licenses:Umbraco.Commerce`: - -```json -"Umbraco": { - "Licenses": { - "Umbraco.Commerce": "YOUR_LICENSE_KEY" - } -} -``` - -### Verify the license installation - -You can verify that your license is successfully installed by logging into your project's backoffice and navigating to the settings section. Here you will see a licenses dashboard which should display the status of your license. - -![Umbraco Commerce License Dashboard](../media/license-dashboard.png) - -### When and how to configure an `UmbracoApplicationUrl` - -If you are running on a single domain for both your frontend and backend environments, it's not necessary to configure a `UmbracoApplicationUrl`. - -If you have different domains for your frontend and backend, then it's advised that you configure an `UmbracoApplicationUrl` set to your backoffice URL. This helps the licensing engine know which URL should be used for validation checks. Without this configuration setting, the licensing engine will try and work out the domain to validate from the HTTP request object. This can lead to errors when switching between domains. - - -An `UmbracoApplicationUrl` can be configured in your `appSettings.json` file like so: - -```json -{ - "Umbraco": { - "CMS": { - "WebRouting": { - "UmbracoApplicationUrl": "https://admin.my-custom-domain.com/" - } - } - } -} -``` - -See the [Fixed Application URL](https://docs.umbraco.com/umbraco-cms/extending/health-check/guides/fixedapplicationurl) documentation for more details about this setting. - -#### Configuring `UmbracoApplicationUrl` on Umbraco Cloud - -If you are hosting on Umbraco Cloud you will find the configuration described above won't be reflected in your environment. The reason for this is that Umbraco Cloud sets this value as an environment variable set to the Cloud project domain (`.umbraco.io`). This overrides what is set via the `appSettings.json` file. - -There are two options in this case: -- Either the domains for each of your Cloud environments can be added to your license. -- Or, for more control and to ensure this value is set correctly for other reasons, you can apply the configuration via code. - -For example, in your `Startup.cs` file, you can add the following to the `ConfigureServices` method: - -```csharp -services.Configure(o => o.UmbracoApplicationUrl = ""); -``` - -In practice, you will probably want to make this a bit more sophisticated. You can read the value from another configuration key, removing the need to hard-code it and have it set as appropriate in different environments. You can also move this code into a composer or an extension method if you prefer not to clutter up the `Startup.ConfigureServices` method. - +# Licensing + +Umbraco Commerce is a commercial product. You can run an Umbraco Commerce unrestricted locally without the need a license. Running Umbraco Commerce on a public domain will display a warning banner in the backoffice and will limit the maximum number of orders (20). To remove these restrictions, you'll need to have a **valid license**. + +## How does it work? + +Licenses are sold per backoffice domain and will also work on all subdomains. If you have alternative staging/qa environment domains, additional domains can be added to the license on request. + +{% hint style="info" %} +The licenses are not bound to a specific product version. They will work for all versions of the related product. +{% endhint %} + +Let's say that you have a license configured for your domain, `mysite.com`, and you've requested two development domains, `devdomain.com` and `devdomain2.com`. + +The license will cover the following domains: + +* `localhost` +* `*.local` +* `*.mysite.com` +* `www.mysite.com` +* `devdomain.com` +* `www.devdomain.com` +* `devdomain2.com` +* `www.devdomain2.com` + +{% hint style="info" %} +You can have only 1 license per Umbraco installation. +{% endhint %} + +## What does a license cover? + +There are a few differences as to what the licenses cover: + +* A single license covers the installation of Umbraco Commerce in 1 production backoffice domain, as well as in any requested development domains. +* The production domain includes **all subdomains** (e.g. `*.mysite.com`). +* The development domains work with or without the `www` subdomain. +* The license allows for an unlimited number of orders. +* The license also includes `localhost` and `*.local` as a valid domain. + +{% hint style="info" %} +If you have multiple backoffice domains pointing at the same installation, you have the option to purchase and [add **additional domains**](licensing-model.md#add-additional-domains) to your license. + +This is an add-on domain for existing licenses. Refunds will not be given for this product. +{% endhint %} + +## Configuring your license + +You can purchase a license via the [Umbraco Commerce](https://umbraco.com/products/umbraco-commerce/) project page. A member of the [SUITS team](mailto:suits@umbraco.com) will manage this process. In the process, you will need to provide all domains you wish to have covered by the license such as primary and staging/qa domains. You should then receive a license code to be installed in your solution. + +### Add additional domains + +If you require to add addition domains to the license, please reach out to a member of the [SUITS team](mailto:suits@umbraco.com) with your request and they will manage this process. + +## Installing your license + +Once you have received your license code it needs to be installed on your site. + +1. Open the root directory for your project files. +2. Locate and open the `appSettings.json` file. +3. Add your Umbraco Commerce license key to `Umbraco:Licenses:Umbraco.Commerce`: + +```json +"Umbraco": { + "Licenses": { + "Umbraco.Commerce": "YOUR_LICENSE_KEY" + } +} +``` + +### Verify the license installation + +You can verify that your license is successfully installed by logging into your project's backoffice and navigating to the settings section. Here you will see a licenses dashboard which should display the status of your license. + +![Umbraco Commerce License Dashboard](../media/license-dashboard.png) + +### When and how to configure an `UmbracoApplicationUrl` + +If you are running on a single domain for both your frontend and backend environments, it's not necessary to configure a `UmbracoApplicationUrl`. + +If you have different domains for your frontend and backend, then it's advised that you configure an `UmbracoApplicationUrl` set to your backoffice URL. This helps the licensing engine know which URL should be used for validation checks. Without this configuration setting, the licensing engine will try and work out the domain to validate from the HTTP request object. This can lead to errors when switching between domains. + + +An `UmbracoApplicationUrl` can be configured in your `appSettings.json` file like so: + +```json +{ + "Umbraco": { + "CMS": { + "WebRouting": { + "UmbracoApplicationUrl": "https://admin.my-custom-domain.com/" + } + } + } +} +``` + +See the [Fixed Application URL](https://docs.umbraco.com/umbraco-cms/extending/health-check/guides/fixedapplicationurl) documentation for more details about this setting. + +#### Configuring `UmbracoApplicationUrl` on Umbraco Cloud + +If you are hosting on Umbraco Cloud you will find the configuration described above won't be reflected in your environment. The reason for this is that Umbraco Cloud sets this value as an environment variable set to the Cloud project domain (`.umbraco.io`). This overrides what is set via the `appSettings.json` file. + +There are two options in this case: +- Either the domains for each of your Cloud environments can be added to your license. +- Or, for more control and to ensure this value is set correctly for other reasons, you can apply the configuration via code. + +For example, in your `Startup.cs` file, you can add the following to the `ConfigureServices` method: + +```csharp +services.Configure(o => o.UmbracoApplicationUrl = ""); +``` + +In practice, you will probably want to make this a bit more sophisticated. You can read the value from another configuration key, removing the need to hard-code it and have it set as appropriate in different environments. You can also move this code into a composer or an extension method if you prefer not to clutter up the `Startup.ConfigureServices` method. + diff --git a/10/umbraco-commerce/release-notes.md b/10/umbraco-commerce/release-notes.md index 23d48df0e23..d2f14bd4c98 100644 --- a/10/umbraco-commerce/release-notes.md +++ b/10/umbraco-commerce/release-notes.md @@ -1,17 +1,16 @@ --- description: >- - Get an overview of the things changed and fixed in each version of Umbraco - Commerce. + Get an overview of the things changed and fixed in each version of Umbraco Commerce. --- # Release Notes -In this section, we have summarized the changes to Umbraco Commerce released in each version. Each version is presented with a link to the[ Commerce issue tracker](https://github.com/umbraco/Umbraco.Commerce.Issues/issues) showing a list of issues resolved in the release. We also link to the individual issues themselves from the detail. +In this section, we have summarized the changes to Umbraco Commerce released in each version. Each version is presented with a link to the [Commerce issue tracker](https://github.com/umbraco/Umbraco.Commerce.Issues/issues) showing a list of issues resolved in the release. We also link to the individual issues themselves from the detail. If there are any breaking changes or other issues to be aware of when upgrading they are also noted here. {% hint style="info" %} -If you are upgrading to a new major version, check the breaking changes in the [Version Specific Upgrade Notes](getting-started/upgrading/version-specific-upgrades.md) article. +If you are upgrading to a new major version, check the breaking changes in the [Version Specific Upgrade Notes](./upgrading/version-specific-upgrades.md) article. {% endhint %} ## Release History @@ -50,4 +49,4 @@ This section contains the release notes for Umbraco Commerce 10 including all ch ## Legacy release notes -You can find the release notes for **Vendr** in the[ ](https://github.com/umbraco/UmbracoDocs/blob/umbraco-eol-versions/11/umbraco-workflow/release-notes.md)[Change log file on Github](../../13/umbraco-commerce/changelog-archive/Vendr-core.md). +You can find the release notes for **Vendr** in the [Change log file on Github](../../13/umbraco-commerce/changelog-archive/Vendr-core.md). diff --git a/10/umbraco-commerce/how-to-guides/migrate-from-vendr-to-umbraco-commerce/README.md b/10/umbraco-commerce/upgrading/migrate-from-vendr-to-umbraco-commerce/README.md similarity index 100% rename from 10/umbraco-commerce/how-to-guides/migrate-from-vendr-to-umbraco-commerce/README.md rename to 10/umbraco-commerce/upgrading/migrate-from-vendr-to-umbraco-commerce/README.md diff --git a/10/umbraco-commerce/how-to-guides/migrate-from-vendr-to-umbraco-commerce/migrate-custom-payment-providers.md b/10/umbraco-commerce/upgrading/migrate-from-vendr-to-umbraco-commerce/migrate-custom-payment-providers.md similarity index 100% rename from 10/umbraco-commerce/how-to-guides/migrate-from-vendr-to-umbraco-commerce/migrate-custom-payment-providers.md rename to 10/umbraco-commerce/upgrading/migrate-from-vendr-to-umbraco-commerce/migrate-custom-payment-providers.md diff --git a/10/umbraco-commerce/how-to-guides/migrate-from-vendr-to-umbraco-commerce/migrate-umbraco-commerce-checkout.md b/10/umbraco-commerce/upgrading/migrate-from-vendr-to-umbraco-commerce/migrate-umbraco-commerce-checkout.md similarity index 100% rename from 10/umbraco-commerce/how-to-guides/migrate-from-vendr-to-umbraco-commerce/migrate-umbraco-commerce-checkout.md rename to 10/umbraco-commerce/upgrading/migrate-from-vendr-to-umbraco-commerce/migrate-umbraco-commerce-checkout.md diff --git a/12/umbraco-commerce/getting-started/upgrading/README.md b/10/umbraco-commerce/upgrading/upgrade.md similarity index 94% rename from 12/umbraco-commerce/getting-started/upgrading/README.md rename to 10/umbraco-commerce/upgrading/upgrade.md index bee1b18cd56..024422ad5c1 100644 --- a/12/umbraco-commerce/getting-started/upgrading/README.md +++ b/10/umbraco-commerce/upgrading/upgrade.md @@ -1,7 +1,7 @@ # Upgrading Umbraco Commerce This article shows how to manually upgrade Umbraco Commerce to run the latest version. -When upgrading Umbraco Commerce, be sure to also consult the [version specific upgrade](10/umbraco-commerce/getting-started/upgrading/version-specific-upgrades.md) notes to learn about potential breaking changes and common pitfalls. +When upgrading Umbraco Commerce, be sure to also consult the [version specific upgrade](version-specific-upgrades.md) notes to learn about potential breaking changes and common pitfalls. {% hint style="warning" %} Before upgrading, it is always advisable to take a complete backup of your site and database. diff --git a/10/umbraco-commerce/getting-started/upgrading/version-specific-upgrades.md b/10/umbraco-commerce/upgrading/version-specific-upgrades.md similarity index 83% rename from 10/umbraco-commerce/getting-started/upgrading/version-specific-upgrades.md rename to 10/umbraco-commerce/upgrading/version-specific-upgrades.md index 1c3a2b15758..1dfd65822d0 100644 --- a/10/umbraco-commerce/getting-started/upgrading/version-specific-upgrades.md +++ b/10/umbraco-commerce/upgrading/version-specific-upgrades.md @@ -9,14 +9,14 @@ description: >- This page covers specific upgrade documentation for when migrating to major 10 of Umbraco Commerce. {% hint style="info" %} -If you are upgrading to a new minor or patch version, you can find information about the breaking changes in the [Release Notes](../../release-notes.md) article. +If you are upgrading to a new minor or patch version, you can find information about the breaking changes in the [Release Notes](../release-notes.md) article. {% endhint %} ## Version Specific Upgrade Notes History Version 10 is the initial Long-term support (LTS) release of the Umbraco Commerce product. It contains a number of breaking changes from the previous, Vendr product. -See the [Migrate from Vendr to Umbraco Commerce guide](../../how-to-guides/migrate-from-vendr-to-umbraco-commerce/) for full details. +See the [Migrate from Vendr to Umbraco Commerce guide](../upgrading/migrate-from-vendr-to-umbraco-commerce/README.md) for full details. ## Legacy version specific upgrade notes diff --git a/10/umbraco-deploy/.gitbook.yaml b/10/umbraco-deploy/.gitbook.yaml index 83e6e359911..6cf1ef0fed7 100644 --- a/10/umbraco-deploy/.gitbook.yaml +++ b/10/umbraco-deploy/.gitbook.yaml @@ -1,14 +1,14 @@ root: ./ -​structure: +​structure: readme: README.md summary: SUMMARY.md -installing-deploy/installing-deploy: getting-started/install-configure.md -installing-deploy/install-configure: getting-started-install-configure.md -installing-deploy/install-configure/existing-site: getting-started/install-configure.md -installing-deploy/install-configure/new-site: getting-started/install-configure.md -installing-deploy/cicd-pipeline: getting-started/cicd-pipeline/README.md -installing-deploy/cicd-pipeline/ci-cd-azure-dev-ops: getting-started/cicd-pipeline/ci-cd-azure-dev-ops.md -installing-deploy/cicd-pipeline/ci-cd-github-actions: getting-started/cicd-pipeline/ci-cd-github-actions.md -installing-deploy/streamlining-local-development: getting-started/streamlining-local-development \ No newline at end of file +redirects: +getting-started/install-configure: installation/install-configure.md +the-licensing-model: installation/the-licensing-model.md +deploy-settings: getting-started/deploy-settings.md +extending: getting-started/extending.md +get-started-with-deploy: getting-started/get-started-with-deploy.md +handling-cache-refresher-notifications: getting-started/handling-cache-refresher-notifications.md +troubleshooting: getting-started/troubleshooting.md diff --git a/10/umbraco-deploy/README.md b/10/umbraco-deploy/README.md index b942c165e2a..bbbb74b2509 100644 --- a/10/umbraco-deploy/README.md +++ b/10/umbraco-deploy/README.md @@ -6,22 +6,22 @@ description: Documentation on how to work with Umbraco Deploy. Umbraco Deploy is a deployment tool that helps you with the process of transferring code and data between multiple environments. Deploy can be configured for many different setups and is great for both small setups as well as large and more complex infrastructures. -
Installing Umbraco DeployLearn how you can install Umbraco Deploy on new and existing Umbraco projects.update.pnginstall-configure.md
Deployment workflow inLearn about how the Deployment workflow in Umbraco Deploy work.lightbulb.pngdeployment-workflow
UpgradingLearn how you can upgrade Umbraco Deploy.code_cursor.pngUpgrades
+
Installing Umbraco DeployLearn how you can install Umbraco Deploy on new and existing Umbraco projects.update.pnginstall-configure.md
Deployment workflow inLearn about how the Deployment workflow in Umbraco Deploy work.lightbulb.pngdeployment-workflow
UpgradingLearn how you can upgrade Umbraco Deploy.code_cursor.pngUpgrades
{% embed url="https://www.youtube-nocookie.com/embed/Fqfc-UL4q5U" %} Umbraco Deploy Overview {% endembed %} -{% content-ref url="deploy-settings.md" %} -[deploy-settings.md](deploy-settings.md) +{% content-ref url="getting-started/deploy-settings.md" %} +[getting-started/deploy-settings.md](getting-started/deploy-settings.md) {% endcontent-ref %} -{% content-ref url="extending.md" %} -[extending.md](extending.md) +{% content-ref url="getting-started/extending.md" %} +[extending.md](getting-started/extending.md) {% endcontent-ref %} -{% content-ref url="troubleshooting.md" %} -[troubleshooting.md](troubleshooting.md) +{% content-ref url="getting-started/troubleshooting.md" %} +[troubleshooting.md](getting-started/troubleshooting.md) {% endcontent-ref %} Umbraco Deploy is also the engine that runs behind the scenes on [Umbraco Cloud](https://docs.umbraco.com/umbraco-cloud/). Here it takes care of all the deployment processes of both code, schema and content on projects. diff --git a/10/umbraco-deploy/SUMMARY.md b/10/umbraco-deploy/SUMMARY.md index 838c0f835c0..55424c806fa 100644 --- a/10/umbraco-deploy/SUMMARY.md +++ b/10/umbraco-deploy/SUMMARY.md @@ -1,22 +1,30 @@ # Table of contents -* [What is Umbraco Deploy?](README.md) +* [Umbraco Deploy Documentation](README.md) * [Legacy Documentation](legacy-documentation.md) * [Release notes](release-notes.md) -* [Getting started](get-started-with-deploy.md) -* [Configuration](deploy-settings.md) -* [Extending](extending.md) -* [Handling Cache Refresher Notifications](handling-cache-refresher-notifications.md) -* [Troubleshooting](troubleshooting.md) -* [Licensing](the-licensing-model.md) + +## Installation + +* [Installing Umbraco Deploy](installation/install-configure.md) +* [Licensing](installation/the-licensing-model.md) + +## Upgrading + +* [Upgrading Umbraco Deploy](upgrades/README.md) +* [Version Specific Upgrade Details](upgrades/version-specific.md) ## Getting Started -* [Installing Umbraco Deploy](getting-started/install-configure.md) +* [Getting started](getting-started/get-started-with-deploy.md) * [CI/CD Build and Deployment Pipeline](getting-started/cicd-pipeline/README.md) * [Azure DevOps](getting-started/cicd-pipeline/ci-cd-azure-dev-ops.md) * [Github actions](getting-started/cicd-pipeline/ci-cd-github-actions.md) * [Streamlining Local Development](getting-started/streamlining-local-development.md) +* [Configuration](getting-started/deploy-settings.md) +* [Extending](getting-started/extending.md) +* [Handling Cache Refresher Notifications](getting-started/handling-cache-refresher-notifications.md) +* [Troubleshooting](getting-started/troubleshooting.md) ## Deployment Workflow @@ -28,8 +36,3 @@ * [Restoring content](deployment-workflow/restoring-content/README.md) * [Partial Restores](deployment-workflow/restoring-content/partial-restore.md) * [Deploy Dashboard](deployment-workflow/deploy-dashboard.md) - -## Upgrading - -* [Upgrading](upgrades/README.md) -* [Version Specific Upgrade Details](upgrades/version-specific.md) diff --git a/10/umbraco-deploy/deployment-workflow/content-transfer.md b/10/umbraco-deploy/deployment-workflow/content-transfer.md index fbe349bc1bd..b708b5f356e 100644 --- a/10/umbraco-deploy/deployment-workflow/content-transfer.md +++ b/10/umbraco-deploy/deployment-workflow/content-transfer.md @@ -52,7 +52,7 @@ Media items are transferred the same way as content: ### Umbraco Forms -In order for Deploy to handle Forms data as content, you will need to ensure that the `transferFormsAsContent` setting in configuration is set to `true`. See details in the [Deploy Settings for Umbraco 9](../deploy-settings.md) article. +In order for Deploy to handle Forms data as content, you will need to ensure that the `transferFormsAsContent` setting in configuration is set to `true`. See details in the [Deploy Settings for Umbraco 9+](../getting-started/deploy-settings.md) article. Once the setting have been added to the source and target environment forms can be transferred the same way as content and media: @@ -68,6 +68,6 @@ This does not include entries submitted via the forms. Sometimes a content transfer might not be possible. For example if you add a new property to the HomePage Document type and you don’t have that property in both environments, you’ll get an error with a hint on how to fix this. -![clone dialog](../../umbraco-cloud/deployment/images/schema-mismatch.png) +![clone dialog](../../../umbraco-cloud/deployment/images/schema-mismatch.png) -If you are seeing this type of issue when trying to transfer content, head over to our article about [Schema Mismatch errors](../troubleshooting.md), where you can read about how to resolve the issues. +If you are seeing this type of issue when trying to transfer content, head over to our article about [Schema Mismatch errors](../getting-started/troubleshooting.md), where you can read about how to resolve the issues. diff --git a/10/umbraco-deploy/deployment-workflow/deploy-dashboard.md b/10/umbraco-deploy/deployment-workflow/deploy-dashboard.md index 273071ec1bd..907ec9d7705 100644 --- a/10/umbraco-deploy/deployment-workflow/deploy-dashboard.md +++ b/10/umbraco-deploy/deployment-workflow/deploy-dashboard.md @@ -48,7 +48,7 @@ This operation is useful if you want to move to another Umbraco instance and mig ## Configuration Details -In the Configuration details, you can see how Umbraco Deploy has been [configured](../deploy-settings.md) on your environment. You get an overview of the Setting options, the current value(s), and notes help you understand each of the settings. Updates to the need to be applied in the `appsettings.json` file. +In the Configuration details, you can see how Umbraco Deploy has been [configured](../getting-started/deploy-settings.md) on your environment. You get an overview of the Setting options, the current value(s), and notes help you understand each of the settings. Updates to the need to be applied in the `appsettings.json` file.

Example of Umbraco Deploy configuration.

diff --git a/10/umbraco-deploy/deployment-workflow/deploying-deletions.md b/10/umbraco-deploy/deployment-workflow/deploying-deletions.md index 169a9015114..c7ae8a7f974 100644 --- a/10/umbraco-deploy/deployment-workflow/deploying-deletions.md +++ b/10/umbraco-deploy/deployment-workflow/deploying-deletions.md @@ -11,7 +11,7 @@ In this article you can read about the correct way of deleting files, schema and When you are using Umbraco Deploy, you might have more than one environment - including a local clone of the project. These environments each have their own database. The databases will contain references to all of your content and media, as well as to all of your schema files (e.g. Document Types, Templates etc). -The databases are environment specific. When you deploy from one environment to another, Umbraco Deploy will compare incoming schema files with references to these in the databases using both _alias_ and _GUID_. If something doesn't add up - e.g. there is a mismatch between the database references and the files deployed - you will see an error. Learn more about this in the [Troubleshooting section](../troubleshooting.md). +The databases are environment specific. When you deploy from one environment to another, Umbraco Deploy will compare incoming schema files with references to these in the databases using both _alias_ and _GUID_. If something doesn't add up - e.g. there is a mismatch between the database references and the files deployed - you will see an error. Learn more about this in the [Troubleshooting section](../getting-started/troubleshooting.md). The workflow described above does not pick up deletions of content and schema from the database, which is why you'll need to delete the content and/or schema on all your environments, in order to fully complete the deletion. diff --git a/10/umbraco-deploy/deploy-settings.md b/10/umbraco-deploy/getting-started/deploy-settings.md similarity index 100% rename from 10/umbraco-deploy/deploy-settings.md rename to 10/umbraco-deploy/getting-started/deploy-settings.md diff --git a/10/umbraco-deploy/extending.md b/10/umbraco-deploy/getting-started/extending.md similarity index 100% rename from 10/umbraco-deploy/extending.md rename to 10/umbraco-deploy/getting-started/extending.md diff --git a/10/umbraco-deploy/get-started-with-deploy.md b/10/umbraco-deploy/getting-started/get-started-with-deploy.md similarity index 85% rename from 10/umbraco-deploy/get-started-with-deploy.md rename to 10/umbraco-deploy/getting-started/get-started-with-deploy.md index ac1b34a8033..d93112727f9 100644 --- a/10/umbraco-deploy/get-started-with-deploy.md +++ b/10/umbraco-deploy/getting-started/get-started-with-deploy.md @@ -16,15 +16,15 @@ For example, when working locally you might create a new Document Type. This wil When you want this deployed to your next environment, you would trigger your CI/CD process (for example Azure DevOps or Github Actions). This will push the changes to your environment. Once the build deployment completes successfully, a Deployment Trigger would be executed as an HTTPS request to your target environment. All changes found in the `umbraco/Deploy/Revision` folder will then be extracted into the Umbraco target environment. -![Deploy workflow]() +![Deploy workflow](../images/Deploy_concept%20(1).png) -## [Quick start (new sites)](getting-started/install-configure.md) +## [Quick start (new sites)](../installation/install-configure.md) There are three main steps you need to go through in order to start using Umbraco Deploy on your website. -1. [Set up Git repository and new Umbraco project](getting-started/install-configure.md#prerequisites) +1. [Set up Git repository and new Umbraco project](../installation/install-configure.md#prerequisites) * Set up a repository and then install a new Umbraco project inside it. -2. [Install Umbraco Deploy via NuGet](getting-started/install-configure.md#installing-and-configuring-umbraco-deploy) +2. [Install Umbraco Deploy via NuGet](../installation/install-configure.md#installing-and-configuring-umbraco-deploy) * Umbraco Deploy can be installed via NuGet. -3. [Configure CI/CD build server](getting-started/cicd-pipeline/) +3. [Configure CI/CD build server](../getting-started/cicd-pipeline/) * Umbraco Deploy needs a CI/CD build server needs to be set up to run when you want changes to be deployed to next upstream environment diff --git a/10/umbraco-deploy/handling-cache-refresher-notifications.md b/10/umbraco-deploy/getting-started/handling-cache-refresher-notifications.md similarity index 100% rename from 10/umbraco-deploy/handling-cache-refresher-notifications.md rename to 10/umbraco-deploy/getting-started/handling-cache-refresher-notifications.md diff --git a/10/umbraco-deploy/troubleshooting.md b/10/umbraco-deploy/getting-started/troubleshooting.md similarity index 100% rename from 10/umbraco-deploy/troubleshooting.md rename to 10/umbraco-deploy/getting-started/troubleshooting.md diff --git a/10/umbraco-deploy/getting-started/install-configure.md b/10/umbraco-deploy/installation/install-configure.md similarity index 98% rename from 10/umbraco-deploy/getting-started/install-configure.md rename to 10/umbraco-deploy/installation/install-configure.md index 66c2596160e..3f95a6f2454 100644 --- a/10/umbraco-deploy/getting-started/install-configure.md +++ b/10/umbraco-deploy/installation/install-configure.md @@ -227,4 +227,4 @@ Before moving on to setting up the build server, make sure that your license is The file needs to be placed in the `/umbraco/Licenses` folder. -Read more about the [Umbraco Deploy licensing model](../the-licensing-model.md). +Read more about the [Umbraco Deploy licensing model](../installation/the-licensing-model.md). diff --git a/10/umbraco-deploy/the-licensing-model.md b/10/umbraco-deploy/installation/the-licensing-model.md similarity index 100% rename from 10/umbraco-deploy/the-licensing-model.md rename to 10/umbraco-deploy/installation/the-licensing-model.md diff --git a/10/umbraco-deploy/release-notes.md b/10/umbraco-deploy/release-notes.md index 4fe334a2908..7e8afc17f23 100644 --- a/10/umbraco-deploy/release-notes.md +++ b/10/umbraco-deploy/release-notes.md @@ -1,7 +1,6 @@ --- description: >- - Get an overview of the things changed and fixed in each version of Umbraco - Forms. + Get an overview of the things changed and fixed in each version of Umbraco Deploy. --- # Release notes @@ -46,8 +45,8 @@ This section contains the release notes for Umbraco Deploy 4 and 10 including al [**10.3.0-rc1**](https://github.com/umbraco/Umbraco.Deploy.Issues/issues?q=is%3Aissue+is%3Aclosed+label%3Arelease%2F10.3.0) **(November 27th 2023)** * Added feature of [content import and export with migrations](deployment-workflow/import-export.md). -* Added a new configuration option of `ResolveUserInTargetEnvironment` to allow resolving of user accounts in target environments (see [Deploy Settings](deploy-settings.md)). -* Added a new configuration option of `AllowPublicAccessDeploymentOperations` to amend the behavior of public access rule transfer (see [Deploy Settings](deploy-settings.md)). +* Added a new configuration option of `ResolveUserInTargetEnvironment` to allow resolving of user accounts in target environments (see [Deploy Settings](getting-started/deploy-settings.md)). +* Added a new configuration option of `AllowPublicAccessDeploymentOperations` to amend the behavior of public access rule transfer (see [Deploy Settings](getting-started/deploy-settings.md)). * Improve performance of publishing multi-language content during restore/transfer and import. [**10.2.7**](https://github.com/umbraco/Umbraco.Deploy.Issues/issues?q=is%3Aissue+is%3Aclosed+label%3Arelease%2F10.2.7) (**November 14th 2023**) @@ -204,8 +203,8 @@ This section contains the release notes for Umbraco Deploy 4 and 10 including al [**4.9.0-rc1**](https://github.com/umbraco/Umbraco.Deploy.Issues/issues?q=is%3Aissue+is%3Aclosed+label%3Arelease%2F4.9.0) **(November 27th 2023)** * Added feature of [content import and export with migrations](deployment-workflow/import-export.md). -* Added a new configuration option of `ResolveUserInTargetEnvironment` to allow resolving of user accounts in target environments (see [Deploy Settings](deploy-settings.md)). -* Added a new configuration option of `AllowPublicAccessDeploymentOperations` to amend the behavior of public access rule transfer (see [Deploy Settings](deploy-settings.md)). +* Added a new configuration option of `ResolveUserInTargetEnvironment` to allow resolving of user accounts in target environments (see [Deploy Settings](getting-started/deploy-settings.md)). +* Added a new configuration option of `AllowPublicAccessDeploymentOperations` to amend the behavior of public access rule transfer (see [Deploy Settings](getting-started/deploy-settings.md)). [**4.8.4**](https://github.com/umbraco/Umbraco.Deploy.Issues/issues?q=is%3Aissue+is%3Aclosed+label%3Arelease%2F4.8.4) **(October 10th 2023)** @@ -428,4 +427,4 @@ This section contains the release notes for Umbraco Deploy 4 and 10 including al ## Legacy release notes -You can find the release notes for versions out of support in the [Legacy documentation release notes ](https://github.com/umbraco/UmbracoDocs/blob/umbraco-eol-versions/11/umbraco-deploy/release-notes.md)and[ Umbraco Deploy Package page.](https://our.umbraco.com/packages/developer-tools/umbraco-deploy/) +You can find the release notes for versions out of support in the [Legacy documentation on Github](https://github.com/umbraco/UmbracoDocs/blob/umbraco-eol-versions/11/umbraco-deploy/release-notes.md) and [Umbraco Deploy Package page.](https://our.umbraco.com/packages/developer-tools/umbraco-deploy/) diff --git a/10/umbraco-forms/.gitbook.yaml b/10/umbraco-forms/.gitbook.yaml index 212b01df345..8865254d413 100644 --- a/10/umbraco-forms/.gitbook.yaml +++ b/10/umbraco-forms/.gitbook.yaml @@ -1,8 +1,10 @@ root: ./ -​structure: +​structure: readme: README.md summary: SUMMARY.md redirects: - installation/upgrade: installation/version-specific#version-7 \ No newline at end of file + the-licensing-model: installation/the-licensing-model.md + installation/manualupgrade: upgrading/manualupgrade.md + installation/version-specific: upgrading/version-specific.md diff --git a/10/umbraco-forms/README.md b/10/umbraco-forms/README.md index d8c5a6878d5..5301e0a64ba 100644 --- a/10/umbraco-forms/README.md +++ b/10/umbraco-forms/README.md @@ -17,8 +17,8 @@ Umbraco Forms is a tool that lets you build forms of all shapes and sizes and pu ## Quick Links -{% content-ref url="installation/manualupgrade.md" %} -[manualupgrade.md](installation/manualupgrade.md) +{% content-ref url="upgrading/manualupgrade.md" %} +[manualupgrade.md](upgrading/manualupgrade.md) {% endcontent-ref %} {% content-ref url="editor/attaching-workflows/" %} diff --git a/10/umbraco-forms/SUMMARY.md b/10/umbraco-forms/SUMMARY.md index 23ef64d15fc..8d25087f307 100644 --- a/10/umbraco-forms/SUMMARY.md +++ b/10/umbraco-forms/SUMMARY.md @@ -7,9 +7,12 @@ ## Installation * [Installing Umbraco Forms](installation/install.md) -* [Manually Upgrading Umbraco Forms](installation/manualupgrade.md) -* [Version Specific Upgrade Notes](installation/version-specific.md) -* [Licensing](the-licensing-model.md) +* [Licensing](installation/the-licensing-model.md) + +## Upgrading + +* [Upgrading Umbraco Forms](upgrading/manualupgrade.md) +* [Version Specific Upgrade Notes](upgrading/version-specific.md) ## Editor diff --git a/10/umbraco-forms/developer/extending/adding-a-fieldtype.md b/10/umbraco-forms/developer/extending/adding-a-fieldtype.md index 8f08a2e4f02..1716a8459db 100644 --- a/10/umbraco-forms/developer/extending/adding-a-fieldtype.md +++ b/10/umbraco-forms/developer/extending/adding-a-fieldtype.md @@ -105,7 +105,7 @@ This will be rendered when the default theme is used. If working with Umbraco 9 or earlier versions, you'll find the `Views\Partials\Forms\Themes\default\` folder on disk and can create the files in there. -For Umbraco 10 and above, we've moved to [distributing the theme as part of a Razor Class Library](../../installation/version-specific.md#views-and-client-side-files) so the folder won't exist. However, you can create it for your custom field type. If you would like to reference the partial views of the default theme, you can download them as mentioned in the [Themes](../themes.md) article. +For Umbraco 10 and above, we've moved to [distributing the theme as part of a Razor Class Library](../../upgrading/version-specific.md#views-and-client-side-files) so the folder won't exist. However, you can create it for your custom field type. If you would like to reference the partial views of the default theme, you can download them as mentioned in the [Themes](../themes.md) article. ## Umbraco backoffice view diff --git a/10/umbraco-forms/the-licensing-model.md b/10/umbraco-forms/installation/the-licensing-model.md similarity index 100% rename from 10/umbraco-forms/the-licensing-model.md rename to 10/umbraco-forms/installation/the-licensing-model.md diff --git a/10/umbraco-forms/release-notes.md b/10/umbraco-forms/release-notes.md index 1e16d454ff9..86f42726ae9 100644 --- a/10/umbraco-forms/release-notes.md +++ b/10/umbraco-forms/release-notes.md @@ -1,7 +1,6 @@ --- description: >- - Get an overview of the things changed and fixed in each version of Umbraco - Forms. + Get an overview of the things changed and fixed in each version of Umbraco Forms. --- # Release Notes @@ -11,7 +10,7 @@ In this section, we have summarized the changes to Umbraco Forms released in eac If there are any breaking changes or other issues to be aware of when upgrading they are also noted here. {% hint style="info" %} -If you are upgrading to a new major version, you can find information about the breaking changes in the [Version Specific Upgrade Notes](installation/version-specific.md) article +If you are upgrading to a new major version, you can find information about the breaking changes in the [Version Specific Upgrade Notes](./upgrading/version-specific.md) article {% endhint %} ## Release History @@ -750,4 +749,4 @@ Breaking changes: ## Legacy release notes -You can find the release notes for versions out of support in the [Legacy documentation release notes](https://github.com/umbraco/UmbracoDocs/blob/umbraco-eol-versions/11/umbraco-forms/release-notes.md) and [Umbraco Forms Package page](https://our.umbraco.com/packages/developer-tools/umbraco-forms/). +You can find the release notes for versions out of support in the [Legacy documentation on Github](https://github.com/umbraco/UmbracoDocs/blob/umbraco-eol-versions/11/umbraco-forms/release-notes.md) and [Umbraco Forms Package page](https://our.umbraco.com/packages/developer-tools/umbraco-forms/). diff --git a/10/umbraco-forms/installation/manualupgrade.md b/10/umbraco-forms/upgrading/manualupgrade.md similarity index 95% rename from 10/umbraco-forms/installation/manualupgrade.md rename to 10/umbraco-forms/upgrading/manualupgrade.md index 9d777e7f6c6..428d0676dc6 100644 --- a/10/umbraco-forms/installation/manualupgrade.md +++ b/10/umbraco-forms/upgrading/manualupgrade.md @@ -22,7 +22,7 @@ To get the latest version of Umbraco Forms, you can upgrade using: 2. Select **Umbraco.Forms**. 3. Select the latest version from the **Version** drop-down and click **Install**. -![NuGet Package Manager]() +![NuGet Package Manager](../installation/images/Manage_packages_v10.png) 4. When the command completes, open the **.csproj** file to make sure the package reference is updated: diff --git a/10/umbraco-forms/installation/version-specific.md b/10/umbraco-forms/upgrading/version-specific.md similarity index 100% rename from 10/umbraco-forms/installation/version-specific.md rename to 10/umbraco-forms/upgrading/version-specific.md diff --git a/10/umbraco-ui-builder/.gitbook.yaml b/10/umbraco-ui-builder/.gitbook.yaml index 5f8a5d6585b..83e70191059 100644 --- a/10/umbraco-ui-builder/.gitbook.yaml +++ b/10/umbraco-ui-builder/.gitbook.yaml @@ -1,7 +1,12 @@ root: ./ ​structure: - readme: README.md - summary: SUMMARY.md + readme: README.md + summary: SUMMARY.md redirects: +getting-started/upgrading/README: upgrading/upgrade.md +getting-started/upgrading/version-specific-upgrades: upgrading/version-specific.md +getting-started/installation: installation/installation.md +getting-started/licensing-model: installation/licensing-model.md +guides/migrating-from-konstrukt-to-umbraco-ui-builder: upgrading/migrating-from-konstrukt-to-umbraco-ui-builder.md diff --git a/10/umbraco-ui-builder/SUMMARY.md b/10/umbraco-ui-builder/SUMMARY.md index 03655486228..e28f1cfc113 100644 --- a/10/umbraco-ui-builder/SUMMARY.md +++ b/10/umbraco-ui-builder/SUMMARY.md @@ -4,20 +4,26 @@ * [Known Issues](known-issues.md) * [Release Notes](release-notes.md) +## Installation + +* [Installing Umbraco UI Builder](installation/installation.md) +* [Licensing](installation/licensing-model.md) + +## Upgrading + +* [Upgrading Umbraco UI Builder](upgrading/upgrade.md) +* [Version Specific Upgrade Notes](upgrading/version-specific.md) +* [Migrate from Konstrukt to Umbraco UI Builder](upgrading/migrating-from-konstrukt-to-umbraco-ui-builder.md) + ## Getting Started * [Overview](getting-started/overview.md) -* [Installation](getting-started/installation.md) -* [Upgrading](getting-started/upgrading/README.md) - * [Version Specific Upgrade Notes](getting-started/upgrading/version-specific-upgrades.md) * [Configuration](getting-started/configuration.md) * [User Interface](getting-started/user-interface.md) -* [Licensing](getting-started/licensing-model.md) ## How-to Guides * [Creating your first integration](guides/creating-your-first-integration.md) -* [Migrate from Konstrukt to Umbraco UI Builder](guides/migrating-from-konstrukt-to-umbraco-ui-builder.md) ## Areas diff --git a/10/umbraco-ui-builder/getting-started/installation.md b/10/umbraco-ui-builder/installation/installation.md similarity index 100% rename from 10/umbraco-ui-builder/getting-started/installation.md rename to 10/umbraco-ui-builder/installation/installation.md diff --git a/10/umbraco-ui-builder/getting-started/licensing-model.md b/10/umbraco-ui-builder/installation/licensing-model.md similarity index 100% rename from 10/umbraco-ui-builder/getting-started/licensing-model.md rename to 10/umbraco-ui-builder/installation/licensing-model.md diff --git a/10/umbraco-ui-builder/release-notes.md b/10/umbraco-ui-builder/release-notes.md index 4a360f9b843..bb32d827a35 100644 --- a/10/umbraco-ui-builder/release-notes.md +++ b/10/umbraco-ui-builder/release-notes.md @@ -1,7 +1,6 @@ --- description: >- - Get an overview of the things changed and fixed in each version of Umbraco UI - Builder. + Get an overview of the things changed and fixed in each version of Umbraco UI Builder. --- # Release Notes @@ -11,7 +10,7 @@ In this section, we have summarized the changes to Umbraco UI Builder released i If there are any breaking changes or other issues to be aware of when upgrading they are also noted here. {% hint style="info" %} -If you are upgrading to a new major version, check the breaking changes in the [Version Specific Upgrade Notes](getting-started/upgrading/version-specific-upgrades.md) article. +If you are upgrading to a new major version, check the breaking changes in the [Version Specific Upgrade Notes](./upgrading/version-specific.md) article. {% endhint %} ## Release History @@ -39,4 +38,4 @@ This section contains the release notes for Umbraco UI Builder 10 including all ## Legacy release notes -You can find the release notes for **Konstrukt** in the[ ](https://github.com/umbraco/UmbracoDocs/blob/umbraco-eol-versions/11/umbraco-workflow/release-notes.md)[Change log file on Github](../../13/umbraco-commerce/changelog-archive/Vendr-core.md). +You can find the release notes for **Konstrukt** in the [Change log file on Github](../../13/umbraco-commerce/changelog-archive/Vendr-core.md). diff --git a/12/umbraco-ui-builder/guides/migrating-from-konstrukt-to-umbraco-ui-builder.md b/10/umbraco-ui-builder/upgrading/migrating-from-konstrukt-to-umbraco-ui-builder.md similarity index 100% rename from 12/umbraco-ui-builder/guides/migrating-from-konstrukt-to-umbraco-ui-builder.md rename to 10/umbraco-ui-builder/upgrading/migrating-from-konstrukt-to-umbraco-ui-builder.md diff --git a/13/umbraco-ui-builder/upgrading/manualupgrade.md b/10/umbraco-ui-builder/upgrading/upgrade.md similarity index 100% rename from 13/umbraco-ui-builder/upgrading/manualupgrade.md rename to 10/umbraco-ui-builder/upgrading/upgrade.md diff --git a/10/umbraco-ui-builder/getting-started/upgrading/version-specific-upgrades.md b/10/umbraco-ui-builder/upgrading/version-specific.md similarity index 90% rename from 10/umbraco-ui-builder/getting-started/upgrading/version-specific-upgrades.md rename to 10/umbraco-ui-builder/upgrading/version-specific.md index 13d674d23a7..9ba60989474 100644 --- a/10/umbraco-ui-builder/getting-started/upgrading/version-specific-upgrades.md +++ b/10/umbraco-ui-builder/upgrading/version-specific.md @@ -9,14 +9,14 @@ description: >- This page covers specific upgrade documentation for when migrating to major 10 of Umbraco UI Builder. {% hint style="info" %} -If you are upgrading to a new minor or patch version, you can find information about the breaking changes in the [Release Notes](../../release-notes.md) article. +If you are upgrading to a new minor or patch version, you can find information about the breaking changes in the [Release Notes](../release-notes.md) article. {% endhint %} ## Version Specific Upgrade Notes History Version 10 is the initial Long-term support (LTS) release of the Umbraco UI Builder product. It contains a number of breaking changes from the previous, Konstrukt product. -See the [Migrate from Konstrukt to Umbraco UI Builder guide](../../guides/migrating-from-konstrukt-to-umbraco-ui-builder.md) for full details. +See the [Migrate from Konstrukt to Umbraco UI Builder guide](../upgrading/migrating-from-konstrukt-to-umbraco-ui-builder.md) for full details. ## Legacy version specific upgrade notes diff --git a/10/umbraco-workflow/.gitbook.yaml b/10/umbraco-workflow/.gitbook.yaml index 53bd6d38fd0..d0ba2ba3912 100644 --- a/10/umbraco-workflow/.gitbook.yaml +++ b/10/umbraco-workflow/.gitbook.yaml @@ -1,14 +1,11 @@ root: ./ -​structure: +​structure: readme: README.md summary: SUMMARY.md redirects: - configuration: getting-started/configuration.md - dashboards-and-buttons: getting-started/dashboards-and-buttons.md - notifications: getting-started/notifications.md - workflow-content-app: getting-started/workflow-content-app.md - upgrading-workflow/upgrading-workflow: upgrading-workflow/upgrading.md - workflow-section/workflow-section: workflow-section/workflow-section-dashboard.md - \ No newline at end of file + installing-workflow: installation/installing-workflow.md + licensing: installation/licensing.md + upgrading-workflow/migrating-workflow: upgrading/migrating-workflow.md + upgrading-workflow/upgrading: upgrading/upgrading.md diff --git a/10/umbraco-workflow/README.md b/10/umbraco-workflow/README.md index 310bdef28df..f151eade791 100644 --- a/10/umbraco-workflow/README.md +++ b/10/umbraco-workflow/README.md @@ -9,7 +9,7 @@ Umbraco Workflow allows the creation of multi-stage approval workflows when writ [Learn more or purchase Umbraco Workflow to get all the features and support.](https://umbraco.com/products/umbraco-workflow/) -
Installing Umbraco WorkflowInstall Umbraco Workflow in a few stepsinstalling-workflow.mdumbraco-workflow-1.png
Content Approval Workflows for UmbracoAllows you to design the approval process to fit your organizationworkflow-content-app.mdCommunity.png
Workflow Section OverviewApproving, rejecting, content reviews, and scheduling workflows are natural additions to the existing toolboxworkflow-sectionDocumentation_blogpost_styleguide_b.png
+
Installing Umbraco WorkflowInstall Umbraco Workflow in a few stepsinstalling-workflow.mdumbraco-workflow-1.png
Content Approval Workflows for UmbracoAllows you to design the approval process to fit your organizationworkflow-content-app.mdCommunity.png
Workflow Section OverviewApproving, rejecting, content reviews, and scheduling workflows are natural additions to the existing toolboxworkflow-sectionDocumentation_blogpost_styleguide_b.png
{% embed url="https://www.youtube-nocookie.com/embed/jFWYZUiQPv8" %} Umbraco Workflow Overview diff --git a/10/umbraco-workflow/SUMMARY.md b/10/umbraco-workflow/SUMMARY.md index a4c7b39b367..1c5f8b7ec5d 100644 --- a/10/umbraco-workflow/SUMMARY.md +++ b/10/umbraco-workflow/SUMMARY.md @@ -3,8 +3,16 @@ * [Umbraco Workflow Documentation](README.md) * [Legacy Documentation](legacy-documentation.md) * [Release notes](release-notes.md) -* [Installation](installing-workflow.md) -* [Licensing](licensing.md) + +## Installation + +* [Installing Umbraco Workflow](installation/installing-workflow.md) +* [Licensing](installation/licensing.md) + +## Upgrading + +* [Upgrading Umbraco Workflow](upgrading/upgrading.md) +* [Migrate from Plumber to Workflow](upgrading/migrating-workflow.md) ## Getting Started @@ -15,11 +23,6 @@ * [Approval thresholds](getting-started/approval-thresholds.md) * [History Cleanup](getting-started/history-cleanup.md) -## Upgrading Workflow - -* [Upgrading](upgrading-workflow/upgrading.md) - * [Migrate from Plumber to Workflow](upgrading-workflow/migrating-workflow.md) - ## Workflow Section * [Workflow Section](workflow-section/workflow-section-dashboard.md) diff --git a/10/umbraco-workflow/getting-started/dashboards-and-buttons.md b/10/umbraco-workflow/getting-started/dashboards-and-buttons.md index 1638ca5cf67..17472a57046 100644 --- a/10/umbraco-workflow/getting-started/dashboards-and-buttons.md +++ b/10/umbraco-workflow/getting-started/dashboards-and-buttons.md @@ -11,13 +11,13 @@ Umbraco Workflow adds two Dashboards to your Umbraco project: ![Workflow Dashboard in the Content Section](<../images/WorkflowDashboard-ContentSection (1).png>) * **Admin Dashboard** - This Workflow Dashboard is the default view in the **Workflow** section. It displays a chart of recent workflow activity, chart of content review activity, licensing details, and any relevant upgrade-related messages. You can also view the workflow and content review activity chart for the specified range of days. - ![Workflow Dashboard in the Workflow Section](../images/Workflow\_section.png) + ![Workflow Dashboard in the Workflow Section](../images/workflow-section.png) ## Buttons When a workflow is active on the current node, the **Publish** button is replaced, linking to the workflow content app. -![Buttons drawe](<../images/Buttons (1).png>) +![Buttons](../images/Buttons%20(1).png) When no workflow is active, the button state is determined by the current user's permissions. @@ -25,8 +25,8 @@ Umbraco Workflow overrides Umbraco's User/Group publishing permissions. If the u In cases, where the content is already in a workflow, a notification is displayed at the top of the editor. Depending on the Workflow **Settings**, you can enable/disable editing access on a content node in a workflow. -![Disabled content edits](../images/blocked\_content.png) +![Disabled content edits](../images/blocked_content.png) For nodes where the workflow has been disabled, the default Umbraco options are displayed. -![Default Button](<../images/Default\_Buttons (1).png>) +![Default Button](../images/Default_Buttons%20(1).png) diff --git a/10/umbraco-workflow/installing-workflow.md b/10/umbraco-workflow/installation/installing-workflow.md similarity index 100% rename from 10/umbraco-workflow/installing-workflow.md rename to 10/umbraco-workflow/installation/installing-workflow.md diff --git a/10/umbraco-workflow/licensing.md b/10/umbraco-workflow/installation/licensing.md similarity index 100% rename from 10/umbraco-workflow/licensing.md rename to 10/umbraco-workflow/installation/licensing.md diff --git a/10/umbraco-workflow/release-notes.md b/10/umbraco-workflow/release-notes.md index 02a66656550..bb70426f3cf 100644 --- a/10/umbraco-workflow/release-notes.md +++ b/10/umbraco-workflow/release-notes.md @@ -1,7 +1,6 @@ --- description: >- - Get an overview of the things changed and fixed in each version of Umbraco - Workflow. + Get an overview of the things changed and fixed in each version of Umbraco Workflow. --- # Release notes @@ -11,7 +10,7 @@ In this section, we have summarized the changes to Umbraco Workflow released in If there are any breaking changes or other issues to be aware of when upgrading they are also noted here. {% hint style="info" %} -If you are migrating from Plumber to Umbraco Workflow, see the [Migrate from Plumber to Workflow](upgrading-workflow/migrating-workflow.md) article. +If you are migrating from Plumber to Umbraco Workflow, see the [Migrate from Plumber to Workflow](./upgrading/migrating-workflow.md) article. {% endhint %} ## Release History @@ -112,4 +111,4 @@ This section contains the release notes for Umbraco Workflow 10 including all ch ## Legacy release notes -You can find the release notes for versions out of support in the[ Legacy documentation release notes.](https://github.com/umbraco/UmbracoDocs/blob/umbraco-eol-versions/11/umbraco-workflow/release-notes.md) +You can find the release notes for versions out of support in the [Legacy documentation on Github](https://github.com/umbraco/UmbracoDocs/blob/umbraco-eol-versions/11/umbraco-workflow/release-notes.md) diff --git a/10/umbraco-workflow/upgrading-workflow/migrating-workflow.md b/10/umbraco-workflow/upgrading/migrating-workflow.md similarity index 92% rename from 10/umbraco-workflow/upgrading-workflow/migrating-workflow.md rename to 10/umbraco-workflow/upgrading/migrating-workflow.md index 1b195be6ce1..4716f344e7b 100644 --- a/10/umbraco-workflow/upgrading-workflow/migrating-workflow.md +++ b/10/umbraco-workflow/upgrading/migrating-workflow.md @@ -8,7 +8,7 @@ To migrate from an Umbraco installation with an existing Plumber installation to {% tab title="Site running on SQL Server database" %} 1. Uninstall Plumber and remove the `/App_Plugins/Plumber` folder. 2. Upgrade your project to Umbraco 10. -3. Install Umbraco Workflow 10. See the [Installing Umbraco Workflow](../installing-workflow.md) article. +3. Install Umbraco Workflow 10. See the [Installing Umbraco Workflow](../installation/installing-workflow.md) article. 4. Build the application. {% hint style="info" %} @@ -22,7 +22,7 @@ SQL is the preferred database provider for production websites. 3. Make a copy of the `Value` column from the `WorkflowSettings` table. 4. Delete the `WorkflowSettings` table. 5. Update `WorkflowTaskInstance` table to allow null values in the GroupId column. -6. Install Umbraco Workflow 10. See the [Installing Umbraco Workflow](../installing-workflow.md) article. +6. Install Umbraco Workflow 10. See the [Installing Umbraco Workflow](../installation/installing-workflow.md) article. 7. Build the application. 8. Update the `WorkflowSettings` table to restore the previous data to the `Value` column. {% endtab %} diff --git a/10/umbraco-workflow/upgrading-workflow/upgrading.md b/10/umbraco-workflow/upgrading/upgrading.md similarity index 100% rename from 10/umbraco-workflow/upgrading-workflow/upgrading.md rename to 10/umbraco-workflow/upgrading/upgrading.md diff --git a/12/umbraco-commerce/.gitbook.yaml b/12/umbraco-commerce/.gitbook.yaml index 90e32539d53..620bb806f64 100644 --- a/12/umbraco-commerce/.gitbook.yaml +++ b/12/umbraco-commerce/.gitbook.yaml @@ -1,9 +1,14 @@ root: ./ -​structure: +​structure: readme: README.md summary: SUMMARY.md redirects: - -getting-started/installation/version-specific-upgrades: getting-started/upgrading/version-specific-upgrades.md +getting-started/installation/README: installation/install.md +getting-started/licensing-model: installation/licensing-model.md +getting-started/upgrading: upgrading/upgrade.md +getting-started/upgrading/version-specific-upgrades: upgrading/version-specific-upgrades.md +how-to-guides/migrate-from-vendr-to-umbraco-commerce/migrate-custom-payment-providers: upgrading/migrate-from-vendr-to-umbraco-commerce/migrate-custom-payment-providers.md +how-to-guides/migrate-from-vendr-to-umbraco-commerce/migrate-umbraco-commerce-checkout: upgrading/migrate-from-vendr-to-umbraco-commerce/migrate-umbraco-commerce-checkout.md +how-to-guides/migrate-from-vendr-to-umbraco-commerce/README: upgrading/migrate-from-vendr-to-umbraco-commerce/README.md diff --git a/12/umbraco-commerce/SUMMARY.md b/12/umbraco-commerce/SUMMARY.md index a68bbddff46..a6389c28404 100644 --- a/12/umbraco-commerce/SUMMARY.md +++ b/12/umbraco-commerce/SUMMARY.md @@ -1,26 +1,32 @@ # Table of contents -* [What is Umbraco Commerce?](README.md) +* [Umbraco Commerce Documentation](README.md) * [Commerce Packages](https://docs.umbraco.com/umbraco-commerce-packages) * [Commerce Payment Providers](https://docs.umbraco.com/umbraco-commerce-payment-providers) * [Release Notes](release-notes.md) +## Installation + +* [Installing Umbraco Commerce](installation/install.md) +* [Licensing](installation/licensing-model.md) + +## Upgrading + +* [Upgrading Umbraco Commerce](upgrading/upgrade.md) +* [Version Specific Upgrade Notes](upgrading/version-specific-upgrades.md) +* [Migrate from Vendr to Umbraco Commerce](upgrading/migrate-from-vendr-to-umbraco-commerce/README.md) + * [Migrate Umbraco Commerce Checkout](upgrading/migrate-from-vendr-to-umbraco-commerce/migrate-umbraco-commerce-checkout.md) + * [Migrate custom Payment Providers](upgrading/migrate-from-vendr-to-umbraco-commerce/migrate-custom-payment-providers.md) + ## Getting Started * [Introduction](getting-started/introduction.md) -* [Installation](getting-started/installation/README.md) -* [Upgrading](getting-started/upgrading/README.md) - * [Version Specific Upgrade Notes](getting-started/upgrading/version-specific-upgrades.md) * [Umbraco Configuration](getting-started/umbraco-configuration.md) * [User Interface](getting-started/user-interface.md) -* [Licensing](getting-started/licensing-model.md) ## How-To Guides * [Overview](how-to-guides/overview.md) -* [Migrate from Vendr to Umbraco Commerce](how-to-guides/migrate-from-vendr-to-umbraco-commerce/README.md) - * [Migrate Umbraco Commerce Checkout](how-to-guides/migrate-from-vendr-to-umbraco-commerce/migrate-umbraco-commerce-checkout.md) - * [Migrate custom Payment Providers](how-to-guides/migrate-from-vendr-to-umbraco-commerce/migrate-custom-payment-providers.md) * [Configure SQLite support](how-to-guides/configure-sqlite-support.md) * [Limit Order Line Quantity](how-to-guides/limit-orderline-quantity.md) * [Use an Alternative Database for Umbraco Commerce Tables](how-to-guides/use-an-alternative-database-for-umbraco-commerce-tables.md) diff --git a/12/umbraco-commerce/how-to-guides/overview.md b/12/umbraco-commerce/how-to-guides/overview.md index 04e265d4214..2c01c0cccd1 100644 --- a/12/umbraco-commerce/how-to-guides/overview.md +++ b/12/umbraco-commerce/how-to-guides/overview.md @@ -8,5 +8,5 @@ In this section, we will provide a series of How-To Guides, showcasing how to pe ## Available guides -
Migrate from Vendr to Umbraco Commercemigrate-from-vendr-to-umbraco-commerce
Configure SQLite supportconfigure-sqlite-support.md
Limit Order Line Quantitylimit-orderline-quantity.md
Use an alternative database for Umbraco Commerce tablesuse-an-alternative-database-for-umbraco-commerce-tables.md
+
Migrate from Vendr to Umbraco Commercemigrate-from-vendr-to-umbraco-commerce
Configure SQLite supportconfigure-sqlite-support.md
Limit Order Line Quantitylimit-orderline-quantity.md
Use an alternative database for Umbraco Commerce tablesuse-an-alternative-database-for-umbraco-commerce-tables.md
diff --git a/12/umbraco-commerce/getting-started/installation/README.md b/12/umbraco-commerce/installation/install.md similarity index 94% rename from 12/umbraco-commerce/getting-started/installation/README.md rename to 12/umbraco-commerce/installation/install.md index 8bf90273d12..bc8251955a7 100644 --- a/12/umbraco-commerce/getting-started/installation/README.md +++ b/12/umbraco-commerce/installation/install.md @@ -21,7 +21,7 @@ PM> dotnet add package Umbraco.Commerce Alternatively, you can also find and install the NuGet package via the NuGet Package Manager in Visual Studio. You will see a number of packages available, however, you will want to install the main **Umbraco Commerce** package. -![Installing Umbraco Commerce via the NuGet Package Manager](../../media/nuget-packages-overview.png) +![Installing Umbraco Commerce via the NuGet Package Manager](../media/nuget-packages-overview.png) For most sites using a single solution, the above will be all you need to install Umbraco Commerce into your project. When you have a more complex solution structure consisting of multiple projects, Umbraco Commerce is available in multiple sub-packages with varying dependencies. @@ -29,4 +29,4 @@ For most sites using a single solution, the above will be all you need to instal ## Installing a License -See the [Licensing page](../licensing-model.md#installing-your-license) for details on how to install a license. +See the [Licensing page](../installation/licensing-model.md#installing-your-license) for details on how to install a license. diff --git a/12/umbraco-commerce/getting-started/licensing-model.md b/12/umbraco-commerce/installation/licensing-model.md similarity index 98% rename from 12/umbraco-commerce/getting-started/licensing-model.md rename to 12/umbraco-commerce/installation/licensing-model.md index 07e0dd64afd..49d4c6f8e31 100644 --- a/12/umbraco-commerce/getting-started/licensing-model.md +++ b/12/umbraco-commerce/installation/licensing-model.md @@ -1,115 +1,115 @@ -# Licensing - -Umbraco Commerce is a commercial product. You can run an Umbraco Commerce unrestricted locally without the need a license. Running Umbraco Commerce on a public domain will display a warning banner in the backoffice and will limit the maximum number of orders (20). To remove these restrictions, you'll need to have a **valid license**. - -## How does it work? - -Licenses are sold per backoffice domain and will also work on all subdomains. If you have alternative staging/qa environment domains, additional domains can be added to the license on request. - -{% hint style="info" %} -The licenses are not bound to a specific product version. They will work for all versions of the related product. -{% endhint %} - -Let's say that you have a license configured for your domain, `mysite.com`, and you've requested two development domains, `devdomain.com` and `devdomain2.com`. - -The license will cover the following domains: - -* `localhost` -* `*.local` -* `*.mysite.com` -* `www.mysite.com` -* `devdomain.com` -* `www.devdomain.com` -* `devdomain2.com` -* `www.devdomain2.com` - -{% hint style="info" %} -You can have only 1 license per Umbraco installation. -{% endhint %} - -## What does a license cover? - -There are a few differences as to what the licenses cover: - -* A single license covers the installation of Umbraco Commerce in 1 production backoffice domain, as well as in any requested development domains. -* The production domain includes **all subdomains** (e.g. `*.mysite.com`). -* The development domains work with or without the `www` subdomain. -* The license allows for an unlimited number of orders. -* The license also includes `localhost` and `*.local` as a valid domain. - -{% hint style="info" %} -If you have multiple backoffice domains pointing at the same installation, you have the option to purchase and [add **additional domains**](licensing-model.md#add-additional-domains) to your license. - -This is an add-on domain for existing licenses. Refunds will not be given for this product. -{% endhint %} - -## Configuring your license - -You can purchase a license via the [Umbraco Commerce](https://umbraco.com/products/umbraco-commerce/) project page. A member of the [SUITS team](mailto:suits@umbraco.com) will manage this process. In the process, you will need to provide all domains you wish to have covered by the license such as primary and staging/qa domains. You should then receive a license code to be installed in your solution. - -### Add additional domains - -If you require to add addition domains to the license, please reach out to a member of the [SUITS team](mailto:suits@umbraco.com) with your request and they will manage this process. - -## Installing your license - -Once you have received your license code it needs to be installed on your site. - -1. Open the root directory for your project files. -2. Locate and open the `appSettings.json` file. -3. Add your Umbraco Commerce license key to `Umbraco:Licenses:Umbraco.Commerce`: - -```json -"Umbraco": { - "Licenses": { - "Umbraco.Commerce": "YOUR_LICENSE_KEY" - } -} -``` - -### Verify the license installation - -You can verify that your license is successfully installed by logging into your project's backoffice and navigating to the settings section. Here you will see a licenses dashboard which should display the status of your license. - -![Umbraco Commerce License Dashboard](../media/license-dashboard.png) - -### When and how to configure an `UmbracoApplicationUrl` - -If you are running on a single domain for both your frontend and backend environments, it's not necessary to configure a `UmbracoApplicationUrl`. - -If you have different domains for your frontend and backend, then it's advised that you configure an `UmbracoApplicationUrl` set to your backoffice URL. This helps the licensing engine know which URL should be used for validation checks. Without this configuration setting, the licensing engine will try and work out the domain to validate from the HTTP request object. This can lead to errors when switching between domains. - - -An `UmbracoApplicationUrl` can be configured in your `appSettings.json` file like so: - -```json -{ - "Umbraco": { - "CMS": { - "WebRouting": { - "UmbracoApplicationUrl": "https://admin.my-custom-domain.com/" - } - } - } -} -``` - -See the [Fixed Application URL](https://docs.umbraco.com/umbraco-cms/extending/health-check/guides/fixedapplicationurl) documentation for more details about this setting. - -#### Configuring `UmbracoApplicationUrl` on Umbraco Cloud - -If you are hosting on Umbraco Cloud you will find the configuration described above won't be reflected in your environment. The reason for this is that Umbraco Cloud sets this value as an environment variable set to the Cloud project domain (`.umbraco.io`). This overrides what is set via the `appSettings.json` file. - -There are two options in this case: -- Either the domains for each of your Cloud environments can be added to your license. -- Or, for more control and to ensure this value is set correctly for other reasons, you can apply the configuration via code. - -For example, in your `Startup.cs` file, you can add the following to the `ConfigureServices` method: - -```csharp -services.Configure(o => o.UmbracoApplicationUrl = ""); -``` - -In practice, you will probably want to make this a bit more sophisticated. You can read the value from another configuration key, removing the need to hard-code it and have it set as appropriate in different environments. You can also move this code into a composer or an extension method if you prefer not to clutter up the `Startup.ConfigureServices` method. - - +# Licensing + +Umbraco Commerce is a commercial product. You can run an Umbraco Commerce unrestricted locally without the need a license. Running Umbraco Commerce on a public domain will display a warning banner in the backoffice and will limit the maximum number of orders (20). To remove these restrictions, you'll need to have a **valid license**. + +## How does it work? + +Licenses are sold per backoffice domain and will also work on all subdomains. If you have alternative staging/qa environment domains, additional domains can be added to the license on request. + +{% hint style="info" %} +The licenses are not bound to a specific product version. They will work for all versions of the related product. +{% endhint %} + +Let's say that you have a license configured for your domain, `mysite.com`, and you've requested two development domains, `devdomain.com` and `devdomain2.com`. + +The license will cover the following domains: + +* `localhost` +* `*.local` +* `*.mysite.com` +* `www.mysite.com` +* `devdomain.com` +* `www.devdomain.com` +* `devdomain2.com` +* `www.devdomain2.com` + +{% hint style="info" %} +You can have only 1 license per Umbraco installation. +{% endhint %} + +## What does a license cover? + +There are a few differences as to what the licenses cover: + +* A single license covers the installation of Umbraco Commerce in 1 production backoffice domain, as well as in any requested development domains. +* The production domain includes **all subdomains** (e.g. `*.mysite.com`). +* The development domains work with or without the `www` subdomain. +* The license allows for an unlimited number of orders. +* The license also includes `localhost` and `*.local` as a valid domain. + +{% hint style="info" %} +If you have multiple backoffice domains pointing at the same installation, you have the option to purchase and [add **additional domains**](licensing-model.md#add-additional-domains) to your license. + +This is an add-on domain for existing licenses. Refunds will not be given for this product. +{% endhint %} + +## Configuring your license + +You can purchase a license via the [Umbraco Commerce](https://umbraco.com/products/umbraco-commerce/) project page. A member of the [SUITS team](mailto:suits@umbraco.com) will manage this process. In the process, you will need to provide all domains you wish to have covered by the license such as primary and staging/qa domains. You should then receive a license code to be installed in your solution. + +### Add additional domains + +If you require to add addition domains to the license, please reach out to a member of the [SUITS team](mailto:suits@umbraco.com) with your request and they will manage this process. + +## Installing your license + +Once you have received your license code it needs to be installed on your site. + +1. Open the root directory for your project files. +2. Locate and open the `appSettings.json` file. +3. Add your Umbraco Commerce license key to `Umbraco:Licenses:Umbraco.Commerce`: + +```json +"Umbraco": { + "Licenses": { + "Umbraco.Commerce": "YOUR_LICENSE_KEY" + } +} +``` + +### Verify the license installation + +You can verify that your license is successfully installed by logging into your project's backoffice and navigating to the settings section. Here you will see a licenses dashboard which should display the status of your license. + +![Umbraco Commerce License Dashboard](../media/license-dashboard.png) + +### When and how to configure an `UmbracoApplicationUrl` + +If you are running on a single domain for both your frontend and backend environments, it's not necessary to configure a `UmbracoApplicationUrl`. + +If you have different domains for your frontend and backend, then it's advised that you configure an `UmbracoApplicationUrl` set to your backoffice URL. This helps the licensing engine know which URL should be used for validation checks. Without this configuration setting, the licensing engine will try and work out the domain to validate from the HTTP request object. This can lead to errors when switching between domains. + + +An `UmbracoApplicationUrl` can be configured in your `appSettings.json` file like so: + +```json +{ + "Umbraco": { + "CMS": { + "WebRouting": { + "UmbracoApplicationUrl": "https://admin.my-custom-domain.com/" + } + } + } +} +``` + +See the [Fixed Application URL](https://docs.umbraco.com/umbraco-cms/extending/health-check/guides/fixedapplicationurl) documentation for more details about this setting. + +#### Configuring `UmbracoApplicationUrl` on Umbraco Cloud + +If you are hosting on Umbraco Cloud you will find the configuration described above won't be reflected in your environment. The reason for this is that Umbraco Cloud sets this value as an environment variable set to the Cloud project domain (`.umbraco.io`). This overrides what is set via the `appSettings.json` file. + +There are two options in this case: +- Either the domains for each of your Cloud environments can be added to your license. +- Or, for more control and to ensure this value is set correctly for other reasons, you can apply the configuration via code. + +For example, in your `Startup.cs` file, you can add the following to the `ConfigureServices` method: + +```csharp +services.Configure(o => o.UmbracoApplicationUrl = ""); +``` + +In practice, you will probably want to make this a bit more sophisticated. You can read the value from another configuration key, removing the need to hard-code it and have it set as appropriate in different environments. You can also move this code into a composer or an extension method if you prefer not to clutter up the `Startup.ConfigureServices` method. + + diff --git a/12/umbraco-commerce/release-notes.md b/12/umbraco-commerce/release-notes.md index c4d64ffb291..7af84e53cab 100644 --- a/12/umbraco-commerce/release-notes.md +++ b/12/umbraco-commerce/release-notes.md @@ -1,17 +1,16 @@ --- description: >- - Get an overview of the things changed and fixed in each version of Umbraco - Commerce. + Get an overview of the things changed and fixed in each version of Umbraco Commerce. --- # Release Notes -In this section, we have summarized the changes to Umbraco Commerce released in each version. Each version is presented with a link to the[ Commerce issue tracker](https://github.com/umbraco/Umbraco.Commerce.Issues/issues) showing a list of issues resolved in the release. We also link to the individual issues themselves from the detail. +In this section, we have summarized the changes to Umbraco Commerce released in each version. Each version is presented with a link to the [Commerce issue tracker](https://github.com/umbraco/Umbraco.Commerce.Issues/issues) showing a list of issues resolved in the release. We also link to the individual issues themselves from the detail. If there are any breaking changes or other issues to be aware of when upgrading they are also noted here. {% hint style="info" %} -If you are upgrading to a new major version, check the breaking changes in the [Version Specific Upgrade Notes](getting-started/upgrading/version-specific-upgrades.md) article. +If you are upgrading to a new major version, check the breaking changes in the [Version Specific Upgrade Notes](./upgrading/version-specific-upgrades.md) article. {% endhint %} ## Release History @@ -59,4 +58,4 @@ This section contains the release notes for Umbraco Commerce 12 including all ch ## Legacy release notes -You can find the release notes for **Vendr** in the[ ](https://github.com/umbraco/UmbracoDocs/blob/umbraco-eol-versions/11/umbraco-workflow/release-notes.md)[Change log file on Github](../../13/umbraco-commerce/changelog-archive/Vendr-core.md). +You can find the release notes for **Vendr** in the [Change log file on Github](../../13/umbraco-commerce/changelog-archive/Vendr-core.md). diff --git a/12/umbraco-commerce/how-to-guides/migrate-from-vendr-to-umbraco-commerce/README.md b/12/umbraco-commerce/upgrading/migrate-from-vendr-to-umbraco-commerce/README.md similarity index 100% rename from 12/umbraco-commerce/how-to-guides/migrate-from-vendr-to-umbraco-commerce/README.md rename to 12/umbraco-commerce/upgrading/migrate-from-vendr-to-umbraco-commerce/README.md diff --git a/12/umbraco-commerce/how-to-guides/migrate-from-vendr-to-umbraco-commerce/migrate-custom-payment-providers.md b/12/umbraco-commerce/upgrading/migrate-from-vendr-to-umbraco-commerce/migrate-custom-payment-providers.md similarity index 100% rename from 12/umbraco-commerce/how-to-guides/migrate-from-vendr-to-umbraco-commerce/migrate-custom-payment-providers.md rename to 12/umbraco-commerce/upgrading/migrate-from-vendr-to-umbraco-commerce/migrate-custom-payment-providers.md diff --git a/12/umbraco-commerce/how-to-guides/migrate-from-vendr-to-umbraco-commerce/migrate-umbraco-commerce-checkout.md b/12/umbraco-commerce/upgrading/migrate-from-vendr-to-umbraco-commerce/migrate-umbraco-commerce-checkout.md similarity index 100% rename from 12/umbraco-commerce/how-to-guides/migrate-from-vendr-to-umbraco-commerce/migrate-umbraco-commerce-checkout.md rename to 12/umbraco-commerce/upgrading/migrate-from-vendr-to-umbraco-commerce/migrate-umbraco-commerce-checkout.md diff --git a/12/umbraco-commerce/getting-started/upgrading.md b/12/umbraco-commerce/upgrading/upgrade.md similarity index 94% rename from 12/umbraco-commerce/getting-started/upgrading.md rename to 12/umbraco-commerce/upgrading/upgrade.md index 0ca5ac26f00..bb863536438 100644 --- a/12/umbraco-commerce/getting-started/upgrading.md +++ b/12/umbraco-commerce/upgrading/upgrade.md @@ -1,7 +1,7 @@ # Upgrading Umbraco Commerce This article shows how to manually upgrade Umbraco Commerce to run the latest version. -When upgrading Umbraco Commerce, be sure to also consult the [version specific upgrade](/12/umbraco-commerce/getting-started/upgrading/version-specific-upgrades.md) notes to learn about potential breaking changes and common pitfalls. +When upgrading Umbraco Commerce, be sure to also consult the [version specific upgrade](../upgrading/version-specific-upgrades.md) notes to learn about potential breaking changes and common pitfalls. {% hint style="warning" %} Before upgrading, it is always advisable to take a complete backup of your site and database. diff --git a/12/umbraco-commerce/getting-started/upgrading/version-specific-upgrades.md b/12/umbraco-commerce/upgrading/version-specific-upgrades.md similarity index 80% rename from 12/umbraco-commerce/getting-started/upgrading/version-specific-upgrades.md rename to 12/umbraco-commerce/upgrading/version-specific-upgrades.md index aaf896dc50d..7c5479cabde 100644 --- a/12/umbraco-commerce/getting-started/upgrading/version-specific-upgrades.md +++ b/12/umbraco-commerce/upgrading/version-specific-upgrades.md @@ -1,7 +1,6 @@ --- description: >- - Version specific documentation for upgrading to new major versions of Umbraco - Commerce. + Version specific documentation for upgrading to new major versions of Umbraco Commerce. --- # Version Specific Upgrade Notes @@ -9,14 +8,14 @@ description: >- This page covers specific upgrade documentation for when migrating to major 12 of Umbraco Commerce. {% hint style="info" %} -If you are upgrading to a new minor or patch version, you can find information about the breaking changes in the [Release Notes](../../release-notes.md) article. +If you are upgrading to a new minor or patch version, you can find information about the breaking changes in the [Release Notes](../release-notes.md) article. {% endhint %} ## Version Specific Upgrade Notes History Version 12 is the initial release of the Umbraco Commerce product. It contains a number of breaking changes from the previous, Vendr product. -See the [Migrate from Vendr to Umbraco Commerce guide](../../how-to-guides/migrate-from-vendr-to-umbraco-commerce/) for full details. +See the [Migrate from Vendr to Umbraco Commerce guide](./migrate-from-vendr-to-umbraco-commerce/README.md) for full details. ## Legacy version specific upgrade notes diff --git a/12/umbraco-deploy/.gitbook.yaml b/12/umbraco-deploy/.gitbook.yaml index 23bf7fe2b46..6cf1ef0fed7 100644 --- a/12/umbraco-deploy/.gitbook.yaml +++ b/12/umbraco-deploy/.gitbook.yaml @@ -1,16 +1,14 @@ root: ./ -​structure: +​structure: readme: README.md summary: SUMMARY.md -installing-deploy/installing-deploy: getting-started/install-configure.md -installing-deploy/install-configure: getting-started-install-configure.md -installing-deploy/install-configure/existing-site: getting-started/install-configure.md -installing-deploy/install-configure/new-site: getting-started/install-configure.md -installing-deploy/cicd-pipeline: getting-started/cicd-pipeline/README.md -installing-deploy/cicd-pipeline/ci-cd-azure-dev-ops: getting-started/cicd-pipeline/ci-cd-azure-dev-ops.md -installing-deploy/cicd-pipeline/ci-cd-github-actions: getting-started/cicd-pipeline/ci-cd-github-actions.md -installing-deploy/streamlining-local-development: getting-started/streamlining-local-development - - +redirects: +getting-started/install-configure: installation/install-configure.md +the-licensing-model: installation/the-licensing-model.md +deploy-settings: getting-started/deploy-settings.md +extending: getting-started/extending.md +get-started-with-deploy: getting-started/get-started-with-deploy.md +handling-cache-refresher-notifications: getting-started/handling-cache-refresher-notifications.md +troubleshooting: getting-started/troubleshooting.md diff --git a/12/umbraco-deploy/README.md b/12/umbraco-deploy/README.md index 16fb499807f..1d587e5cf1e 100644 --- a/12/umbraco-deploy/README.md +++ b/12/umbraco-deploy/README.md @@ -6,22 +6,22 @@ description: Documentation on how to work with Umbraco Deploy. Umbraco Deploy is a deployment tool that helps you with the process of transferring code and data between multiple environments. Deploy can be configured for many different setups and is great for both small setups as well as large and more complex infrastructures. -
Set up Umbraco DeployLearn how you can set up Umbraco Deploy on new and existing Umbraco projects.update.pnginstall-configure.md
Deployment workflow inLearn about how the Deployment workflow in Umbraco Deploy work.lightbulb.pngdeployment-workflow
UpgradingLearn how you can upgrade Umbraco Deploy.code_cursor.pngupgrades
+
Set up Umbraco DeployLearn how you can set up Umbraco Deploy on new and existing Umbraco projects.update.pnginstall-configure.md
Deployment workflow inLearn about how the Deployment workflow in Umbraco Deploy work.lightbulb.pngdeployment-workflow
UpgradingLearn how you can upgrade Umbraco Deploy.code_cursor.pngupgrades
{% embed url="https://www.youtube-nocookie.com/embed/Fqfc-UL4q5U" %} Umbraco Deploy Overview {% endembed %} -{% content-ref url="deploy-settings.md" %} -[deploy-settings.md](deploy-settings.md) +{% content-ref url="getting-started/deploy-settings.md" %} +[deploy-settings.md](getting-started/deploy-settings.md) {% endcontent-ref %} -{% content-ref url="extending.md" %} -[extending.md](extending.md) +{% content-ref url="getting-started/extending.md" %} +[extending.md](getting-started/extending.md) {% endcontent-ref %} -{% content-ref url="troubleshooting.md" %} -[troubleshooting.md](troubleshooting.md) +{% content-ref url="getting-started/troubleshooting.md" %} +[troubleshooting.md](getting-started/troubleshooting.md) {% endcontent-ref %} Umbraco Deploy is also the engine that runs behind the scenes on [Umbraco Cloud](https://docs.umbraco.com/umbraco-cloud/). Here it takes care of all the deployment processes of both code, schema and content on projects. diff --git a/12/umbraco-deploy/SUMMARY.md b/12/umbraco-deploy/SUMMARY.md index 3b9d0de5549..55424c806fa 100644 --- a/12/umbraco-deploy/SUMMARY.md +++ b/12/umbraco-deploy/SUMMARY.md @@ -1,22 +1,30 @@ # Table of contents -* [What is Umbraco Deploy?](README.md) +* [Umbraco Deploy Documentation](README.md) * [Legacy Documentation](legacy-documentation.md) * [Release notes](release-notes.md) -* [Getting started](get-started-with-deploy.md) -* [Configuration](deploy-settings.md) -* [Extending](extending.md) -* [Handling Cache Refresher Notifications](handling-cache-refresher-notifications.md) -* [Troubleshooting](troubleshooting.md) -* [Licensing](the-licensing-model.md) + +## Installation + +* [Installing Umbraco Deploy](installation/install-configure.md) +* [Licensing](installation/the-licensing-model.md) + +## Upgrading + +* [Upgrading Umbraco Deploy](upgrades/README.md) +* [Version Specific Upgrade Details](upgrades/version-specific.md) ## Getting Started -* [Setting up Umbraco Deploy](getting-started/install-configure.md) +* [Getting started](getting-started/get-started-with-deploy.md) * [CI/CD Build and Deployment Pipeline](getting-started/cicd-pipeline/README.md) * [Azure DevOps](getting-started/cicd-pipeline/ci-cd-azure-dev-ops.md) * [Github actions](getting-started/cicd-pipeline/ci-cd-github-actions.md) * [Streamlining Local Development](getting-started/streamlining-local-development.md) +* [Configuration](getting-started/deploy-settings.md) +* [Extending](getting-started/extending.md) +* [Handling Cache Refresher Notifications](getting-started/handling-cache-refresher-notifications.md) +* [Troubleshooting](getting-started/troubleshooting.md) ## Deployment Workflow @@ -28,8 +36,3 @@ * [Restoring content](deployment-workflow/restoring-content/README.md) * [Partial Restores](deployment-workflow/restoring-content/partial-restore.md) * [Deploy Dashboard](deployment-workflow/deploy-dashboard.md) - -## Upgrading - -* [Upgrading](upgrades/README.md) -* [Version Specific Upgrade Details](upgrades/version-specific.md) diff --git a/12/umbraco-deploy/deployment-workflow/content-transfer.md b/12/umbraco-deploy/deployment-workflow/content-transfer.md index f969e74d35f..a1b476ae9e4 100644 --- a/12/umbraco-deploy/deployment-workflow/content-transfer.md +++ b/12/umbraco-deploy/deployment-workflow/content-transfer.md @@ -51,7 +51,7 @@ Media items are transferred the same way as content: ### Umbraco Forms -In order for Deploy to handle Forms data as content, you will need to ensure that the `transferFormsAsContent` setting in configuration is set to `true`. See details in the [Deploy Settings for Umbraco 9](../deploy-settings.md) article. +In order for Deploy to handle Forms data as content, you will need to ensure that the `transferFormsAsContent` setting in configuration is set to `true`. See details in the [Deploy Settings for Umbraco 9+](../getting-started/deploy-settings.md) article. Once the setting have been added to the source and target environment forms can be transferred the same way as content and media: @@ -69,4 +69,4 @@ Sometimes a content transfer might not be possible. For example if you add a new ![clone dialog](<../../../10/umbraco-deploy/deployment-workflow/images/schema-mismatch (1).png>) -If you are seeing this type of issue when trying to transfer content, head over to our article about [Schema Mismatch errors](../troubleshooting.md), where you can read about how to resolve the issues. +If you are seeing this type of issue when trying to transfer content, head over to our article about [Schema Mismatch errors](../getting-started/troubleshooting.md), where you can read about how to resolve the issues. diff --git a/12/umbraco-deploy/deployment-workflow/deploy-dashboard.md b/12/umbraco-deploy/deployment-workflow/deploy-dashboard.md index c8002633f14..3f5c336775a 100644 --- a/12/umbraco-deploy/deployment-workflow/deploy-dashboard.md +++ b/12/umbraco-deploy/deployment-workflow/deploy-dashboard.md @@ -48,7 +48,7 @@ This operation is useful if you want to move to another Umbraco instance and mig ## Configuration Details -In the Configuration details, you can see how Umbraco Deploy has been [configured](../deploy-settings.md) on your environment. You get an overview of the Setting options, the current value(s), and notes help you understand each of the settings. Updates to the need to be applied in the `appsettings.json` file. +In the Configuration details, you can see how Umbraco Deploy has been [configured](../getting-started/deploy-settings.md) on your environment. You get an overview of the Setting options, the current value(s), and notes help you understand each of the settings. Updates to the need to be applied in the `appsettings.json` file.

Example of Umbraco Deploy configuration.

diff --git a/12/umbraco-deploy/deployment-workflow/deploying-deletions.md b/12/umbraco-deploy/deployment-workflow/deploying-deletions.md index eb4d8b08c5c..0e55c603a25 100644 --- a/12/umbraco-deploy/deployment-workflow/deploying-deletions.md +++ b/12/umbraco-deploy/deployment-workflow/deploying-deletions.md @@ -10,7 +10,7 @@ In this article you can read about the correct way of deleting files, schema and When you are using Umbraco Deploy, you might have more than one environment - including a local clone of the project. These environments each have their own database. The databases will contain references to all of your content and media, as well as to all of your schema files (e.g. Document Types, Templates etc). -The databases are environment specific. When you deploy from one environment to another, Umbraco Deploy will compare incoming schema files with references to these in the databases using both _alias_ and _GUID_. If something doesn't add up - e.g. there is a mismatch between the database references and the files deployed - you will see an error. Learn more about this in the [Troubleshooting section](../troubleshooting.md). +The databases are environment specific. When you deploy from one environment to another, Umbraco Deploy will compare incoming schema files with references to these in the databases using both _alias_ and _GUID_. If something doesn't add up - e.g. there is a mismatch between the database references and the files deployed - you will see an error. Learn more about this in the [Troubleshooting section](../getting-started/troubleshooting.md). The workflow described above does not pick up deletions of content and schema from the database, which is why you'll need to delete the content and/or schema on all your environments, in order to fully complete the deletion. diff --git a/12/umbraco-deploy/deploy-settings.md b/12/umbraco-deploy/getting-started/deploy-settings.md similarity index 100% rename from 12/umbraco-deploy/deploy-settings.md rename to 12/umbraco-deploy/getting-started/deploy-settings.md diff --git a/12/umbraco-deploy/extending.md b/12/umbraco-deploy/getting-started/extending.md similarity index 100% rename from 12/umbraco-deploy/extending.md rename to 12/umbraco-deploy/getting-started/extending.md diff --git a/12/umbraco-deploy/get-started-with-deploy.md b/12/umbraco-deploy/getting-started/get-started-with-deploy.md similarity index 84% rename from 12/umbraco-deploy/get-started-with-deploy.md rename to 12/umbraco-deploy/getting-started/get-started-with-deploy.md index 0d9fdaccf79..ce2d6c11842 100644 --- a/12/umbraco-deploy/get-started-with-deploy.md +++ b/12/umbraco-deploy/getting-started/get-started-with-deploy.md @@ -16,15 +16,15 @@ For example, when working locally you might create a new Document Type. This wil When you want this deployed to your next environment, you would trigger your CI/CD process (for example Azure DevOps or Github Actions). This will push the changes to your environment. Once the build deployment completes successfully, a Deployment Trigger would be executed as an HTTPS request to your target environment. All changes found in the `umbraco/Deploy/Revision` folder will then be extracted into the Umbraco target environment. -![Deploy workflow](../../10/umbraco-deploy/images/Deploy\_concept.png) +![Deploy workflow](../images/Deploy_concept.png) -## [Quick start (new sites)](getting-started/install-configure.md) +## [Quick start (new sites)](../installation/install-configure.md) There are three main steps you need to go through in order to start using Umbraco Deploy on your website. -1. [Set up Git repository and new Umbraco project](getting-started/install-configure.md#prerequisites) +1. [Set up Git repository and new Umbraco project](../installation/install-configure.md#prerequisites) * Set up a repository and then install a new Umbraco project inside it. -2. [Install Umbraco Deploy via NuGet](getting-started/install-configure.md#installing-and-configuring-umbraco-deploy) +2. [Install Umbraco Deploy via NuGet](../installation/install-configure.md#installing-and-configuring-umbraco-deploy) * Umbraco Deploy can be installed via NuGet. -3. [Configure CI/CD build server](getting-started/cicd-pipeline/README.md) +3. [Configure CI/CD build server](../getting-started/cicd-pipeline/README.md) * Umbraco Deploy needs a CI/CD build server needs to be set up to run when you want changes to be deployed to next upstream environment \ No newline at end of file diff --git a/12/umbraco-deploy/handling-cache-refresher-notifications.md b/12/umbraco-deploy/getting-started/handling-cache-refresher-notifications.md similarity index 100% rename from 12/umbraco-deploy/handling-cache-refresher-notifications.md rename to 12/umbraco-deploy/getting-started/handling-cache-refresher-notifications.md diff --git a/12/umbraco-deploy/troubleshooting.md b/12/umbraco-deploy/getting-started/troubleshooting.md similarity index 99% rename from 12/umbraco-deploy/troubleshooting.md rename to 12/umbraco-deploy/getting-started/troubleshooting.md index 13937712ca1..b4d9f24b212 100644 --- a/12/umbraco-deploy/troubleshooting.md +++ b/12/umbraco-deploy/getting-started/troubleshooting.md @@ -18,7 +18,7 @@ If having resolved schema mismatches you still have reports of errors, it might This should not be necessary in normal use, but can occur after upgrades. If you have this situation, you can clear the cached signatures in both the upstream and downstream environments. You do this via the _Clear Cached Signatures_ operation available on the _Settings > Deploy_ dashboard: -![Clear cached signatures](../../12/umbraco-deploy/images/clear-cached-sigs.png) +![Clear cached signatures](../images/clear-cached-sigs.png) ## Slow responses or timeouts when restoring or transferring diff --git a/12/umbraco-deploy/getting-started/install-configure.md b/12/umbraco-deploy/installation/install-configure.md similarity index 99% rename from 12/umbraco-deploy/getting-started/install-configure.md rename to 12/umbraco-deploy/installation/install-configure.md index 28ec99faafc..cf1b3be3983 100644 --- a/12/umbraco-deploy/getting-started/install-configure.md +++ b/12/umbraco-deploy/installation/install-configure.md @@ -294,4 +294,4 @@ For example, in `appsettings.json`: Umbraco Cloud projects use a license file placed in the `/umbraco/Licenses` folder that is provided when your project is created. -Read more about the [Umbraco Deploy licensing model](../the-licensing-model.md). +Read more about the [Umbraco Deploy licensing model](the-licensing-model.md). diff --git a/12/umbraco-deploy/the-licensing-model.md b/12/umbraco-deploy/installation/the-licensing-model.md similarity index 100% rename from 12/umbraco-deploy/the-licensing-model.md rename to 12/umbraco-deploy/installation/the-licensing-model.md diff --git a/12/umbraco-deploy/release-notes.md b/12/umbraco-deploy/release-notes.md index af2b899b5d1..10c39b6ed24 100644 --- a/12/umbraco-deploy/release-notes.md +++ b/12/umbraco-deploy/release-notes.md @@ -1,7 +1,6 @@ --- description: >- - Get an overview of the things changed and fixed in each version of Umbraco - Forms. + Get an overview of the things changed and fixed in each version of Umbraco Deploy. --- # Release notes @@ -42,8 +41,8 @@ This section contains the release notes for Umbraco Deploy 12 including all chan #### [**12.1.0-rc1**](https://github.com/umbraco/Umbraco.Deploy.Issues/issues?q=is%3Aissue+is%3Aclosed+label%3Arelease%2F12.1.0) **(November 27th 2023)** * Added feature of [content import and export with migrations](deployment-workflow/import-export.md). -* Added a new configuration option of `ResolveUserInTargetEnvironment` to allow resolving of user accounts in target environments (see [Deploy Settings](deploy-settings.md)). -* Added a new configuration option of `AllowPublicAccessDeploymentOperations` to amend the behavior of public access rule transfer (see [Deploy Settings](deploy-settings.md)). +* Added a new configuration option of `ResolveUserInTargetEnvironment` to allow resolving of user accounts in target environments (see [Deploy Settings](getting-started/deploy-settings.md)). +* Added a new configuration option of `AllowPublicAccessDeploymentOperations` to amend the behavior of public access rule transfer (see [Deploy Settings](getting-started/deploy-settings.md)). * Improve performance of publishing multi-language content during restore/transfer and import. #### [**12.0.5**](https://github.com/umbraco/Umbraco.Deploy.Issues/issues?q=is%3Aissue+is%3Aclosed+label%3Arelease%2F12.0.5) (**November 14th 2023**) @@ -91,4 +90,4 @@ This section contains the release notes for Umbraco Deploy 12 including all chan ## Legacy release notes -You can find the release notes for versions out of support in the [Legacy documentation release notes ](https://github.com/umbraco/UmbracoDocs/blob/umbraco-eol-versions/11/umbraco-deploy/release-notes.md)and[ Umbraco Deploy Package page.](https://our.umbraco.com/packages/developer-tools/umbraco-deploy/) +You can find the release notes for versions out of support in the [Legacy documentation on Github](https://github.com/umbraco/UmbracoDocs/blob/umbraco-eol-versions/11/umbraco-deploy/release-notes.md) and [Umbraco Deploy Package page.](https://our.umbraco.com/packages/developer-tools/umbraco-deploy/) diff --git a/12/umbraco-deploy/upgrades/version-specific.md b/12/umbraco-deploy/upgrades/version-specific.md index bc6bb5c9dc1..ad18ce7033b 100644 --- a/12/umbraco-deploy/upgrades/version-specific.md +++ b/12/umbraco-deploy/upgrades/version-specific.md @@ -1,7 +1,6 @@ --- description: >- - Version specific documentation for upgrading to new major versions of Umbraco - Deploy. + Version specific documentation for upgrading to new major versions of Umbraco Deploy. --- # Version Specific Upgrade Details diff --git a/12/umbraco-forms/.gitbook.yaml b/12/umbraco-forms/.gitbook.yaml index 7c297ab019d..8865254d413 100644 --- a/12/umbraco-forms/.gitbook.yaml +++ b/12/umbraco-forms/.gitbook.yaml @@ -1,8 +1,10 @@ root: ./ -​structure: +​structure: readme: README.md summary: SUMMARY.md redirects: - installation/upgrade: installation/manualupgrade + the-licensing-model: installation/the-licensing-model.md + installation/manualupgrade: upgrading/manualupgrade.md + installation/version-specific: upgrading/version-specific.md diff --git a/12/umbraco-forms/README.md b/12/umbraco-forms/README.md index 18aebf3b8d2..35bfaee08a1 100644 --- a/12/umbraco-forms/README.md +++ b/12/umbraco-forms/README.md @@ -16,8 +16,8 @@ Umbraco Forms is a tool that lets you build forms of all shapes and sizes and pu ## Quick Links -{% content-ref url="installation/manualupgrade.md" %} -[manualupgrade.md](installation/manualupgrade.md) +{% content-ref url="upgrading/manualupgrade.md" %} +[manualupgrade.md](upgrading/manualupgrade.md) {% endcontent-ref %} {% content-ref url="editor/attaching-workflows/" %} diff --git a/12/umbraco-forms/SUMMARY.md b/12/umbraco-forms/SUMMARY.md index a9491a1b01c..fc9116a9ccb 100644 --- a/12/umbraco-forms/SUMMARY.md +++ b/12/umbraco-forms/SUMMARY.md @@ -7,9 +7,12 @@ ## Installation * [Installing Umbraco Forms](installation/install.md) -* [Manually Upgrading Umbraco Forms](installation/manualupgrade.md) -* [Version Specific Upgrade Notes](installation/version-specific.md) -* [Licensing](the-licensing-model.md) +* [Licensing](installation/the-licensing-model.md) + +## Upgrading + +* [Upgrading Umbraco Forms](upgrading/manualupgrade.md) +* [Version Specific Upgrade Notes](upgrading/version-specific.md) ## Editor diff --git a/12/umbraco-forms/developer/extending/adding-a-fieldtype.md b/12/umbraco-forms/developer/extending/adding-a-fieldtype.md index f4c0e654819..2f5696fa683 100644 --- a/12/umbraco-forms/developer/extending/adding-a-fieldtype.md +++ b/12/umbraco-forms/developer/extending/adding-a-fieldtype.md @@ -105,7 +105,7 @@ This will be rendered when the default theme is used. If working with Umbraco 9 or earlier versions, you'll find the `Views\Partials\Forms\Themes\default\` folder on disk and can create the files there. -For Umbraco 10 and above, we've moved to [distributing the theme as part of a Razor Class Library](../../installation/version-specific.md#views-and-client-side-files) so the folder won't exist. However, you can create it for your custom field type. If you would like to reference the partial views of the default theme, you can download them as mentioned in the [Themes](../themes.md) article. +For Umbraco 10 and above, we've moved to [distributing the theme as part of a Razor Class Library](../../upgrading/version-specific.md#views-and-client-side-files) so the folder won't exist. However, you can create it for your custom field type. If you would like to reference the partial views of the default theme, you can download them as mentioned in the [Themes](../themes.md) article. ## Umbraco backoffice view diff --git a/12/umbraco-forms/the-licensing-model.md b/12/umbraco-forms/installation/the-licensing-model.md similarity index 100% rename from 12/umbraco-forms/the-licensing-model.md rename to 12/umbraco-forms/installation/the-licensing-model.md diff --git a/12/umbraco-forms/release-notes.md b/12/umbraco-forms/release-notes.md index b8e2bff97e5..69f72e4dc16 100644 --- a/12/umbraco-forms/release-notes.md +++ b/12/umbraco-forms/release-notes.md @@ -1,7 +1,6 @@ --- description: >- - Get an overview of the things changed and fixed in each version of Umbraco - Forms. + Get an overview of the things changed and fixed in each version of Umbraco Forms. --- # Release Notes @@ -11,7 +10,7 @@ In this section, we have summarized the changes to Umbraco Forms released in eac If there are any breaking changes or other issues to be aware of when upgrading they are also noted here. {% hint style="info" %} -If you are upgrading to a new major version, you can find information about the breaking changes in the [Version Specific Upgrade Notes](installation/version-specific.md) article +If you are upgrading to a new major version, you can find information about the breaking changes in the [Version Specific Upgrade Notes](./upgrading/version-specific.md) article {% endhint %} ## Release History @@ -103,8 +102,8 @@ This section contains the release notes for Umbraco Forms 12 including all chang #### [**12.0.0**](https://github.com/umbraco/Umbraco.Forms.Issues/issues?q=is%3Aissue+is%3Aclosed+label%3Arelease%2F12.0.0) * Compatibility with Umbraco 12 - * See full details of breaking changes under the [version specific upgrade guide](installation/version-specific.md#version-12). + * See full details of breaking changes under the [version specific upgrade guide](upgrading/version-specific.md#version-12). ## Legacy release notes -You can find the release notes for versions out of support in the [Legacy documentation release notes](https://github.com/umbraco/UmbracoDocs/blob/umbraco-eol-versions/11/umbraco-forms/release-notes.md) and [Umbraco Forms Package page](https://our.umbraco.com/packages/developer-tools/umbraco-forms/). +You can find the release notes for versions out of support in the [Legacy documentation on Github](https://github.com/umbraco/UmbracoDocs/blob/umbraco-eol-versions/11/umbraco-forms/release-notes.md) and [Umbraco Forms Package page](https://our.umbraco.com/packages/developer-tools/umbraco-forms/). diff --git a/12/umbraco-forms/installation/manualupgrade.md b/12/umbraco-forms/upgrading/manualupgrade.md similarity index 93% rename from 12/umbraco-forms/installation/manualupgrade.md rename to 12/umbraco-forms/upgrading/manualupgrade.md index ced52a93194..0f0701c1f5a 100644 --- a/12/umbraco-forms/installation/manualupgrade.md +++ b/12/umbraco-forms/upgrading/manualupgrade.md @@ -22,7 +22,7 @@ To get the latest version of Umbraco Forms, you can upgrade using: 2. Select **Umbraco.Forms**. 3. Select the latest version from the **Version** drop-down and click **Install**. -![NuGet Package Manager](../../../10/umbraco-forms/installation/images/Manage\_packages\_v10.png) +![NuGet Package Manager](../installation/images/Manage_packages_v10.png) 4. When the command completes, open the **.csproj** file to make sure the package reference is updated: diff --git a/12/umbraco-forms/installation/version-specific.md b/12/umbraco-forms/upgrading/version-specific.md similarity index 100% rename from 12/umbraco-forms/installation/version-specific.md rename to 12/umbraco-forms/upgrading/version-specific.md diff --git a/12/umbraco-ui-builder/.gitbook.yaml b/12/umbraco-ui-builder/.gitbook.yaml index 5f8a5d6585b..83e70191059 100644 --- a/12/umbraco-ui-builder/.gitbook.yaml +++ b/12/umbraco-ui-builder/.gitbook.yaml @@ -1,7 +1,12 @@ root: ./ ​structure: - readme: README.md - summary: SUMMARY.md + readme: README.md + summary: SUMMARY.md redirects: +getting-started/upgrading/README: upgrading/upgrade.md +getting-started/upgrading/version-specific-upgrades: upgrading/version-specific.md +getting-started/installation: installation/installation.md +getting-started/licensing-model: installation/licensing-model.md +guides/migrating-from-konstrukt-to-umbraco-ui-builder: upgrading/migrating-from-konstrukt-to-umbraco-ui-builder.md diff --git a/12/umbraco-ui-builder/SUMMARY.md b/12/umbraco-ui-builder/SUMMARY.md index 03655486228..e28f1cfc113 100644 --- a/12/umbraco-ui-builder/SUMMARY.md +++ b/12/umbraco-ui-builder/SUMMARY.md @@ -4,20 +4,26 @@ * [Known Issues](known-issues.md) * [Release Notes](release-notes.md) +## Installation + +* [Installing Umbraco UI Builder](installation/installation.md) +* [Licensing](installation/licensing-model.md) + +## Upgrading + +* [Upgrading Umbraco UI Builder](upgrading/upgrade.md) +* [Version Specific Upgrade Notes](upgrading/version-specific.md) +* [Migrate from Konstrukt to Umbraco UI Builder](upgrading/migrating-from-konstrukt-to-umbraco-ui-builder.md) + ## Getting Started * [Overview](getting-started/overview.md) -* [Installation](getting-started/installation.md) -* [Upgrading](getting-started/upgrading/README.md) - * [Version Specific Upgrade Notes](getting-started/upgrading/version-specific-upgrades.md) * [Configuration](getting-started/configuration.md) * [User Interface](getting-started/user-interface.md) -* [Licensing](getting-started/licensing-model.md) ## How-to Guides * [Creating your first integration](guides/creating-your-first-integration.md) -* [Migrate from Konstrukt to Umbraco UI Builder](guides/migrating-from-konstrukt-to-umbraco-ui-builder.md) ## Areas diff --git a/12/umbraco-ui-builder/getting-started/installation.md b/12/umbraco-ui-builder/installation/installation.md similarity index 100% rename from 12/umbraco-ui-builder/getting-started/installation.md rename to 12/umbraco-ui-builder/installation/installation.md diff --git a/12/umbraco-ui-builder/getting-started/licensing-model.md b/12/umbraco-ui-builder/installation/licensing-model.md similarity index 100% rename from 12/umbraco-ui-builder/getting-started/licensing-model.md rename to 12/umbraco-ui-builder/installation/licensing-model.md diff --git a/12/umbraco-ui-builder/release-notes.md b/12/umbraco-ui-builder/release-notes.md index 4f1cb7c99c2..242c016ac3d 100644 --- a/12/umbraco-ui-builder/release-notes.md +++ b/12/umbraco-ui-builder/release-notes.md @@ -1,3 +1,8 @@ +--- +description: >- + Get an overview of the things changed and fixed in each version of Umbraco UI Builder. +--- + # Release Notes In this section, we have summarized the changes to Umbraco UI Builder released in each version. Each version is presented with a link to the [UI Builder issue tracker](https://github.com/umbraco/Umbraco.UIBuilder.Issues/issues) showing a list of issues resolved in the release. We also link to the individual issues themselves from the detail. @@ -5,7 +10,7 @@ In this section, we have summarized the changes to Umbraco UI Builder released i If there are any breaking changes or other issues to be aware of when upgrading they are also noted here. {% hint style="info" %} -If you are upgrading to a new major version, check the breaking changes in the [Version Specific Upgrade Notes](getting-started/upgrading/version-specific-upgrades.md) article. +If you are upgrading to a new major version, check the breaking changes in the [Version Specific Upgrade Notes](./upgrading/version-specific.md) article. {% endhint %} ## Release History @@ -33,4 +38,4 @@ This section contains the release notes for Umbraco UI Builder 12 including all ## Legacy release notes -You can find the release notes for **Konstrukt** in the[ ](https://github.com/umbraco/UmbracoDocs/blob/umbraco-eol-versions/11/umbraco-workflow/release-notes.md)[Change log file on Github](../../13/umbraco-commerce/changelog-archive/Vendr-core.md). +You can find the release notes for **Konstrukt** in the [Change log file on Github](../../13/umbraco-commerce/changelog-archive/Vendr-core.md). diff --git a/10/umbraco-ui-builder/guides/migrating-from-konstrukt-to-umbraco-ui-builder.md b/12/umbraco-ui-builder/upgrading/migrating-from-konstrukt-to-umbraco-ui-builder.md similarity index 97% rename from 10/umbraco-ui-builder/guides/migrating-from-konstrukt-to-umbraco-ui-builder.md rename to 12/umbraco-ui-builder/upgrading/migrating-from-konstrukt-to-umbraco-ui-builder.md index f5a62bc198a..852ead935e2 100644 --- a/10/umbraco-ui-builder/guides/migrating-from-konstrukt-to-umbraco-ui-builder.md +++ b/12/umbraco-ui-builder/upgrading/migrating-from-konstrukt-to-umbraco-ui-builder.md @@ -1,123 +1,123 @@ ---- -description: Learn how to migrate a Konstrukt solution to Umbraco UI Builder. ---- - -# Migrate from Konstrukt to Umbraco UI Builder - -This guide provides a step-by-step approach to migrating a default Konstrukt solution to Umbraco UI Builder. - -## Key changes - -Before outlining the exact steps, there are a few key changes to be aware of. - -These changes will dictate the steps to take in the process of migrating to Umbraco UI Builder. - -### Project, Package, and Namespace changes - -| Konstrukt | Umbraco UI Builder | -| ------------------------------- | --------------------------------------- | -| Konstrukt.Core | Umbraco.UIBuilder.Core | -| Konstrukt.Infrastructure | Umbraco.UIBuilder.Infrastructure | -| Konstrukt.Web | Umbraco.UIBuilder.Web | -| Konstrukt.Web.UI | Umbraco.UIBuilder.Web.StaticAssets | -| Konstrukt.Startup | Umbraco.UIBuilder.Startup | -| Konstrukt | Umbraco.UIBuilder | - -
- -C# Class changes - -* Namespace changes as documented above. -* Most classes prefixed with the `Konstrukt` keyword have had this prefix removed. - * Examples: `IKonstruktRepository` is now `IRepository` - * Exclusions: The root level `KonstruktConfig` and `KonstruktConfigBuilder` have a `UIBuilder` prefix instead, and the `AddKonstrukt` extension for `IUmbracoBuilder` has been replaced by `AddUIBuilder` - -
- -
- -JavaScript changes - -* All `Konstrukt` controllers have changed namespace to `Umbraco.UIBuilder`. -* All `Konstrukt` prefixed directives, services, and resources are now prefixed with `uibuilder`. - -
- -
- -UI Changes - -* All static UI assets are served via a Razor Compiled Library (RCL) and are no longer found in the `App_Plugins` folder. -* The folder with `App_Plugins` has been renamed from `Konstrukt` to `UmbracoUIBuilder`. - -
- -## Step 1: Replace dependencies - -In this first step, we will be replacing all existing Konstrukt dependencies with Umbraco UI Builder dependencies. - -1. Remove any installed Konstrukt packages: - -```bash -dotnet remove package Konstrukt -``` - -2. Delete the Konstrukt `App_Plugins` folder: - -```bash -rmdir App_Plugins\Konstrukt -``` - -3. Install `Umbraco.UIBuilder`: - -```bash -dotnet add package Umbraco.UIBuilder -``` - -4. Compile your project against .NET 7.0. - -## Step 2: Update namespaces and entity names - -Based on the [Key Changes](./#key-changes) outlined above update all Konstrukt references to the new Umbraco UI Builder alternatives. Ensure you update any Views/Partials that also reference these. - -## Step 3: Update your configuration - -If all your configuration is in a single statement, it would be a case of swapping `AddKonstrukt` to `AddUIBuilder`. If you broke your configuration into multiple steps, or are using `Action` or `Card` classes, you will need to update the config builder/base classes. Those classes need to be updated to their UI Builder alternative names as detailed in [Key Changes](./#key-changes). - - -```csharp -public class Startup -{ - ... - public void ConfigureServices(IServiceCollection services) - { - services.AddUmbraco(_env, _config) - .AddBackOffice() - .AddWebsite() - .AddUIBuilder(cfg => { - // The rest of your configuration - }) - .AddComposers() - .Build(); - } - ... -} - -``` - -## Step 4: Finalizing the migration - -1. Delete any obj/bin folders in your projects to ensure a clean build. -2. Recompile all projects and ensure all dependencies are restored correctly -3. Delete the existing Konstrukt license files in the `umbraco\Licenses` folder. -4. Add your new Umbraco.UIBuilder license key to the `appSettings.json` file: - -```json -"Umbraco": { - "Licenses": { - "Umbraco.UIBuilder": "YOUR_LICENSE_KEY" - } -} -``` - +--- +description: Learn how to migrate a Konstrukt solution to Umbraco UI Builder. +--- + +# Migrate from Konstrukt to Umbraco UI Builder + +This guide provides a step-by-step approach to migrating a default Konstrukt solution to Umbraco UI Builder. + +## Key changes + +Before outlining the exact steps, there are a few key changes to be aware of. + +These changes will dictate the steps to take in the process of migrating to Umbraco UI Builder. + +### Project, Package, and Namespace changes + +| Konstrukt | Umbraco UI Builder | +| ------------------------------- | --------------------------------------- | +| Konstrukt.Core | Umbraco.UIBuilder.Core | +| Konstrukt.Infrastructure | Umbraco.UIBuilder.Infrastructure | +| Konstrukt.Web | Umbraco.UIBuilder.Web | +| Konstrukt.Web.UI | Umbraco.UIBuilder.Web.StaticAssets | +| Konstrukt.Startup | Umbraco.UIBuilder.Startup | +| Konstrukt | Umbraco.UIBuilder | + +
+ +C# Class changes + +* Namespace changes as documented above. +* Most classes prefixed with the `Konstrukt` keyword have had this prefix removed. + * Examples: `IKonstruktRepository` is now `IRepository` + * Exclusions: The root level `KonstruktConfig` and `KonstruktConfigBuilder` have a `UIBuilder` prefix instead, and the `AddKonstrukt` extension for `IUmbracoBuilder` has been replaced by `AddUIBuilder` + +
+ +
+ +JavaScript changes + +* All `Konstrukt` controllers have changed namespace to `Umbraco.UIBuilder`. +* All `Konstrukt` prefixed directives, services, and resources are now prefixed with `uibuilder`. + +
+ +
+ +UI Changes + +* All static UI assets are served via a Razor Compiled Library (RCL) and are no longer found in the `App_Plugins` folder. +* The folder with `App_Plugins` has been renamed from `Konstrukt` to `UmbracoUIBuilder`. + +
+ +## Step 1: Replace dependencies + +In this first step, we will be replacing all existing Konstrukt dependencies with Umbraco UI Builder dependencies. + +1. Remove any installed Konstrukt packages: + +```bash +dotnet remove package Konstrukt +``` + +2. Delete the Konstrukt `App_Plugins` folder: + +```bash +rmdir App_Plugins\Konstrukt +``` + +3. Install `Umbraco.UIBuilder`: + +```bash +dotnet add package Umbraco.UIBuilder +``` + +4. Compile your project against .NET 7.0. + +## Step 2: Update namespaces and entity names + +Based on the [Key Changes](./#key-changes) outlined above update all Konstrukt references to the new Umbraco UI Builder alternatives. Ensure you update any Views/Partials that also reference these. + +## Step 3: Update your configuration + +If all your configuration is in a single statement, it would be a case of swapping `AddKonstrukt` to `AddUIBuilder`. If you broke your configuration into multiple steps, or are using `Action` or `Card` classes, you will need to update the config builder/base classes. Those classes need to be updated to their UI Builder alternative names as detailed in [Key Changes](./#key-changes). + + +```csharp +public class Startup +{ + ... + public void ConfigureServices(IServiceCollection services) + { + services.AddUmbraco(_env, _config) + .AddBackOffice() + .AddWebsite() + .AddUIBuilder(cfg => { + // The rest of your configuration + }) + .AddComposers() + .Build(); + } + ... +} + +``` + +## Step 4: Finalizing the migration + +1. Delete any obj/bin folders in your projects to ensure a clean build. +2. Recompile all projects and ensure all dependencies are restored correctly +3. Delete the existing Konstrukt license files in the `umbraco\Licenses` folder. +4. Add your new Umbraco.UIBuilder license key to the `appSettings.json` file: + +```json +"Umbraco": { + "Licenses": { + "Umbraco.UIBuilder": "YOUR_LICENSE_KEY" + } +} +``` + 5. Run the project. \ No newline at end of file diff --git a/12/umbraco-ui-builder/getting-started/upgrading/README.md b/12/umbraco-ui-builder/upgrading/upgrade.md similarity index 94% rename from 12/umbraco-ui-builder/getting-started/upgrading/README.md rename to 12/umbraco-ui-builder/upgrading/upgrade.md index 407414407b1..3624a2dbea2 100644 --- a/12/umbraco-ui-builder/getting-started/upgrading/README.md +++ b/12/umbraco-ui-builder/upgrading/upgrade.md @@ -1,7 +1,7 @@ # Upgrading Umbraco UI Builder This article shows how to manually upgrade Umbraco UI Builder to run the latest version. -When upgrading Umbraco UI Builder, be sure to also consult the [version specific upgrade](version-specific-upgrades.md) notes to learn about potential breaking changes and common pitfalls. +When upgrading Umbraco UI Builder, be sure to also consult the [version specific upgrade](version-specific.md) notes to learn about potential breaking changes and common pitfalls. {% hint style="warning" %} Before upgrading, it is always advisable to take a complete backup of your site and database. diff --git a/12/umbraco-ui-builder/getting-started/upgrading/version-specific-upgrades.md b/12/umbraco-ui-builder/upgrading/version-specific.md similarity index 85% rename from 12/umbraco-ui-builder/getting-started/upgrading/version-specific-upgrades.md rename to 12/umbraco-ui-builder/upgrading/version-specific.md index deec3de2b33..e93ed1ce69d 100644 --- a/12/umbraco-ui-builder/getting-started/upgrading/version-specific-upgrades.md +++ b/12/umbraco-ui-builder/upgrading/version-specific.md @@ -9,7 +9,7 @@ This page covers specific upgrade documentation for specific versions. {% hint style="info" %} -If you are upgrading to a new minor or patch version, you can find information about the breaking changes in the [Release Notes](../../release-notes.md) article. +If you are upgrading to a new minor or patch version, you can find information about the breaking changes in the [Release Notes](../release-notes.md) article. {% endhint %} @@ -19,7 +19,7 @@ If you are upgrading to a new minor or patch version, you can find information a Version 12 is the initial release of the Umbraco UI Builder product. It contains a number of breaking changes from the previous, Konstrukt product. -See the [Migrate from Konstrukt to Umbraco UI Builder guide](../../guides/migrating-from-konstrukt-to-umbraco-ui-builder.md) for full details. +See the [Migrate from Konstrukt to Umbraco UI Builder guide](../upgrading/migrating-from-konstrukt-to-umbraco-ui-builder.md) for full details. @@ -29,6 +29,6 @@ See the [Migrate from Konstrukt to Umbraco UI Builder guide](../../guides/migrat Version 10 is the initial Long-term support (LTS) release of the Umbraco UI Builder product. It contains a number of breaking changes from the previous, Konstrukt product. -See the [Migrate from Konstrukt to Umbraco UI Builder guide](../../guides/migrating-from-konstrukt-to-umbraco-ui-builder.md) for full details. +See the [Migrate from Konstrukt to Umbraco UI Builder guide](../upgrading/migrating-from-konstrukt-to-umbraco-ui-builder.md) for full details. diff --git a/12/umbraco-workflow/.gitbook.yaml b/12/umbraco-workflow/.gitbook.yaml index 2e3a59e8331..f96d3e18778 100644 --- a/12/umbraco-workflow/.gitbook.yaml +++ b/12/umbraco-workflow/.gitbook.yaml @@ -1,13 +1,12 @@ root: ./ -​structure: +​structure: readme: README.md summary: SUMMARY.md redirects: - configuration: getting-started/configuration.md - dashboards-and-buttons: getting-started/dashboards-and-buttons.md - notifications: getting-started/notifications.md - workflow-content-app: getting-started/workflow-content-app.md - upgrading-workflow/upgrading-workflow: upgrading-workflow/upgrading.md - workflow-section/workflow-section: workflow-section/workflow-section-dashboard.md \ No newline at end of file + installing-workflow: installation/installing-workflow.md + licensing: installation/licensing.md + version-specific-upgrade-notes: upgrading/version-specific.md + upgrading-workflow/migrating-workflow: upgrading/migrating-workflow.md + upgrading-workflow/upgrading: upgrading/upgrading.md diff --git a/12/umbraco-workflow/README.md b/12/umbraco-workflow/README.md index 5b4d001ca7c..52361b1ca27 100644 --- a/12/umbraco-workflow/README.md +++ b/12/umbraco-workflow/README.md @@ -9,7 +9,7 @@ Umbraco Workflow allows the creation of multi-stage approval workflows when writ [Learn more or purchase Umbraco Workflow to get all the features and support.](https://umbraco.com/products/umbraco-workflow/) -
Installing Umbraco WorkflowInstall Umbraco Workflow in a few stepsinstalling-workflow.mdumbraco-workflow-1.png
Content Approval Workflows for UmbracoAllows you to design the approval process to fit your organizationapproval-groups.mdCommunity.png
Workflow Section OverviewApproving, rejecting, content reviews, and scheduling workflows are natural additions to the existing toolbox.workflow-section-dashboard.mdDocumentation_blogpost_styleguide_b (1) (1).png
+
Installing Umbraco WorkflowInstall Umbraco Workflow in a few stepsinstalling-workflow.mdumbraco-workflow-1.png
Content Approval Workflows for UmbracoAllows you to design the approval process to fit your organizationapproval-groups.mdCommunity.png
Workflow Section OverviewApproving, rejecting, content reviews, and scheduling workflows are natural additions to the existing toolbox.workflow-section-dashboard.mdDocumentation_blogpost_styleguide_b (1) (1).png
{% embed url="https://www.youtube-nocookie.com/embed/jFWYZUiQPv8" %} Umbraco Workflow Overview diff --git a/12/umbraco-workflow/SUMMARY.md b/12/umbraco-workflow/SUMMARY.md index 017f934471e..9fde199d0c1 100644 --- a/12/umbraco-workflow/SUMMARY.md +++ b/12/umbraco-workflow/SUMMARY.md @@ -3,9 +3,17 @@ * [Umbraco Workflow Documentation](README.md) * [Legacy Documentation](legacy-documentation.md) * [Release notes](release-notes.md) -* [Installation](installing-workflow.md) -* [Licensing](licensing.md) -* [Version Specific Upgrade Notes](version-specific-upgrade-notes.md) + +## Installation + +* [Installing Umbraco Workflow](installation/installing-workflow.md) +* [Licensing](installation/licensing.md) + +## Upgrading + +* [Upgrading Umbraco Workflow](upgrading/upgrading.md) +* [Version Specific Upgrade Notes](upgrading/version-specific.md) +* [Migrate from Plumber to Workflow](upgrading/migrating-workflow.md) ## Getting Started @@ -16,11 +24,6 @@ * [Approval thresholds](getting-started/approval-thresholds.md) * [History Cleanup](getting-started/history-cleanup.md) -## Upgrading Workflow - -* [Upgrading](upgrading-workflow/upgrading.md) - * [Migrate from Plumber to Workflow](upgrading-workflow/migrating-workflow.md) - ## Workflow Section * [Workflow Section](workflow-section/workflow-section-dashboard.md) diff --git a/12/umbraco-workflow/getting-started/dashboards-and-buttons.md b/12/umbraco-workflow/getting-started/dashboards-and-buttons.md index 73c44ec02a9..bfc5e9c27cf 100644 --- a/12/umbraco-workflow/getting-started/dashboards-and-buttons.md +++ b/12/umbraco-workflow/getting-started/dashboards-and-buttons.md @@ -17,7 +17,7 @@ Umbraco Workflow adds two Dashboards to your Umbraco project: When a workflow is active on the current node, the **Publish** button is replaced, linking to the workflow content app. -![Buttons drawe](<../../../10/umbraco-workflow/images/Buttons (1).png>) +![Buttons](../images/Buttons.png) When no workflow is active, the button state is determined by the current user's permissions. @@ -25,8 +25,8 @@ Umbraco Workflow overrides Umbraco's User/Group publishing permissions. If the u In cases, where the content is already in a workflow, a notification is displayed at the top of the editor. Depending on the Workflow **Settings**, you can enable/disable editing access on a content node in a workflow. -![Disabled content edits](<../../../10/umbraco-workflow/images/blocked\_content (1).png>) +![Disabled content edits](../images/blocked_content.png) For nodes where the workflow has been disabled, the default Umbraco options are displayed. -![Default Button](<../../../10/umbraco-workflow/images/Default\_Buttons (1).png>) +![Default Button](../images/Default_Buttons.png) diff --git a/12/umbraco-workflow/installing-workflow.md b/12/umbraco-workflow/installation/installing-workflow.md similarity index 100% rename from 12/umbraco-workflow/installing-workflow.md rename to 12/umbraco-workflow/installation/installing-workflow.md diff --git a/12/umbraco-workflow/licensing.md b/12/umbraco-workflow/installation/licensing.md similarity index 100% rename from 12/umbraco-workflow/licensing.md rename to 12/umbraco-workflow/installation/licensing.md diff --git a/12/umbraco-workflow/release-notes.md b/12/umbraco-workflow/release-notes.md index 00cb46b3bd3..159c8081a28 100644 --- a/12/umbraco-workflow/release-notes.md +++ b/12/umbraco-workflow/release-notes.md @@ -1,3 +1,8 @@ +--- +description: >- + Get an overview of the things changed and fixed in each version of Umbraco Workflow. +--- + # Release notes In this section, we have summarized the changes to Umbraco Workflow released in each version. Each version is presented with a link to the [Workflow issue tracker](https://github.com/umbraco/Umbraco.Workflow.Issues/issues) showing a list of issues resolved in the release. We also link to the individual issues themselves from the detail. @@ -5,7 +10,7 @@ In this section, we have summarized the changes to Umbraco Workflow released in If there are any breaking changes or other issues to be aware of when upgrading they are also noted here. {% hint style="info" %} -If you are upgrading to a new major version, you can find information about the breaking changes in the [Version Specific Upgrade Notes](version-specific-upgrade-notes.md) article +If you are upgrading to a new major version, you can find information about the breaking changes in the [Version Specific Upgrade Notes](./upgrading/version-specific.md) article {% endhint %} ## Release History @@ -68,4 +73,4 @@ This section contains the release notes for Umbraco Workflow 12 including all ch ## Legacy release notes -You can find the release notes for versions out of support in the[ Legacy documentation release notes.](https://github.com/umbraco/UmbracoDocs/blob/umbraco-eol-versions/11/umbraco-workflow/release-notes.md) +You can find the release notes for versions out of support in the [Legacy documentation on Github](https://github.com/umbraco/UmbracoDocs/blob/umbraco-eol-versions/11/umbraco-workflow/release-notes.md) diff --git a/12/umbraco-workflow/upgrading-workflow/migrating-workflow.md b/12/umbraco-workflow/upgrading/migrating-workflow.md similarity index 92% rename from 12/umbraco-workflow/upgrading-workflow/migrating-workflow.md rename to 12/umbraco-workflow/upgrading/migrating-workflow.md index 8b13452ef2e..bd08c7ec8b8 100644 --- a/12/umbraco-workflow/upgrading-workflow/migrating-workflow.md +++ b/12/umbraco-workflow/upgrading/migrating-workflow.md @@ -8,7 +8,7 @@ To migrate from an Umbraco installation with an existing Plumber installation to {% tab title="Site running on SQL Server database" %} 1. Uninstall Plumber and remove the `/App_Plugins/Plumber` folder. 2. Upgrade your project to Umbraco 11. -3. Install Umbraco Workflow 11. See the [Installing Umbraco Workflow](../installing-workflow.md) article. +3. Install Umbraco Workflow 11. See the [Installing Umbraco Workflow](../installation/installing-workflow.md) article. 4. Build the application. {% hint style="info" %} @@ -22,7 +22,7 @@ SQL is the preferred database provider for production websites. 3. Make a copy of the `Value` column from the `WorkflowSettings` table. 4. Delete the `WorkflowSettings` table. 5. Update `WorkflowTaskInstance` table to allow null values in the GroupId column. -6. Install Umbraco Workflow 11. See the [Installing Umbraco Workflow](../installing-workflow.md) article. +6. Install Umbraco Workflow 11. See the [Installing Umbraco Workflow](../installation/installing-workflow.md) article. 7. Build the application. 8. Update the `WorkflowSettings` table to restore the previous data to the `Value` column. {% endtab %} diff --git a/12/umbraco-workflow/upgrading-workflow/upgrading.md b/12/umbraco-workflow/upgrading/upgrading.md similarity index 100% rename from 12/umbraco-workflow/upgrading-workflow/upgrading.md rename to 12/umbraco-workflow/upgrading/upgrading.md diff --git a/12/umbraco-workflow/version-specific-upgrade-notes.md b/12/umbraco-workflow/upgrading/version-specific.md similarity index 99% rename from 12/umbraco-workflow/version-specific-upgrade-notes.md rename to 12/umbraco-workflow/upgrading/version-specific.md index 7f85dab11a4..f753fcab5d4 100644 --- a/12/umbraco-workflow/version-specific-upgrade-notes.md +++ b/12/umbraco-workflow/upgrading/version-specific.md @@ -3,7 +3,7 @@ This page covers specific upgrade documentation for specific versions. {% hint style="info" %} -If you are upgrading to a new minor or patch version, you can find information about the breaking changes in the [Release Notes](./release-notes.md) article. +If you are upgrading to a new minor or patch version, you can find information about the breaking changes in the [Release Notes](../release-notes.md) article. {% endhint %}
diff --git a/13/umbraco-commerce/.gitbook.yaml b/13/umbraco-commerce/.gitbook.yaml index c22ec492e35..2993b01c84b 100644 --- a/13/umbraco-commerce/.gitbook.yaml +++ b/13/umbraco-commerce/.gitbook.yaml @@ -7,7 +7,7 @@ root: ./ redirects: getting-started/installation/README: installation/install.md getting-started/licensing-model: installation/the-licensing-model.md -getting-started/upgrading/README: upgrading/manualupgrade.md +getting-started/upgrading/README: upgrading/upgrade.md getting-started/upgrading/version-specific-upgrades: upgrading/version-specific-upgrades.md how-to-guides/migrate-from-vendr-to-umbraco-commerce/migrate-custom-payment-providers: upgrading/migrate-from-vendr-to-umbraco-commerce/migrate-custom-payment-providers.md how-to-guides/migrate-from-vendr-to-umbraco-commerce/migrate-umbraco-commerce-checkout: upgrading/migrate-from-vendr-to-umbraco-commerce/migrate-umbraco-commerce-checkout.md diff --git a/13/umbraco-commerce/SUMMARY.md b/13/umbraco-commerce/SUMMARY.md index 0c16480b96b..6a86ca137e2 100644 --- a/13/umbraco-commerce/SUMMARY.md +++ b/13/umbraco-commerce/SUMMARY.md @@ -1,6 +1,6 @@ # Table of contents -* [What is Umbraco Commerce?](README.md) +* [Umbraco Commerce Documentation](README.md) * [Commerce Packages](https://docs.umbraco.com/umbraco-commerce-packages) * [Commerce Payment Providers](https://docs.umbraco.com/umbraco-commerce-payment-providers) * [Release Notes](release-notes.md) @@ -12,7 +12,7 @@ ## Upgrading -* [Upgrading Umbraco Commerce](upgrading/manualupgrade.md) +* [Upgrading Umbraco Commerce](upgrading/upgrade.md) * [Version Specific Upgrade Notes](upgrading/version-specific.md) * [Migrate from Vendr to Umbraco Commerce](upgrading/migrate-from-vendr-to-umbraco-commerce/README.md) * [Migrate Umbraco Commerce Checkout](upgrading/migrate-from-vendr-to-umbraco-commerce/migrate-umbraco-commerce-checkout.md) diff --git a/13/umbraco-commerce/upgrading/manualupgrade.md b/13/umbraco-commerce/upgrading/upgrade.md similarity index 100% rename from 13/umbraco-commerce/upgrading/manualupgrade.md rename to 13/umbraco-commerce/upgrading/upgrade.md diff --git a/13/umbraco-deploy/getting-started/get-started-with-deploy.md b/13/umbraco-deploy/getting-started/get-started-with-deploy.md index c9b47fb4a57..ce2d6c11842 100644 --- a/13/umbraco-deploy/getting-started/get-started-with-deploy.md +++ b/13/umbraco-deploy/getting-started/get-started-with-deploy.md @@ -16,7 +16,7 @@ For example, when working locally you might create a new Document Type. This wil When you want this deployed to your next environment, you would trigger your CI/CD process (for example Azure DevOps or Github Actions). This will push the changes to your environment. Once the build deployment completes successfully, a Deployment Trigger would be executed as an HTTPS request to your target environment. All changes found in the `umbraco/Deploy/Revision` folder will then be extracted into the Umbraco target environment. -![Deploy workflow](../../10/umbraco-deploy/images/Deploy\_concept.png) +![Deploy workflow](../images/Deploy_concept.png) ## [Quick start (new sites)](../installation/install-configure.md) diff --git a/13/umbraco-forms/upgrading/manualupgrade.md b/13/umbraco-forms/upgrading/manualupgrade.md index ced52a93194..0f0701c1f5a 100644 --- a/13/umbraco-forms/upgrading/manualupgrade.md +++ b/13/umbraco-forms/upgrading/manualupgrade.md @@ -22,7 +22,7 @@ To get the latest version of Umbraco Forms, you can upgrade using: 2. Select **Umbraco.Forms**. 3. Select the latest version from the **Version** drop-down and click **Install**. -![NuGet Package Manager](../../../10/umbraco-forms/installation/images/Manage\_packages\_v10.png) +![NuGet Package Manager](../installation/images/Manage_packages_v10.png) 4. When the command completes, open the **.csproj** file to make sure the package reference is updated: diff --git a/13/umbraco-ui-builder/.gitbook.yaml b/13/umbraco-ui-builder/.gitbook.yaml index b2058b708f6..83e70191059 100644 --- a/13/umbraco-ui-builder/.gitbook.yaml +++ b/13/umbraco-ui-builder/.gitbook.yaml @@ -5,7 +5,7 @@ root: ./ summary: SUMMARY.md redirects: -getting-started/upgrading/README: upgrading/manualupgrade.md +getting-started/upgrading/README: upgrading/upgrade.md getting-started/upgrading/version-specific-upgrades: upgrading/version-specific.md getting-started/installation: installation/installation.md getting-started/licensing-model: installation/licensing-model.md diff --git a/13/umbraco-ui-builder/SUMMARY.md b/13/umbraco-ui-builder/SUMMARY.md index 8d68cbd1b46..e28f1cfc113 100644 --- a/13/umbraco-ui-builder/SUMMARY.md +++ b/13/umbraco-ui-builder/SUMMARY.md @@ -11,7 +11,7 @@ ## Upgrading -* [Upgrading Umbraco UI Builder](upgrading/manualupgrade.md) +* [Upgrading Umbraco UI Builder](upgrading/upgrade.md) * [Version Specific Upgrade Notes](upgrading/version-specific.md) * [Migrate from Konstrukt to Umbraco UI Builder](upgrading/migrating-from-konstrukt-to-umbraco-ui-builder.md) @@ -88,4 +88,3 @@ * [Conventions](miscellaneous/conventions.md) * [Umbraco Aliases](miscellaneous/umbraco-aliases.md) -* [Umbraco-UI-Builder vs UI-O-Matic](miscellaneous/umbraco-ui-builder-vs-ui-o-matic.md) diff --git a/13/umbraco-ui-builder/miscellaneous/umbraco-ui-builder-vs-ui-o-matic.md b/13/umbraco-ui-builder/miscellaneous/umbraco-ui-builder-vs-ui-o-matic.md deleted file mode 100644 index 0ba20433612..00000000000 --- a/13/umbraco-ui-builder/miscellaneous/umbraco-ui-builder-vs-ui-o-matic.md +++ /dev/null @@ -1,2 +0,0 @@ -# Umbraco-UI-Builder vs UI-O-Matic - diff --git a/10/umbraco-ui-builder/getting-started/upgrading/README.md b/13/umbraco-ui-builder/upgrading/upgrade.md similarity index 92% rename from 10/umbraco-ui-builder/getting-started/upgrading/README.md rename to 13/umbraco-ui-builder/upgrading/upgrade.md index 893c44c813f..3624a2dbea2 100644 --- a/10/umbraco-ui-builder/getting-started/upgrading/README.md +++ b/13/umbraco-ui-builder/upgrading/upgrade.md @@ -1,46 +1,46 @@ -# Upgrading Umbraco UI Builder - -This article shows how to manually upgrade Umbraco UI Builder to run the latest version. -When upgrading Umbraco UI Builder, be sure to also consult the [version specific upgrade](version-specific-upgrades.md) notes to learn about potential breaking changes and common pitfalls. - -{% hint style="warning" %} -Before upgrading, it is always advisable to take a complete backup of your site and database. -{% endhint %} - -## Get the latest version of Umbraco UI Builder - -To upgrade to the latest version of Umbraco UI Builder you can use: - -- NuGet -- Visual Studio - -### NuGet - -- NuGet installs the latest version of the package when you use the `dotnet add package Umbraco.UIBuilder` command unless you specify a package version: `dotnet add package Umbraco.UIBuilder --version ` - -- After you have added a package reference to your project by executing the `dotnet add package Umbraco.UIBuilder` command in the directory that contains your project file, run `dotnet restore` to install the package. - - -### Visual Studio - -1. Go to `Tools` -> `NuGet Package Manager` -> `Manage NuGet Packages for Solution...` in Visual Studio, to upgrade Umbraco UI Builder: -2. Select **Umbraco.UIBuilder**. -3. Select the latest version from the Version drop-down and click Install. -4. When the command completes, open the **.csproj** file to make sure the package reference is updated: - -```xml - - - -``` - -If you are using one or more of the below sub-packages, they also need to be upgraded as well: - -| Sub-package | Description | -| -- | -- | -| Umbraco.UIBuilder.Core | Core UI Builder functionality that doesn't require any infrastructure-specific dependencies | -| Umbraco.UIBuilder.Infrastructure | Infrastructure-specific project containing implementations of core UI Builder functionality | -| Umbraco.UIBuilder.Web | The core UI Builder logic that requires a web context | -| Umbraco.UIBuilder.Web.StaticAssets | The static asstes for the UI Builder presentation layer | -| Umbraco.UIBuilder.Startup | The main logic for registering UI Builder with Umbraco | +# Upgrading Umbraco UI Builder + +This article shows how to manually upgrade Umbraco UI Builder to run the latest version. +When upgrading Umbraco UI Builder, be sure to also consult the [version specific upgrade](version-specific.md) notes to learn about potential breaking changes and common pitfalls. + +{% hint style="warning" %} +Before upgrading, it is always advisable to take a complete backup of your site and database. +{% endhint %} + +## Get the latest version of Umbraco UI Builder + +To upgrade to the latest version of Umbraco UI Builder you can use: + +- NuGet +- Visual Studio + +### NuGet + +- NuGet installs the latest version of the package when you use the `dotnet add package Umbraco.UIBuilder` command unless you specify a package version: `dotnet add package Umbraco.UIBuilder --version ` + +- After you have added a package reference to your project by executing the `dotnet add package Umbraco.UIBuilder` command in the directory that contains your project file, run `dotnet restore` to install the package. + + +### Visual Studio + +1. Go to `Tools` -> `NuGet Package Manager` -> `Manage NuGet Packages for Solution...` in Visual Studio, to upgrade Umbraco UI Builder: +2. Select **Umbraco.UIBuilder**. +3. Select the latest version from the Version drop-down and click Install. +4. When the command completes, open the **.csproj** file to make sure the package reference is updated: + +```xml + + + +``` + +If you are using one or more of the below sub-packages, they also need to be upgraded as well: + +| Sub-package | Description | +| -- | -- | +| Umbraco.UIBuilder.Core | Core UI Builder functionality that doesn't require any infrastructure-specific dependencies | +| Umbraco.UIBuilder.Infrastructure | Infrastructure-specific project containing implementations of core UI Builder functionality | +| Umbraco.UIBuilder.Web | The core UI Builder logic that requires a web context | +| Umbraco.UIBuilder.Web.StaticAssets | The static asstes for the UI Builder presentation layer | +| Umbraco.UIBuilder.Startup | The main logic for registering UI Builder with Umbraco | | Umbraco.UIBuilder | The main UI Builder package | \ No newline at end of file diff --git a/13/umbraco-ui-builder/upgrading/version-specific.md b/13/umbraco-ui-builder/upgrading/version-specific.md index 851b2ee4df4..46ce7056612 100644 --- a/13/umbraco-ui-builder/upgrading/version-specific.md +++ b/13/umbraco-ui-builder/upgrading/version-specific.md @@ -8,7 +8,7 @@ description: >- This page covers specific upgrade documentation for when migrating to major 13 of Umbraco UI Builder. {% hint style="info" %} -If you are upgrading to a new minor or patch version, you can find information about the breaking changes in the [Release Notes](./release-notes.md) article. +If you are upgrading to a new minor or patch version, you can find information about the breaking changes in the [Release Notes](../release-notes.md) article. {% endhint %} ## Version Specific Upgrade Notes History diff --git a/13/umbraco-workflow/getting-started/dashboards-and-buttons.md b/13/umbraco-workflow/getting-started/dashboards-and-buttons.md index 73c44ec02a9..bfc5e9c27cf 100644 --- a/13/umbraco-workflow/getting-started/dashboards-and-buttons.md +++ b/13/umbraco-workflow/getting-started/dashboards-and-buttons.md @@ -17,7 +17,7 @@ Umbraco Workflow adds two Dashboards to your Umbraco project: When a workflow is active on the current node, the **Publish** button is replaced, linking to the workflow content app. -![Buttons drawe](<../../../10/umbraco-workflow/images/Buttons (1).png>) +![Buttons](../images/Buttons.png) When no workflow is active, the button state is determined by the current user's permissions. @@ -25,8 +25,8 @@ Umbraco Workflow overrides Umbraco's User/Group publishing permissions. If the u In cases, where the content is already in a workflow, a notification is displayed at the top of the editor. Depending on the Workflow **Settings**, you can enable/disable editing access on a content node in a workflow. -![Disabled content edits](<../../../10/umbraco-workflow/images/blocked\_content (1).png>) +![Disabled content edits](../images/blocked_content.png) For nodes where the workflow has been disabled, the default Umbraco options are displayed. -![Default Button](<../../../10/umbraco-workflow/images/Default\_Buttons (1).png>) +![Default Button](../images/Default_Buttons.png)