Skip to content

Commit 5e874b1

Browse files
eshanrnhgitbook-bot
authored andcommitted
GITBOOK-3: Replaced environment references in troubleshooting articles
1 parent fb1fd84 commit 5e874b1

File tree

5 files changed

+50
-46
lines changed

5 files changed

+50
-46
lines changed
Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,26 +1,26 @@
11
# Troubleshooting deployments
22

3-
Issues with deployments on Umbraco Cloud often come down to a misunderstanding on how to work with Umbraco Cloud. It is important to always work left to right as mentioned in the [Deployment section](../../deployment/README.md).
3+
Issues with deployments on Umbraco Cloud often come down to a misunderstanding of how to work with Umbraco Cloud. It is important to always work left to right, as mentioned in the [Deployment section](../../deployment/).
44

55
There are two ways to deploy on Umbraco Cloud, a deployment that transfers content and media:
66

7-
1. A Content [Transfer](../../deployment/content-transfer.md) / [Restore](../../deployment/restoring-content/)
8-
2. A [Deployment](../../deployment/cloud-to-cloud.md) that transfers structure files (doc types, data types, templates, dll's, etc.)
7+
1. A Content [Transfer](../../deployment/content-transfer.md) / [Restore](../../deployment/restoring-content/).
8+
2. A [Deployment](../../deployment/cloud-to-cloud.md) that transfers structure files (doc types, data types, templates, dll's, etc.).
99

10-
There are some common errors associated with both of these. Most of the time it is caused by conflicting [UDA files](../../set-up/power-tools/generating-uda-files.md#what-are-uda-files) between the two environments you are deploying between.
10+
There are some common errors associated with both of these. Most of the time, it is caused by conflicting [UDA files](../../set-up/power-tools/generating-uda-files.md#what-are-uda-files) between the two environments you are deploying between.
1111

1212
The most common [Deployment](../../deployment/cloud-to-cloud.md) issues are listed below with guides on how to fix them:
1313

14-
* [Collision Errors](structure-error.md)
15-
* [Dependency Exception](dependency-exceptions.md)
16-
* [Colliding Data Types](colliding-datatypes.md)
17-
* [Language Mismatch](language-mismatch.md)
18-
* [Deployment Failed (with no error message)](deployment-failed.md)
19-
* [Changes not being applied](changes-not-being-applied.md)
14+
* [Collision Errors](structure-error.md).
15+
* [Dependency Exception](dependency-exceptions.md).
16+
* [Colliding Data Types](colliding-datatypes.md).
17+
* [Language Mismatch](language-mismatch.md).
18+
* [Deployment Failed (with no error message)](deployment-failed.md).
19+
* [Changes not being applied](changes-not-being-applied.md).
2020

21-
The most common Content [Transfer](../../deployment/content-transfer.md) / [Restore](../../deployment/restoring-content/) issues are listed below:
21+
The most common Content [Transfer](../../deployment/content-transfer.md)/[Restore](../../deployment/restoring-content/) issues are listed below:
2222

23-
* [Schema mismatch](schema-mismatches.md)
24-
* [SQL Timeouts](https://docs.umbraco.com/umbraco-deploy/deploy-settings#timeout-settings)
25-
* [Dependency Exception](dependency-exceptions.md)
26-
* [Media path too long](path-too-long-exception.md)
23+
* [Schema mismatch](schema-mismatches.md).
24+
* [SQL Timeouts](https://docs.umbraco.com/umbraco-deploy/deploy-settings#timeout-settings).
25+
* [Dependency Exception](dependency-exceptions.md).
26+
* [Media path too long](path-too-long-exception.md).

umbraco-cloud/troubleshooting/deployments/colliding-datatypes.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -8,11 +8,11 @@ When creating a new environment on your Umbraco Cloud project, you might encount
88
* Multiple Media Picker (using Media Picker)
99
* Related Links
1010

11-
Since these 5 data types are part of the Umbraco CMS, these will be created by default on each new environment on Umbraco Cloud. If metadata files/structure files for these data types have been generated on your Live environment, you might run into extraction errors on your newly created Development or Staging environment. New environments will be exact clones of the Live environment, thus containing all structure and metadata files from that environment.
11+
Since these 5 data types are part of the Umbraco CMS, these will be created by default on each new environment on Umbraco Cloud. If metadata files/structure files for these data types have been generated on your Live environment, you might run into extraction errors on your newly created left-most environment. New environments will be exact clones of the Live environment, thus containing all structure and metadata files from that environment.
1212

1313
## How do I know I have this issue?
1414

15-
The issue will present itself as an extraction error on your Development or Staging environment once you've created them.
15+
The issue will present itself as an extraction error on your mainline environment once you've created them.
1616

1717
<figure><img src="../../.gitbook/assets/image (53).png" alt=""><figcaption></figcaption></figure>
1818

@@ -22,20 +22,20 @@ Open the error message by clicking **More info**.
2222

2323
In the case illustrated above, there are four data types and each has two `UDA files`.
2424

25-
What this means is that a file has been generated for each data type on both the Live and the Development environment. The Umbraco Deploy engine needs to create one instance of each data type but is currently not able to do so, since it doesn't know which files to build the data types based on.
25+
What this means is that a file has been generated for each data type on both the Live and the left-most environment. The Umbraco Deploy engine needs to create one instance of each data type but is currently not able to do so, since it doesn't know which files to build the data types based on.
2626

2727
See the steps below on how to resolve the issue.
2828

2929
## How to resolve the issue
3030

31-
1. Access the backoffice of the affected environment (Development or Staging)
32-
2. Find the **Data Types** folder in the Developer section
33-
3. Delete **only** the data types mentioned in the error message
31+
1. Access the backoffice of the affected left-most environment.
32+
2. Find the **Data Types** folder in the Developer section.
33+
3. Delete **only** the data types mentioned in the error message.
3434
* In the case above, I would need to delete _Member Picker_, _Multiple Media Picker_, _Related Links_, and _Content Picker_
35-
4. [Access Kudu](../../set-up/power-tools/) for the affected environment
36-
5. Follow the [Kudu Documentation](../../set-up/power-tools/manual-extractions.md) to run an extraction on the environment
37-
6. When you get a `deploy-complete` marker, the issue has been resolved!
35+
4. [Access Kudu](../../set-up/power-tools/) for the affected environment.
36+
5. Follow the [Kudu Documentation](../../set-up/power-tools/manual-extractions.md) to run an extraction on the environment.
37+
6. When you get a `deploy-complete` marker, the issue has been resolved.
3838

39-
When you've followed these steps, go through your Development / Staging environment and make sure everything has been created as expected.
39+
When you've followed these steps, go through your left-most environment and make sure everything has been created as expected.
4040

41-
The final step you need to take before your Development / Staging environment is completely in sync with your Live environment is to [restore the content](../../deployment/restoring-content/).
41+
The final step you need to take before your left-most environment is completely in sync with your Live environment is to [restore the content](../../deployment/restoring-content/).

umbraco-cloud/troubleshooting/deployments/schema-mismatches.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Schema Mismatches
22

3-
When transferring or restoring content between two Umbraco Cloud environments, you might run into **Schema mismatch** errors. These usually occur when the schema isn't in sync between the *source environment* and the *target environment*. Schema refers to Document Types, Media Types, Data Types, Templates, and Dictionary items)
3+
When transferring or restoring content between two Umbraco Cloud environments, you might run into Schema mismatch errors. These usually occur when the schema isn't in sync between the source environment and the target environment. Schema refers to Document Types, Media Types, Data Types, Templates, and Dictionary items.
44

55
In this article, you can learn how to resolve schema mismatch issues and how you can avoid them in the future.
66

@@ -22,8 +22,8 @@ To resolve this error, check for pending deployments on the source environments.
2222

2323
If there are no pending deployments in your source environment, there are two ways to go about resolving the schema mismatch:
2424

25-
1. Make a minor change to the schema with mismatches in the source environment (in the example above it would be the **Contact Us** document type).
26-
2. Deploy the change to the next environment
27-
* This will update your schema in the target environment and ensure it is in sync with the source environment
25+
1. Make a minor change to the schema with mismatches in the source environment (in the example above, it would be the **Contact Us** document type).
26+
2. Deploy the change to the next environment.
27+
* This will update your schema in the target environment and ensure it is in sync with the source environment.
2828

2929
If the mismatches involve differences in the `aliases` or `names`, changing these manually on the target environment will enable you to transfer your content.

umbraco-cloud/troubleshooting/deployments/structure-error.md

Lines changed: 17 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -14,15 +14,19 @@ Collisions for unique identifier "home":
1414
UdaFile: ~/deploy/revision/document-type__f848c577f02b4ee5aea84f87458072a4.uda
1515
```
1616

17-
The error means that two (or more) `.uda` files have been created for the same entity. The `.uda` files contain schema data for each of your entities e.g Document Types, Templates, Macros, Dictionary Items, Data types, etc (for a full list of these entities see [What are UDA files?](../../set-up/power-tools/generating-uda-files.md#what-are-uda-files)).
17+
The error means that two (or more) `.uda` files have been created for the same entity. The `.uda` files contain schema data for each of your entities. For example, Document Types, Templates, Macros, Dictionary Items, Data types, and so on. For a full list of these entities, see [What are UDA files?](../../set-up/power-tools/generating-uda-files.md#what-are-uda-files).
1818

1919
In this example, there are two `.uda` files that share the same alias which leads to a conflict: it is impossible for Deploy to know which of the files to use, so it gives up and sends an error back.
2020

2121
{% hint style="info" %}
22-
Does the collision error involve **Dictionary items**? Use this guide instead: [Troubleshooting duplicate dictionary items](duplicate-dictionary-items.md)
22+
If the collision error involves Dictionary Items, use this guide instead: [Troubleshooting duplicate dictionary items](duplicate-dictionary-items.md)
2323
{% endhint %}
2424

25-
You can run into an error like this on all of your Cloud environments. Sometimes you might also run into it, on a local clone of your project. This guide will use an example, where two files are colliding on a Development and a Live environment.
25+
You can run into an error like this on all of your Cloud environments. Sometimes you might also run into it on a local clone of your project.&#x20;
26+
27+
This guide uses an example where two files are colliding across two environments: a left-most environment and the Live environment.
28+
29+
For clarity, the left-most environment will be referred to as the Development environment throughout the guide.
2630

2731
## Table of content
2832

@@ -32,7 +36,7 @@ You can run into an error like this on all of your Cloud environments. Sometimes
3236
* [Getting your environments in sync](structure-error.md#getting-your-environments-in-sync)
3337

3438
{% hint style="info" %}
35-
When you have two or more Cloud environments, we recommend that you never create or make schema changes directly on the Live or Staging environments. You should work with schema only in your Development environment or even better, your local clone of the project.
39+
When you have two or more Cloud environments, it is recommended that you only work with schema on local, Development, or flexible environments.&#x20;
3640
{% endhint %}
3741

3842
## Video tutorial
@@ -43,7 +47,7 @@ Fixing collision errors tutorial
4347

4448
## Using the error message
4549

46-
In the example above the entity involved is a Document Type with "home" as the alias. There are two colliding files both located in the `/deploy/revision` folder. The files are colliding because they share the same alias but have different GUIDs (also the name of the files).
50+
In the example above, the entity involved is a Document Type with _home_ as the alias. There are two colliding files both located in the `/deploy/revision` folder. The files are colliding because they share the same alias but have different GUIDs (also the name of the files).
4751

4852
## Deciding which file you want to use
4953

@@ -67,7 +71,7 @@ For this example, it’s decided that the Document Type currently used on the Li
6771

6872
In order to figure out which of the two colliding `.uda` files are the one for the Document Type being used on the Live environment follow these steps:
6973

70-
1. Connect to the database of the Live environment using the [connect to your cloud database locally tutorial](../../databases/cloud-database/#connecting-to-your-cloud-database-locally)
74+
1. Connect to the database of the Live environment using the [connect to your cloud database locally tutorial](../../databases/cloud-database/#connecting-to-your-cloud-database-locally).
7175
2. Run one of the following queries on the database, depending on the type you see the error with
7276

7377
* Run the following query, if the error states that the error is a `Collisions for entity type "document-type"`:
@@ -111,13 +115,13 @@ You now know which `.uda` file you want.
111115
We strongly recommend that you resolve this locally since this will ensure that the changes you make are added to your Git repositories. Otherwise, you may end up having the same problem next time you deploy.
112116
{% endhint %}
113117

114-
1. Clone down the Development environment to your local machine
115-
2. Run the project locally and verify that you get the same extraction error as on your Cloud environments (_HINT: look for a `deploy-failed` marker in your local `/deploy` folder_)
116-
* When you run the project, you should see an error message in the browser once the site starts to build
118+
1. Clone down the Development environment to your local machine.
119+
2. Run the project locally and verify that you get the same extraction error as on your Cloud environments (_HINT: look for a `deploy-failed` marker in your local `/deploy` folder_).
120+
* When you run the project, you should see an error message in the browser once the site starts to build.
117121
3. Remove the wrong `.uda` file (It's the one we did not find in the live environment just before) from the `/deploy/revision` folder - you will not be able to see the Document Type in the backoffice because of the failed extraction.
118122
4. Open the Umbraco Backoffice and go to Settings -> Deploy to see the Deploy dashboard.
119123
5. Select `Schema deployment from data files` in the dropdown.
120-
6. You will now see a `deploy-complete` marker in your local `/deploy` folder
124+
6. You will now see a `deploy-complete` marker in your local `/deploy` folder.
121125
122126
{% hint style="info" %}
123127
**Does the error mention Templates?** You might experience that `.uda` files for a template are colliding. When this is the case, we recommend that you copy the content of the `cshtml` file associated with the template you want to keep on your project - this way you'll have a backup of the code you want to use.
@@ -127,12 +131,12 @@ We strongly recommend that you resolve this locally since this will ensure that
127131

128132
Before pushing the changes to the Development environment, you need to access the backoffice of the Development environment and remove the Document Type from there.
129133

130-
**Commit** and **push** the changes from your local clone to the Development environment, using your local Git client.
134+
Commit and push the changes from your local clone to the Development environment, using your local Git client.
131135

132136
When the push from local to the Development environment has been completed, refresh the Umbraco Cloud portal and you will see that the Development environment is now green, which means that the extraction error has been resolved.
133137

134-
### Does your Development still have the red indicator?
138+
### Does your Development Environment still have the red indicator?
135139

136-
Sometimes you might need to run another schema deployment on your Cloud environment after deploying to turn your environment _green_. To do this, follow the steps described in the [schema deployment guide](../../deployment/deploy-dashboard.md).
140+
Sometimes you might need to run another schema deployment on your Cloud environment after deploying to turn your environment green. To do this, follow the steps described in the [schema deployment guide](../../deployment/deploy-dashboard.md).
137141

138142
The final step is to deploy the pending changes from Development to your Live environment, to ensure everything is completely in sync.

umbraco-cloud/troubleshooting/log-files.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ Video example.
2222

2323
### On Umbraco Cloud Portal
2424

25-
1. Go to your project and click on the arrow next to the environment name.&#x20;
25+
1. Go to your project and click on the arrow next to the environment name.
2626

2727
<figure><img src="../.gitbook/assets/image (49).png" alt=""><figcaption></figcaption></figure>
2828
2. Click **Logs** to view the log details.
@@ -43,13 +43,13 @@ It is possible that a deployment failed so it is not the active deployment at th
4343

4444
## Environment logs
4545

46-
Whenever you push from local to staging or when you deploy using the Umbraco Cloud portal, you're deploying your site using Git. This works as follows: you commit changes to Git and push them to development, these changes is then stored in the `site > repository` folder. Then the state of the newest commit gets copied into the `wwwroot` folder, which is where your website lives.
46+
Whenever you push between environments or when you deploy using the Umbraco Cloud portal, you're deploying your site using Git. This works as follows: you commit changes to Git and push them to development, these changes is then stored in the `site > repository` folder. Then the state of the newest commit gets copied into the `wwwroot` folder, which is where your website lives.
4747

4848
When you're in Kudu, you can go up to the `site` folder and then the `deployments` folder. The `active` file has the identifier of the currently active deployment in it. If you go into the folder that has the same name as that identifier you can see a few files: `log.log`, `manifest` and `status.xml`.
4949

5050
* `status.xml` shows you detailed information of which commit was deployed to the `wwwroot` folder
5151
* `manifest` is used to track which files are in the currently active deployment so that additions, renames and deletions, can be detected for the next deploy (this is an internal file which you should not touch)
52-
* `log.log` shows you the same output you will have seen when pushing your changes using Git, it will show you what happened during the push and if any errors occurred. This file is especially useful when trying to find errors for deploys using the portal (so from dev > live or from dev > staging > live). Even though the last line may end with "Deployment successful" it is possible that there were errors or suspicious messages before that so make sure to give them a read.
52+
* `log.log` shows you the same output you will have seen when pushing your changes using Git, it will show you what happened during the push and if any errors occurred. This file is especially useful when trying to find errors for deploys using the portal (for example, from dev > live or from dev > staging > live). Even though the last line may end with "Deployment successful" it is possible that there were errors or suspicious messages before that so make sure to give them a read.
5353

5454
## Cleaning up the environment logs viewer
5555

0 commit comments

Comments
 (0)