From c6b00727e318950412fa857b1140d56328cd10e0 Mon Sep 17 00:00:00 2001 From: Esha Noronha Date: Wed, 12 Feb 2025 11:17:06 +0100 Subject: [PATCH 1/5] Updated article as per styleguide --- umbraco-cloud/deployment/README.md | 54 +++++++++++++++--------------- 1 file changed, 27 insertions(+), 27 deletions(-) diff --git a/umbraco-cloud/deployment/README.md b/umbraco-cloud/deployment/README.md index 0b2371f7d98..f79c56f9d5a 100644 --- a/umbraco-cloud/deployment/README.md +++ b/umbraco-cloud/deployment/README.md @@ -6,64 +6,64 @@ description: >- # Deployment -Umbraco Cloud uses a deployment model that relies on Git, Kudu, and Umbraco Deploy core technology to move your changes from one environment to another. Umbraco Cloud uses a classic "left to right" deployment model - changes are first made in the Development or local environment and then deployed to the Live environment. +Umbraco Cloud uses a deployment model based on Git, Kudu, and Umbraco Deploy core technology to move changes between environments. This follows a "left to right" model—changes start in the Development or local environment and deploy to Live. {% hint style="info" %} -If your project contains a Staging environment, deployments will be made from Development to Staging and then from Staging to Live. +If a project includes a Staging environment, deployments move from Development to Staging and then from Staging to Live. {% endhint %} ![Left to right model](images/left-to-right.png) ## Deployment Approach -Umbraco Cloud uses a two-part deployment approach where we keep metadata (Document types, templates, etc) and content (Content nodes and Media) as separate parts of deployment. To be able to distinguish between the two types of deployments, we use the term _transfer_ for content and media deployments and the term _deploy_ for metadata deployments. In summary: +Umbraco Cloud separates metadata and content during deployment. Metadata includes Document Types, Templates, Forms, Views, and config files. Content includes nodes and media. -1. Metadata such as Document Types, Templates, Forms, Views, and config files are stored in a Git repository and are **deployed** between environments using either a Git client or the Umbraco Cloud Portal. -2. Content and Media items are **not** stored in the Git repository. These need to be **transferred** directly from the Umbraco backoffice using the **Queue for Transfer** option. Once a content editor has all the items needed for a transfer, they will use the **Deployment** Dashboard in the **Content** section to transfer the items in the queue. +**Key Terms:** -With this arrangement, you don't need to grant Umbraco Cloud portal access to your content editors. Instead, allow them access only to the required backoffice sections of your sites. This also allows developers to focus on deploying metadata that is stored in the site's Git repository and content editors to focus on transferring content that is stored as Umbraco data. +* **Deploy:** Moves metadata between environments using a Git client or the Umbraco Cloud Portal. -### Video Tutorial +* **Transfer:** Moves content and media directly via the Umbraco backoffice. -Learn more about the deployment approach in this video, which will also show you how to deploy metadata as well as how to transfer content and media. Below you'll find links to articles containing step-by-step guides for each approach. +**Deployment Types:** -{% embed url="https://www.youtube.com/embed/sjId_hN1ba0?rel=0" %} -Video example. -{% endembed %} +1. **Metadata Deployment:** Metadata, including Document Types, Templates, Forms, Views, and config files, is stored in a Git repository. These are **deployed** between environments using a Git client or the Umbraco Cloud Portal. +2. **Content and Media Transfer:** Content and Media items are **not** stored in the Git repository. Instead, they must be **transferred** directly from the Umbraco backoffice using the **Queue for Transfer** option. Once all required items are queued, the **Deployment** Dashboard in the **Content** section is used to complete the transfer. + +Content editors do not need Umbraco Cloud Portal access. They can manage content through the backoffice, while developers handle metadata deployments via Git. ### Deploying Metadata -To transfer content and media, the source environment and the target environment needs to have the same setup. They need to be in sync and have the same file structure. To achieve this you need to deploy your metadata changes to the target environment. +The source and target environments must be in sync before transferring content and media. Deploy metadata first to ensure consistency. * [Deploy changes from Local to Cloud](local-to-cloud.md) -* [Deploy changes from one Cloud environment to another](cloud-to-cloud.md) -* [How Forms are handled on Cloud](umbraco-forms-on-cloud.md) +* [Deploy changes between Cloud environments](cloud-to-cloud.md) +* [Umbraco Forms on Cloud](umbraco-forms-on-cloud.md) ### Transfer Content and Media -Moving your content and media between your environments is done through the Umbraco Backoffice. You can transfer content from one environment to another, e.g. from Local to your Development environment. You also have the option to restore content and media to your Local or Development environment from your Live or Staging environment. +Content and media move between environments through the Umbraco backoffice. Content can be transferred from Local to Development and restored from Live or Staging. * [Transfer Content and Media](content-transfer.md) -* [Restore Content and / or Media](restoring-content/) +* [Restore Content and Media](restoring-content/README.md) {% hint style="info" %} -Transferring and restoring content and media is the same whether you are working between Local and Cloud or you are working between two Cloud environments. +The transfer and restore process is the same for Local to Cloud and between Cloud environments. {% endhint %} ## [Deploy Settings](https://docs.umbraco.com/umbraco-deploy/deploy-settings) -All configuration for Umbraco Deploy is held in the `appSettings.json` file found at the root of your Umbraco website. +All configuration for Umbraco Deploy is stored in the `appSettings.json` file found at the root of your Umbraco website. ## Environment Restart -Some deployments can cause an Umbraco Cloud environment to restart. See the table below to learn which actions initiate an application restart. +Some deployments can trigger an Umbraco Cloud environment to restart. The table below outlines which actions initiate a restart. -| Action: | Application Restart? | -| --------------------------------- | -------------------- | -| Config file change | Yes | -| Metadata deployment | No | -| File change - Example: _css-file_ | No | -| Content and/or Media transfer | No | +| Action: | Application Restart? | +| ------------------------------------ | -------------------- | +| Config file change | Yes | +| Metadata deployment | No | +| File change (for example, CSS file) | No | +| Content or Media transfer | No | ### Manual Restart @@ -73,12 +73,12 @@ From the Umbraco Cloud Portal, you can manually restart your environments. ## Umbraco-cloud.json -You might notice a file in your cloud project called `umbraco-cloud.json`. This file tells the deployment engine where to deploy to, it knows which environment you’re currently on (for example, local or staging) and chooses the next environment in the list to deploy to. +The `umbraco-cloud.json` file defines deployment settings, identifies the current environment, and determines the next deployment target. ![Clone dialog](images/Umbraco-cloud-json.png) {% hint style="info" %} -You are free to update the `name` attribute in the `umbraco-cloud.json` file to make it clear in the **Workspaces** dashboard where you’re deploying to. So if you want to name the _Development_ environment to “Everything goes here” then you can do that and the name will be displayed on the dashboard when deploying to that environment. +The `name` attribute in the `umbraco-cloud.json` can be updated to clarify deployment destinations in the Workspaces dashboard. {% endhint %} ![clone dialog](images/change-env-name-v8.png) From 20a96acee9b21ebf0627481e24c28f9dadf2d553 Mon Sep 17 00:00:00 2001 From: Esha Noronha <82437098+eshanrnh@users.noreply.github.com> Date: Thu, 13 Feb 2025 13:25:03 +0100 Subject: [PATCH 2/5] Update umbraco-cloud/deployment/README.md Co-authored-by: sofietoft --- umbraco-cloud/deployment/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/umbraco-cloud/deployment/README.md b/umbraco-cloud/deployment/README.md index f79c56f9d5a..fa93fcba12c 100644 --- a/umbraco-cloud/deployment/README.md +++ b/umbraco-cloud/deployment/README.md @@ -6,7 +6,7 @@ description: >- # Deployment -Umbraco Cloud uses a deployment model based on Git, Kudu, and Umbraco Deploy core technology to move changes between environments. This follows a "left to right" model—changes start in the Development or local environment and deploy to Live. +Umbraco Cloud uses a deployment model based on Git, Kudu, and Umbraco Deploy core technology 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. {% hint style="info" %} If a project includes a Staging environment, deployments move from Development to Staging and then from Staging to Live. From 6f20b159780f2ebae18a7f6702409edc773d0714 Mon Sep 17 00:00:00 2001 From: Esha Noronha <82437098+eshanrnh@users.noreply.github.com> Date: Thu, 13 Feb 2025 13:25:19 +0100 Subject: [PATCH 3/5] Update umbraco-cloud/deployment/README.md Co-authored-by: sofietoft --- umbraco-cloud/deployment/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/umbraco-cloud/deployment/README.md b/umbraco-cloud/deployment/README.md index fa93fcba12c..c6025cbf270 100644 --- a/umbraco-cloud/deployment/README.md +++ b/umbraco-cloud/deployment/README.md @@ -16,7 +16,7 @@ If a project includes a Staging environment, deployments move from Development t ## Deployment Approach -Umbraco Cloud separates metadata and content during deployment. Metadata includes Document Types, Templates, Forms, Views, and config files. Content includes nodes and media. +Umbraco Cloud separates metadata and content during deployment. Metadata includes Document Types, Templates, Forms, Views, and config files. Content includes content items and media. **Key Terms:** From 4d2a2429073f74c078e2637f0de7d92239372f0c Mon Sep 17 00:00:00 2001 From: Esha Noronha <82437098+eshanrnh@users.noreply.github.com> Date: Thu, 13 Feb 2025 13:25:26 +0100 Subject: [PATCH 4/5] Update umbraco-cloud/deployment/README.md Co-authored-by: sofietoft --- umbraco-cloud/deployment/README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/umbraco-cloud/deployment/README.md b/umbraco-cloud/deployment/README.md index c6025cbf270..5cf08436747 100644 --- a/umbraco-cloud/deployment/README.md +++ b/umbraco-cloud/deployment/README.md @@ -26,8 +26,8 @@ Umbraco Cloud separates metadata and content during deployment. Metadata include **Deployment Types:** -1. **Metadata Deployment:** Metadata, including Document Types, Templates, Forms, Views, and config files, is stored in a Git repository. These are **deployed** between environments using a Git client or the Umbraco Cloud Portal. -2. **Content and Media Transfer:** Content and Media items are **not** stored in the Git repository. Instead, they must be **transferred** directly from the Umbraco backoffice using the **Queue for Transfer** option. Once all required items are queued, the **Deployment** Dashboard in the **Content** section is used to complete the transfer. +* **Metadata Deployment:** Metadata, including Document Types, Templates, Forms, Views, and config files, 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. Instead, they must be **transferred** directly from the Umbraco backoffice using the **Queue for Transfer** option. Once all required items are queued, the **Deployment** Dashboard in the **Content** section is used to complete the transfer. Content editors do not need Umbraco Cloud Portal access. They can manage content through the backoffice, while developers handle metadata deployments via Git. From fe28db064d93ee886d8bdc5e64e92b2a819d0d67 Mon Sep 17 00:00:00 2001 From: Esha Noronha Date: Thu, 13 Feb 2025 13:31:53 +0100 Subject: [PATCH 5/5] Removed Note --- umbraco-cloud/deployment/README.md | 4 ---- 1 file changed, 4 deletions(-) diff --git a/umbraco-cloud/deployment/README.md b/umbraco-cloud/deployment/README.md index 5cf08436747..db1621a9794 100644 --- a/umbraco-cloud/deployment/README.md +++ b/umbraco-cloud/deployment/README.md @@ -8,10 +8,6 @@ description: >- Umbraco Cloud uses a deployment model based on Git, Kudu, and Umbraco Deploy core technology 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. -{% hint style="info" %} -If a project includes a Staging environment, deployments move from Development to Staging and then from Staging to Live. -{% endhint %} - ![Left to right model](images/left-to-right.png) ## Deployment Approach