diff --git a/umbraco-cloud/deployment/README.md b/umbraco-cloud/deployment/README.md index 4acc46e5435..4a66c4b8876 100644 --- a/umbraco-cloud/deployment/README.md +++ b/umbraco-cloud/deployment/README.md @@ -6,9 +6,13 @@ description: >- # Deployment -Umbraco Cloud uses a deployment model based on Git, Kudu, and Umbraco Deploy to move changes between environments. This follows a left-to-right model. Changes start in the local or left-most environment and are deployed to the production environment. +Umbraco Cloud uses a deployment model based on Git, Kudu, and Umbraco Deploy to move changes between environments. This follows a left-to-right deployment approach. Changes start in the local or left-most environment and are deployed to the production/Live environment. This workflow is called the mainline. -![Left to right model](images/left-to-right.png) +The mainline environments are used when building and deploying the initial website. Upgrades, both manual and automatic also go through the mainline environments. + +Flexible environments can be used to work on features separate from the mainline. This is done without interfering with upgrades or other changes being worked on in the mainline. + +![Left to right model](images/left-to-right-approach.png) ## Deployment Approach @@ -19,9 +23,6 @@ Umbraco Cloud separates schema and content during deployment. Schema includes Do ### Types of Deployments -* **Schema Deployment:** Schema is stored in a Git repository. These are **deployed** between environments using a Git client or the Umbraco Cloud Portal. -* **Content and Media Transfer:** Content and Media items are not stored in the Git repository. They must be **transferred** directly from the Umbraco backoffice using the **Queue for Transfer** option. Once queued, use the **Deployment** Dashboard in the **Content** section to complete the transfer. - | Schema Deployments | Content and Media Transfers | | ----------- | ------------- | | Schema is stored in a Git repository. These are **deployed** between environments using a Git client or the Umbraco Cloud Portal. | Content and Media items are not stored in the Git repository. They must be **transferred** directly from the Umbraco backoffice using the **Queue for Transfer** option. Once queued, use the **Deployment** Dashboard in the **Content** section to complete the transfer. | diff --git a/umbraco-cloud/deployment/images/left-to-right-approach.png b/umbraco-cloud/deployment/images/left-to-right-approach.png new file mode 100644 index 00000000000..c2ba5e5199c Binary files /dev/null and b/umbraco-cloud/deployment/images/left-to-right-approach.png differ diff --git a/umbraco-cloud/deployment/images/left-to-right.png b/umbraco-cloud/deployment/images/left-to-right.png deleted file mode 100644 index ffe8d03dd6c..00000000000 Binary files a/umbraco-cloud/deployment/images/left-to-right.png and /dev/null differ diff --git a/umbraco-cloud/getting-started/baselines/README.md b/umbraco-cloud/getting-started/baselines/README.md index 367c2049f00..739da776d49 100644 --- a/umbraco-cloud/getting-started/baselines/README.md +++ b/umbraco-cloud/getting-started/baselines/README.md @@ -1,10 +1,10 @@ # Baselines -A Baseline Child project is very similar to a Fork (forked repository) on GitHub where we create a clone of an existing project while maintaining a connection between the two projects. The connection exists between the _Live_ environment of the existing project, the **Baseline project**, and the _Development_ or Live environment - of the newly created project, the **Child project**. +A Baseline Child project is similar to a Fork (forked repository) on GitHub. A clone is created of an existing project while maintaining a connection between the two projects. The connection exists between the Live environment of the **Baseline project**, and the left-most mainline environment of the **Child project**. Any project can act as a Baseline project. -The basic idea is that you have a project that contains all your standard Umbraco packages/components, maybe even configured with some default Document Types, which you want to use as a baseline for future projects. When you've made changes to your Baseline project, you can then push these changes out to all the Child projects with a click of a button. +The basic idea is that you have a project that contains all your standard Umbraco packages/components. Some default Document Types which you want to use as a baseline for future projects is also configured. When you've made changes to your Baseline project, you push these changes out to all the Child projects with a click of a button. ![Baseline workflow](images/baseline-workflow.gif) @@ -14,7 +14,7 @@ The basic idea is that you have a project that contains all your standard Umbrac Learn how to work with Baselines. {% endembed %} -## Creating a Child Project +## Create a Child Project To create a child project: diff --git a/umbraco-cloud/getting-started/baselines/configuration-files.md b/umbraco-cloud/getting-started/baselines/configuration-files.md index 9a3e914eb0a..4932761e966 100644 --- a/umbraco-cloud/getting-started/baselines/configuration-files.md +++ b/umbraco-cloud/getting-started/baselines/configuration-files.md @@ -28,7 +28,9 @@ When you need a specific configuration on Child projects, you should always use Here is a few examples of what could be transformed in the child sites. -## Adding or updating appsettings (i.e. child-appsettings.web.live.xdt.config) +## Adding or updating appsettings + +{% code title="child-appsettings.web.live.xdt.config" %} ```xml @@ -45,7 +47,11 @@ Here is a few examples of what could be transformed in the child sites. ``` -## Setting the SMTP settings for the child project (i.e. child-smtpsettings.web.live.xdt.config) +{% endcode %} + +## Setting the Simple Mail Transfer Protocol (SMTP) settings for the child project + +{% code title="child-smtpsettings.web.live.xdt.config" %} ```xml @@ -61,7 +67,11 @@ Here is a few examples of what could be transformed in the child sites. ``` -## Setting custom rewrite rules for the child project (i.e. child-iisrewrite.web.live.xdt.config) +{% endcode %} + +## Setting custom rewrite rules for the child project + +{% code title="child-iisrewrite.web.live.xdt.config" %} ```xml @@ -86,12 +96,14 @@ Here is a few examples of what could be transformed in the child sites. ``` -The above could either be added to its config files or be split up into one config file per setting. Umbraco Cloud will run through all the config files for the project. i.e. in one file +{% endcode %} + +The above could either be added to its config files or be split up into one config file per setting. Umbraco Cloud will run through all the config files for the project. -* child.web.live.xdt.config +* `child.web.live.xdt.config` or having multiple files -* child-appsettings.web.live.xdt.config -* child-iisrewrite.web.live.xdt.config -* child-smtpsettings.web.live.xdt.config +* `child-appsettings.web.live.xdt.config` +* `child-iisrewrite.web.live.xdt.config` +* `child-smtpsettings.web.live.xdt.config` diff --git a/umbraco-cloud/getting-started/explore-umbraco-cloud.md b/umbraco-cloud/getting-started/explore-umbraco-cloud.md index 7182fe74d8d..1e3c0f503f7 100644 --- a/umbraco-cloud/getting-started/explore-umbraco-cloud.md +++ b/umbraco-cloud/getting-started/explore-umbraco-cloud.md @@ -7,7 +7,6 @@ description: Begin your journey with Umbraco Cloud by exploring the essentials. This section will help you get up and running with the core features of Umbraco Cloud. Whether you are new to Umbraco or migrating from another platform, these articles will walk you through everything you need to know to get started. -
The Cloud PortalLearn how to log in, navigate the interface, and start managing your Umbraco projects.the-umbraco-cloud-portalDocumentations Icons_Umbraco_CMS_Fundamentals_Backoffice.png
Project OverviewUnderstand how the Umbraco Cloud environment is structured and what each section of your project means.project-overview.mdDocumentations Icons_Umbraco_CMS_Tutorials_Custom_Dashboard.png
EnvironmentsEnvironments are the foundation of your Umbraco Cloud project. Learn how to set up and manage your environments.environments.mdDocumentations Icons_Umbraco_Sustainability_Best_Practices_Infrastructure.png
BaselinesLearn how to create and manage baselines in Umbraco Cloud.baselinesDocumentations Icons_Umbraco_CMS_Implementation_Composing (1).png
Migrate to Umbraco CloudIf you're moving from another platform or version of Umbraco, you'll want to understand the steps involved in migrating to Umbraco Cloud. This section covers everything from preparation to execution.migrate-to-umbraco-cloud.mdDocumentations Icons_Umbraco_CMS_Reference_Querying_and_Models.png
Repositories in a Cloud ProjectLearn how to work with Git repositories, including setting them up, syncing, and managing changes.git-repository-in-a-cloud-project.mdDocumentations Icons_Umbraco_CMS_Reference_Caching.png
## Also in this section diff --git a/umbraco-cloud/getting-started/git-repository-in-a-cloud-project.md b/umbraco-cloud/getting-started/git-repository-in-a-cloud-project.md index 87f9aadf4b2..3e2a716f7dc 100644 --- a/umbraco-cloud/getting-started/git-repository-in-a-cloud-project.md +++ b/umbraco-cloud/getting-started/git-repository-in-a-cloud-project.md @@ -1,9 +1,9 @@ # Repositories in a Cloud Project -Each Umbraco Cloud project can have multiple environments: Development, Staging, and Live depending on your Cloud project plan. Each environment has its own git repository that is hosted on Umbraco’s Cloud platform. +Each Umbraco Cloud project can have multiple environments: Mainline and Flexible Environments. Each environment has its own git repository that is hosted on Umbraco’s Cloud platform. {% hint style="info" %} -Umbraco Cloud repositories are _only_ deployment repositories and should not be used as source code repositories. +Umbraco Cloud repositories are only deployment repositories and should not be used as source code repositories. {% endhint %} Ideally, your Umbraco Cloud setup should look like this: @@ -31,15 +31,15 @@ You need to put your custom code in a different source control repository of you {% endtab %} {% endtabs %} -## A Git Umbraco Cloud source control repository with the locally cloned Umbraco project +## A source control repository with the locally cloned Umbraco project -We recommend creating a Cloud project with at least two environments: a Development environment and a Live environment. To work with a local copy of your site, you then clone down the Development environment using the **Clone project** option from the Cloud Portal and start building your website locally. This repository is different from your source control repository. +It is recommended to create a Cloud project with at least two environments: a Live environment including one extra mainline environment. Work with a local copy of the site by cloning down the left-most environment. This repository is different from your source control repository. -Once you're happy with the results or wish to see how your website has progressed, you push the changes back to the Development environment. If everything is working as expected you then deploy your changes to the Live environment. +Once you're happy with the results or wish to see how your website has progressed, you push the changes back to the Cloud. If everything is working as expected, deploy your changes to the Live environment. {% tabs %} {% tab title="Umbraco 10+" %} -#### Code Deployment Summary +### Code Deployment Summary ![Umbraco Cloud Overview](images/UCP.png) @@ -47,14 +47,14 @@ In the above diagram, the Umbraco Git repository contains the source code of a c With this setup, once you commit your code in the Umbraco Cloud Git repository, your C# source code is built by Umbraco Cloud and then deployed to the `wwwroot` folder. -#### Disadvantages of using an Umbraco Cloud Project repository as a source code repository +### Disadvantages of using an Umbraco Cloud Project repository as a source code repository * We only guarantee to maintain and keep the `master` branch. If there are any other branches, they might be removed without any notification causing data loss. * You will need to commit your frontend artifacts as the build pipeline only builds dlls from your C# code. {% endtab %} {% tab title="Legacy Umbraco 7 and 8" %} -#### Code Deployment Summary +### Code Deployment Summary

Umbraco cloud overview Legacy versions

@@ -62,11 +62,9 @@ In the above diagram, the external git repository contains the source code of a With this setup, you commit your changes twice. Once to commit your code in your source control and the other commit to the Umbraco Cloud Git repository to deploy your website. Your source code is not hosted on Umbraco Cloud but only your cloned project will be in the Umbraco Cloud Git Repository. Your code is built and compiled into the cloned project and then pushed to Umbraco Cloud. Thus updating the site with your latest code changes. -#### Disadvantages of using an Umbraco Cloud Project repository as a source code repository +### Disadvantages of using an Umbraco Cloud Project repository as a source code repository * We only guarantee to maintain and keep the `master` branch. If there are any other branches, they might be removed without any notification causing data loss. * You will always need to commit your dll files. {% endtab %} {% endtabs %} - -## diff --git a/umbraco-cloud/getting-started/migrate-to-umbraco-cloud.md b/umbraco-cloud/getting-started/migrate-to-umbraco-cloud.md index c6ba48e092b..3a483470f38 100644 --- a/umbraco-cloud/getting-started/migrate-to-umbraco-cloud.md +++ b/umbraco-cloud/getting-started/migrate-to-umbraco-cloud.md @@ -117,7 +117,7 @@ You can create a new Umbraco Cloud project in one of the two ways: 1. Click **Create project** in the Umbraco Cloud Portal. 2. Choose **Umbraco Cloud** as the Type. -3. Choose a **plan** that enables you to add a Development environment. +3. Choose a **plan** that enables you to add an extra mainline environment. 4. Select the **version** that matches the project you want to migrate. 5. Give the project a **name**. 6. Choose from which **Region** the site should be hosted. @@ -128,10 +128,16 @@ You can create a new Umbraco Cloud project in one of the two ways: 11. Check the "Terms and conditions" box. 12. Click **Create Project**. -Once the project is set up, **add a Development** environment. This will enable you to start over with the migration, should something go amiss. +Once the project is set up: + +1. Select **Configure environments**. +2. Add a new **mainline environment**. + * Throughout this guide, this mainline environment will be referred to as the **Development environment**. + +Having more than one environment on your project, will enable you to start over with the migration process should it be needed. {% hint style="info" %} -Many processes happen in the background when a new Cloud environment is set up. It might take several minutes before the environments are ready to use. +Many processes happen in the background when a new Cloud environment is set up. It might take some time before the environments are ready to use. {% endhint %} With the Cloud project set up and ready, the migration can start in the next step. @@ -152,7 +158,7 @@ The Umbraco Cloud project is now ready for the next step where the two projects To continue the migration the next step is to clone down the Umbraco Cloud environment to merge it with the Umbraco CMS project. -Follow the steps outlined in the [Working with a Local Clone](../set-up/working-locally.md#cloning-an-umbraco-cloud-project) article to clone down the **Development** **environment** of the Umbraco Cloud project. +Follow the steps outlined in the [Working with a Local Clone](../set-up/working-locally.md#cloning-an-umbraco-cloud-project) article to clone down the Development environment on the project. {% hint style="info" %} Do not run the project after cloning it down. diff --git a/umbraco-cloud/getting-started/team-workflow-on-cloud.md b/umbraco-cloud/getting-started/team-workflow-on-cloud.md index 02da5ef2e02..ec45d3b5bc2 100644 --- a/umbraco-cloud/getting-started/team-workflow-on-cloud.md +++ b/umbraco-cloud/getting-started/team-workflow-on-cloud.md @@ -1,11 +1,9 @@ # Best Practice for Working in Teams on Umbraco Cloud -In this article, we will look at some of the best practices and recommendations when you are working in teams on your Umbraco Cloud projects. +This article will look at some of the best practices and recommendations when you are working in teams on your Umbraco Cloud projects. ## Working with Git in Teams -### Pull before you Push - Always start by making a pull request from your project before you push anything back up to Cloud. This way you ensure that you do not accidentally overwrite the work that someone else in your team has worked with. ### Create branches locally @@ -14,16 +12,18 @@ Umbraco Cloud is built on top of Git which means that you can create branches lo ## Working with Environments in a team -### Set up a Development environment +It is recommended to use multiple environments when you are working in teams. With additional environments, members of a team can work locally, pushing up changes to the Cloud environment for testing. + +Having multiple environments enables developers to continue developing, while content editors can focus on creating content in a separate environment. -We highly recommend that you use a Development environment when you are working in teams. With the Development environment, members of a team can work on their local version of the project. They can then push back up to the development environment to be tested and approved before being deployed to either the staging or the live environment. +### Flexible Environments -### Set up a Staging environment +When you need to work on a new feature, using a flexible environment ensures that the regular workflow isn't affected. The flexible environment is connected to a single mainline environment and isn't part of the left-to-right deployment workflow. -When working in a bigger team with both developers and content editors, we highly recommend that you set up a Staging environment. This way the developers can continue developing in the Development environment, while the content editors can focus on creating delightful content in the Staging environment. +Learn more about how this works in the [Flexible Environments](flexible-environments.md) article. ## Team development workflow On Cloud -For a more in-depth example of how to work in teams on Umbraco Cloud projects, Our Gold Partner ProWorks have created an article about how they have set up a [Team development workflow on Umbraco Cloud](https://skrift.io/issues/integrating-umbraco-cloud-with-team-development-workflow/). +For a more in-depth example of how to work in teams, our Gold Partner ProWorks has written an article on [Team development workflows](https://skrift.io/issues/integrating-umbraco-cloud-with-team-development-workflow/). -This article can serve as inspiration if you are an agency and are looking into setting up a bigger project where several people will be working on Umbraco Cloud. +This article serves as inspiration if you looking into setting up a bigger project where multiple people will be working on Umbraco Cloud. diff --git a/umbraco-cloud/product-upgrades/README.md b/umbraco-cloud/product-upgrades/README.md index 5fe484cb97f..f029f4b55bf 100644 --- a/umbraco-cloud/product-upgrades/README.md +++ b/umbraco-cloud/product-upgrades/README.md @@ -1,6 +1,6 @@ # Product Upgrades -_This document describes when & what product updates are rolled out on Umbraco Cloud_ +This document describes when and what product updates are rolled out on Umbraco Cloud. ## What products are auto-upgraded? @@ -9,7 +9,7 @@ _This document describes when & what product updates are rolled out on Umbraco C * Deploy * Internal Umbraco Cloud services (generally these updates will not affect running websites but in some cases, if they do we will notify Umbraco Cloud users via the status page) -When minor upgrades are available, you will need a Development environment on your project in order to get the new version. Read the [Minor Upgrades](minor-upgrades.md) article for more details. +When minor upgrades are available, you will need an additional mainline environment on your project in order to get the new version. Read the [Minor Upgrades](minor-upgrades.md) article for more details. ## When do upgrades happen? @@ -47,17 +47,17 @@ This describes how a Umbraco Cloud project is auto-upgraded: * The upgrade payload will have been created for the specific product(s) being upgraded * The payload is a set of files (such as DLLs, and other ASP.NET website files) -* The upgrader will verify that the home page of all the environments (dev/staging/live) is healthy, meaning they don’t return an HTTP status error. If all environments are ok, it will proceed. -* The upgrader will take a snapshot of the Dev site’s home page including its HTTP status code result and its HTML contents. -* The payload is deployed to the Dev site’s Git repository and committed with a tag for the product version being updated. This new Git repository commit will replace the Umbraco product assembly (DLL) files along with other product files such as files located in /umbraco, /umbraco\_client folders +* The upgrader will verify that the home page of all the environments in the mainline environment is healthy, meaning they don’t return an HTTP status error. If all environments are ok, it will proceed. +* The upgrader will take a snapshot of the left-most environments home page including its HTTP status code result and its HTML contents. +* The payload is deployed to the left-most environments Git repository and committed with a tag for the product version being updated. This new Git repository commit will replace the Umbraco product assembly (DLL) files along with other product files such as files located in /umbraco, /umbraco\_client folders * The normal Umbraco Cloud deployment process is invoked and the repository files are deployed to the website * The upgrader will automatically ensure the web.config version and the database version are updated so that the Installer/upgrade page is not shown -* The upgrader will verify that the new HTTP status code returned from the Dev site’s home page is OK and will verify that the HTML contents of the home page match that of the snapshot originally taken. +* The upgrader will verify that the new HTTP status code returned from the left-most environments home page is OK and will verify that the HTML contents of the home page match that of the snapshot originally taken. * If either of these tests fails we will be notified and Umbraco will take appropriate measures to roll back the site to its previous state * The failed upgrade is then tracked for reporting and the customer will be notified if necessary -* When the Dev site is upgraded successfully, the upgrader will continue this same process for the next environment in the chain (that is Dev -> Staging -> Live) depending on the number of environments that exist for the project. +* When the left-most environment is upgraded successfully, the upgrader will continue this same process for the next environment in the chain. -{% hint style="info" %} Changes for patches might appear on Development, even if they have already been applied to Live. The environments will not be synchronized during the upgrade process. This is because synchronization risks pushing other apparent changes from one environment to another. Those changes will need to be deployed. Once that has been done, the environments will be in sync again. {% endhint %} +{% hint style="info" %} Changes for patches might appear on left-most environment, even if they have already been applied to Live. The environments will not be synchronized during the upgrade process. This is because synchronization risks pushing other apparent changes from one environment to another. Those changes will need to be deployed. Once that has been done, the environments will be in sync again. {% endhint %} ## How do baseline updates work? diff --git a/umbraco-cloud/product-upgrades/major-upgrades.md b/umbraco-cloud/product-upgrades/major-upgrades.md index e2fdfd4e260..bef0fedf328 100644 --- a/umbraco-cloud/product-upgrades/major-upgrades.md +++ b/umbraco-cloud/product-upgrades/major-upgrades.md @@ -16,11 +16,11 @@ Make sure any packages you use are compatible with the latest version of Umbraco Be aware of any [Breaking changes](https://docs.umbraco.com/umbraco-cms/fundamentals/setup/upgrading/version-specific#breaking-changes) introduced in the latest version of Umbraco CMS to avoid issues during the upgrade. {% endhint %} -## **Before you start the upgrade** +## Before you start the upgrade Before upgrading your Umbraco Cloud project to the latest major version, you must consider the version your project is already on. This will impact the upgrade flow you will be following. -### **Upgrading from a Short Term Supported (STS) version** +### Upgrading from a Short Term Supported (STS) version When upgrading from an STS version, you must start by upgrading to the closest Long-term Support (LTS) major. If the version you are upgrading to is an STS version, you can upgrade to that version, directly from the closest LTS. You can upgrade directly if there are no LTS versions between the current one and the one you are upgrading to. @@ -30,7 +30,7 @@ Refer to the [Long-term support and EOL article](https://umbraco.com/products/kn Start by upgrading to the closest LTS. In this case, that is Umbraco 13. After that, you can upgrade directly from Umbraco 13 to Umbraco 15. -### **Upgrading from a Long Term Supported (LTS) version** +### Upgrading from a Long Term Supported (LTS) version When upgrading from an LTS version, you must start by looking at the versions between yours and the one you are upgrading to. Is there another LTS version in that line, you need to upgrade to that version first. @@ -40,7 +40,7 @@ Refer to the [Long-term support and EOL article](https://umbraco.com/products/kn Skipping upgrades to STS versions, like 11 and 12, means you will not receive warnings about obsolete features. We recommend keeping the [Breaking Changes documentation](https://docs.umbraco.com/umbraco-cms/fundamentals/setup/upgrading/version-specific#breaking-changes) handy to avoid any surprises. {% endhint %} -#### _Example: Upgrading from Umbraco 10 (LTS) to Umbraco 15 (STS)_ +#### Example: Upgrading from Umbraco 10 (LTS) to Umbraco 15 (STS) Between version 10 and 15, there is another LTS version: Umbraco 13. The first step is therefore to upgrade to Umbraco 13. After that, you can upgrade directly from Umbraco 13 to Umbraco 15. @@ -53,7 +53,7 @@ Look for the "**Upgrade from/to Umbraco xx"** boxes. These boxes contain importa * Follow the **requirements** for [local development](https://docs.umbraco.com/umbraco-cms/fundamentals/setup/requirements#local-development). * An Umbraco Cloud project running [the latest version of your current Umbraco CMS installation](https://our.umbraco.com/download/releases) * The **latest** .[NET version](https://dotnet.microsoft.com/en-us/download/visual-studio-sdks) is installed locally. -* **At least 2 environments** on your Cloud project. +* **At least two environments** on your Cloud project. * A backup of your project database. * Directly from your environment. See the [Database backups](../databases/backups.md) article, * Or clone down, restore the project, and back up the local database. @@ -73,7 +73,7 @@ Refer to the [Choose the correct .NET version](https://docs.umbraco.com/umbraco- ## Step 2: Clone down your environment -1. Clone down the **Development** environment. +1. Clone down the **left-most mainline environment**. 2. Build and run the [project locally](../set-up/working-locally.md#running-the-site-locally). 3. Log in to the backoffice. 4. Restore content from your Cloud environment. @@ -254,7 +254,7 @@ Remove the following files and folders _manually_ from your local project: * `/umbraco/UmbracoWebsite` * `/umbraco/config/lang` -Remove the same files from the development environment. This should be done from the **Development** environment through `KUDU` -> `Debug Console` -> `CMD` -> `Site` -> from both the `repository` and `wwwroot` folders. +Remove the same files from the left-most environment. This should be done from the left-most environment through `KUDU` -> `Debug Console` -> `CMD` -> `Site` -> from both the `repository` and `wwwroot` folders. @@ -283,13 +283,13 @@ You can choose between two approaches based on your needs: The following steps involve setting a **content-freeze** period on the project. It is recommended to coordinate this with your content editors before moving forward. {% endhint %} -1. Delete any environments between your left-most (Development) and production environment. -2. Create a new environment from the production environment. +1. Delete any environments between your left-most and production environments. +2. Create a new environment from the production environment - call it Staging. 3. Initiate **content-freeze**. 4. Import content using either of the following approaches: 1. [Restore content and media](../deployment/restoring-content/) directly from the backoffice. 2. Use the [Database Backup and Restore](../databases/backups.md) functionality in the Cloud Portal. -5. Deploy the upgrade from the left-most environment (Development). +5. Deploy the upgrade from the left-most environment. 6. Verify and test all functionality on the upgraded environment. 7. [Remove your custom hostname(s)](../set-up/project-settings/manage-hostnames/) from the production environment. 8. Ensure the hostname(s) no longer point to the production environment. diff --git a/umbraco-cloud/product-upgrades/manual-upgrades/README.md b/umbraco-cloud/product-upgrades/manual-upgrades/README.md index 3039861ea08..373d689eea2 100644 --- a/umbraco-cloud/product-upgrades/manual-upgrades/README.md +++ b/umbraco-cloud/product-upgrades/manual-upgrades/README.md @@ -6,13 +6,17 @@ description: >- # Upgrade your projects manually -In some cases, you might need to upgrade your Umbraco Cloud project manually. It's very similar to how you would upgrade any other Umbraco project but includes a few extra and **very important** steps. +In some cases, you might need to upgrade your Umbraco Cloud project manually. It's similar to how you would upgrade any other Umbraco project but includes a few extra and **important** steps. Umbraco Cloud project uses Umbraco Forms and Umbraco Deploy, which means there are also some dependencies you need to consider when upgrading your Umbraco Cloud project manually. ## Why and when would you do a manual upgrade? -By default, all Umbraco Cloud projects are automatically upgraded when we release new patches (e.g. 8.8.**1**) to the Umbraco CMS as well as Umbraco Forms and Umbraco Deploy. When we release a new _minor_ version (e.g 8.**8**) the upgrade is applied to the Umbraco Cloud engine, and **not to the individual projects** - the same goes for the release of new _major_ versions (e.g. **10**.0). For these minor and major versions, there will be an option on your Umbraco Cloud Development environment to apply the upgrade. The Umbraco Cloud engine will take care of the entire process, and you only need to make sure everything works after the upgrade has been applied. +By default, all Umbraco Cloud projects are automatically upgraded when we release new patches (like 8.8.**1**) to the Umbraco CMS. This also goes for Umbraco Forms and Umbraco Deploy. + +When a new _minor_ version (like 8.**8**) is released, the upgrade is applied to the Umbraco Cloud engine, and **not to the individual projects**. The same goes for the release of new major versions (like **10**.0). + +For minor and major versions, there will be an option on your left-most mainline environment to apply the upgrade. The Umbraco Cloud engine will take care of the entire process, and you only need to ensure everything works when upgrade is complete. We always recommend using the automatic and _semi-automatic_ upgrade options provided to you as part of your Umbraco Cloud project. With that said, it's also possible to upgrade your Umbraco Cloud project manually - this can be done with both patches and minor and major versions. diff --git a/umbraco-cloud/product-upgrades/manual-upgrades/manual-cms-upgrade.md b/umbraco-cloud/product-upgrades/manual-upgrades/manual-cms-upgrade.md index 77e2aecc691..d7740d09033 100644 --- a/umbraco-cloud/product-upgrades/manual-upgrades/manual-cms-upgrade.md +++ b/umbraco-cloud/product-upgrades/manual-upgrades/manual-cms-upgrade.md @@ -14,7 +14,7 @@ This article will give you a step-by-step on how to manually upgrade your Umbrac ## Prepare for the upgrade -* When upgrading a Umbraco Cloud project manually, the very first step is to either [clone down your Cloud Development environment to your local machine](../../set-up/working-locally.md) or pull down the latest changes for your development environment. +* When upgrading a Umbraco Cloud project manually, the first step is to either [clone down left-most mainline environment to your local machine](../../set-up/working-locally.md) or pull down the latest changes for your left-most mainline environment. * Navigate to the `/src/UmbracoProject/` folder to find the `.csproj` file. * Make sure you can run your Cloud project locally and restore content and media. It's important that you check that everything works once the upgrade has been applied and for this, you need to have a clone locally that resembles the Cloud environment as much as possible. @@ -203,7 +203,7 @@ When you've upgraded everything locally, and made sure that everything runs with * Stage and commit all changes in Git * Push the changes to the Cloud environment * When everything is pushed, head on over to the Umbraco Cloud Portal -* Access the backoffice of the Cloud environment you pushed the upgrade to - Development or Live +* Access the backoffice of the Cloud environment you pushed the upgrade * You will again be prompted to log in to complete the database upgrade * You will be sent to the backoffice once the upgrade is complete diff --git a/umbraco-cloud/product-upgrades/minor-upgrades.md b/umbraco-cloud/product-upgrades/minor-upgrades.md index ffdb1ac7237..99d77b68efd 100644 --- a/umbraco-cloud/product-upgrades/minor-upgrades.md +++ b/umbraco-cloud/product-upgrades/minor-upgrades.md @@ -26,10 +26,10 @@ With automatic upgrades enabled, all products on Umbraco Cloud will automaticall If you create a new project on Umbraco Cloud automatic upgrades are enabled by default. {% hint style="info" %} -For projects where automatic minor upgrades are enabled, having a Development environment is not compulsory. However, it is highly recommended to facilitate a smoother and more controlled upgrade experience. In cases where manual upgrades are necessary, a Development environment becomes essential. +For projects where automatic minor upgrades are enabled, having a secondary mainline environment is not required. However, it is highly recommended to facilitate a smoother and more controlled upgrade experience. In cases where manual upgrades are necessary, an additional environment becomes essential. {% endhint %} -A development environment is included in all Umbraco Cloud plans, except Starter. Find pricing details for Umbraco Cloud Starter plans on our [website](https://umbraco.com/products/umbraco-cloud/pricing). +A secondary mainline environment is included in all Umbraco Cloud plans, except Starter. Find pricing details for Umbraco Cloud Starter plans on our [website](https://umbraco.com/products/umbraco-cloud/pricing). ## Manual Minor Upgrades @@ -64,6 +64,6 @@ The upgrade process left off when it needed three more steps. These three steps - To complete the installer, you should visit the site: `https://dev-YOURSITEALIAS.euwest01.umbraco.io`. This will show you the installer screen, where you should insert your backoffice credentials and follow the process. It will run through a few steps, and later Umbraco will be updated to the latest version. 2. Export the metadata files. - The second thing you need to do is to regenerate the metadata files used for transferring items like document types, data types, and media types. This is done by accessing the Power tools (Kudu) on the project, opening the cmd prompt, and browsing to the wwwroot/data folder. Once there, you need to enter `echo > deploy-export`. This will generate the required files for the upgraded site to work with Umbraco Deploy. -3. The last thing to do is to go to the `/site/locks` folder (still through Kudu) and rename the file called `upgrading` to `upgraded-minor` - rename the file by typing `ren upgrading upgraded-minor`. This will indicate to Umbraco Cloud, that the development environment is now ready to deploy all its changes to the next environment. +3. The last thing to do is to go to the `/site/locks` folder (still through Kudu) and rename the file called `upgrading` to `upgraded-minor` - rename the file by typing `ren upgrading upgraded-minor`. This will indicate to Umbraco Cloud, that the left-most environment is now ready to deploy all its changes to the next environment. -Before deploying the upgrade to the next environment, you should verify that everything looks as expected on the development environment. +Before deploying the upgrade to the next environment, you should verify that everything looks as expected on the left-most environment. diff --git a/umbraco-cloud/product-upgrades/version-specific-upgrades/migrate-from-8-to-latest.md b/umbraco-cloud/product-upgrades/version-specific-upgrades/migrate-from-8-to-latest.md index 84a300d4aa8..7718873fee7 100644 --- a/umbraco-cloud/product-upgrades/version-specific-upgrades/migrate-from-8-to-latest.md +++ b/umbraco-cloud/product-upgrades/version-specific-upgrades/migrate-from-8-to-latest.md @@ -21,15 +21,15 @@ You also need to make sure that the packages that you are using are available on ## Prerequisites * A Umbraco 8 Cloud project running **the latest version of Umbraco 8**. -* A clean Cloud project running the latest version of Umbraco with **at least 2 environments**. +* A clean Cloud project running the latest version of Umbraco with **at least two environments**. * A backup of your Umbraco 8 project database. -We strongly recommend having at least **2 environments** on the new Umbraco project. +It is recommended to have at least **two environments** on the new Umbraco project. {% hint style="info" %} If your Umbraco 8 site is using Umbraco Forms, make sure to configure it to store data in the database, before beginning this tutorial [Follow the guide for migrating Umbraco Forms data to the database.](https://docs.umbraco.com/umbraco-forms/developer/forms-in-the-database) -Should something fail during the migration, the Development environment can be removed and re-added to start over on a clean slate. +Should something fail during the migration, the left-most environment can be removed and re-added to start over on a clean slate. {% endhint %} ## Video Tutorial @@ -47,7 +47,7 @@ If you use Umbraco Forms, make sure to have [`StoreUmbracoFormsInDbset`](https:/ 1. Create a backup of the database from your Umbraco 8 project using the [database backup guide](../../databases/backups.md). * Alternatively, you can clone the environment down and take a backup of the local Database after restoring. Make sure to restore both content and media from your Cloud environment after cloning it down. 2. Import the database backup into SQL Server Management Studio. -3. Clone down the **Development** environment from the **new** Cloud project. +3. Clone down the **left-most** mainline environment from the **new** Cloud project. 4. Test the project and make sure to log in to the backoffice. {% hint style="info" %} @@ -122,15 +122,15 @@ Depending on the extent of the project and the amount of custom code and impleme ## Step 4: Deploy and Test on Umbraco Cloud -Once the new Cloud project runs without errors on the local setup, the next step is to deploy and test on the Cloud **Development** environment. +After the project runs locally without errors, deploy and test it on the Cloud's left-most mainline environment. -1. Push the migration and changes to the Umbraco Cloud **Development** environment. +1. Push the migration and changes to the Umbraco Cloud **left-most** mainline environment. {% hint style="info" %} The deployment might take a bit longer than normal as a lot of changes have been made. {% endhint %} -2. Go to the backoffice of the **Development** environment once everything has been pushed. +2. Go to the backoffice of the **left-most** mainline environment once everything has been pushed. 3. Go to **Settings** and open the **Deploy** Dashboard. 4. Click on `Export Schema to Data Files` in the **Deploy Operations** section. * The deployment will result in either of the two: @@ -138,15 +138,15 @@ The deployment might take a bit longer than normal as a lot of changes have been * Select `Clear Signatures` from the **Deploy Operations** section. * Select `Update Umbraco Schema` from the **Deploy Operations** section to clear up the error. * `Last deployment operation completed` - * Everything checks out: The Development environment has been upgraded. -5. Transfer Content and Media from the local clone to the **Development** environment. + * Everything checks out: The left-most environment has been upgraded. +5. Transfer Content and Media from the local clone to the **left-most** mainline environment. * To transfer members make sure that the following Deploy settings are configured in the `appsettings.json`: [`AllowMembersDeploymentOperations` and `TransferMemberGroupsAsContent`](https://docs.umbraco.com/umbraco-deploy/deploy-settings#allowmembersdeploymentoperations-and-transfermembergroupsascontent). -6. Test **everything** in the **Development** environment. +6. Test **everything** in the **left-most** mainline environment. 7. Deploy to the **Live** environment. ## Step 5: Going live -1. Test **everything** in the **Development** environment until it runs without any errors. +1. Test **everything** in the **left-most** mainline environment until it runs without any errors. 2. Setup rewrites on the new Cloud project if relevant. 3. Assign hostnames to the project if relevant. diff --git a/umbraco-cloud/set-up/config-transforms.md b/umbraco-cloud/set-up/config-transforms.md index 20b639096a5..6167f4266f4 100644 --- a/umbraco-cloud/set-up/config-transforms.md +++ b/umbraco-cloud/set-up/config-transforms.md @@ -26,7 +26,7 @@ If you want to do a transform on your `Web.config` file for the Live environment `Web.Production.config` -The `{environment}` part needs to be replaced with the target environment, for which there are currently 3 possibilities for each project: +The `{environment}` part needs to be replaced with the target environment, for which there are currently three possibilities for each project: 1. `Production` 2. `Staging` @@ -34,7 +34,7 @@ The `{environment}` part needs to be replaced with the target environment, for w This file needs to be created on a local clone of your project, as this will ensure that the file is added to the project repository. -When the file is deployed to the Live environment, the transforms will be applied to the `Web.config` file in the `Root` of your project. In the case that you also have a Development and/or Staging environment, the `Web.Production.config` will **only** transform the `Web.config` on the Live environment. +When the file is deployed to the Live environment, the transforms will be applied to the `Web.config` file in the `Root` of your project. In the case that you have mutliple mainline environments, the `Web.Production.config` will **only** transform the `Web.config` on the Live environment. For each deployment, the Umbraco Cloud engine searches for all of the `.{environment}.config` files in your site and apply the transforms. @@ -60,7 +60,7 @@ Using the tool will let you test whether the transform file transforms your conf ## Examples -Rewrite rules are often something you only want to apply to your Live environment. To avoid the rewrites being applied to your Development and/or Staging environments, you can create a transform file to apply the rewrite rules to your Live environment only. +Rewrite rules are often something you only want to apply to your Live environment. To avoid the rewrites being applied to other mainline environments, create a transform file to apply the rewrite rules only to the Live environment. Here is an example of how that config transform would look: