Skip to content

Commit 32c187e

Browse files
Sofie Toft Kristensengitbook-bot
authored andcommitted
GITBOOK-11: No subject
1 parent 64a3814 commit 32c187e

File tree

10 files changed

+32
-27
lines changed

10 files changed

+32
-27
lines changed

13/umbraco-deploy/README.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -2,26 +2,26 @@
22
description: Documentation on how to work with Umbraco Deploy.
33
---
44

5-
# What is Umbraco Deploy?
5+
# Umbraco Deploy Documentation
66

77
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.
88

9-
<table data-view="cards"><thead><tr><th></th><th></th><th data-hidden data-card-cover data-type="files"></th><th data-hidden data-card-target data-type="content-ref"></th></tr></thead><tbody><tr><td><strong>Set up Umbraco Deploy</strong></td><td>Learn how you can set up Umbraco Deploy on new and existing Umbraco projects.</td><td><a href=".gitbook/assets/update.png">update.png</a></td><td><a href="installation/install-configure.md">installation/install-configure.md</a></td></tr><tr><td><strong>Deployment workflow in</strong></td><td>Learn about how the Deployment workflow in Umbraco Deploy work.</td><td><a href=".gitbook/assets/lightbulb.png">lightbulb.png</a></td><td><a href="deployment-workflow/">deployment-workflow</a></td></tr><tr><td><strong>Upgrading</strong></td><td>Learn how you can upgrade Umbraco Deploy.</td><td><a href=".gitbook/assets/code_cursor.png">code_cursor.png</a></td><td><a href="upgrades/">upgrades</a></td></tr></tbody></table>
9+
<table data-view="cards"><thead><tr><th></th><th></th><th data-hidden data-card-cover data-type="files"></th><th data-hidden data-card-target data-type="content-ref"></th></tr></thead><tbody><tr><td><strong>Set up Umbraco Deploy</strong></td><td>Learn how you can set up Umbraco Deploy on new and existing Umbraco projects.</td><td><a href=".gitbook/assets/update.png">update.png</a></td><td><a href="installation/install-configure.md">install-configure.md</a></td></tr><tr><td><strong>Deployment workflow in</strong></td><td>Learn about how the Deployment workflow in Umbraco Deploy work.</td><td><a href=".gitbook/assets/lightbulb.png">lightbulb.png</a></td><td><a href="deployment-workflow/">deployment-workflow</a></td></tr><tr><td><strong>Upgrading</strong></td><td>Learn how you can upgrade Umbraco Deploy.</td><td><a href=".gitbook/assets/code_cursor.png">code_cursor.png</a></td><td><a href="upgrades/">upgrades</a></td></tr></tbody></table>
1010

1111
{% embed url="https://www.youtube-nocookie.com/embed/Fqfc-UL4q5U" %}
1212
Umbraco Deploy Overview
1313
{% endembed %}
1414

15-
{% content-ref url="getting-started/deploy-settings.md" %}
16-
[getting-started/deploy-settings.md](getting-started/deploy-settings.md)
15+
{% content-ref url="deploy-settings.md" %}
16+
[deploy-settings.md](deploy-settings.md)
1717
{% endcontent-ref %}
1818

19-
{% content-ref url="getting-started/extending.md" %}
20-
[getting-started/extending.md](getting-started/extending.md)
19+
{% content-ref url="extending/extending.md" %}
20+
[extending.md](extending/extending.md)
2121
{% endcontent-ref %}
2222

2323
{% content-ref url="troubleshooting.md" %}
24-
[getting-started/troubleshooting.md](troubleshooting.md)
24+
[troubleshooting.md](troubleshooting.md)
2525
{% endcontent-ref %}
2626

2727
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.

13/umbraco-deploy/SUMMARY.md

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@
44
* [Legacy Documentation](legacy-documentation.md)
55
* [Release notes](release-notes.md)
66
* [Troubleshooting](troubleshooting.md)
7+
* [Configuration](deploy-settings.md)
78

89
## Installation
910

@@ -22,9 +23,6 @@
2223
* [Azure DevOps](getting-started/cicd-pipeline/ci-cd-azure-dev-ops.md)
2324
* [Github actions](getting-started/cicd-pipeline/ci-cd-github-actions.md)
2425
* [Streamlining Local Development](getting-started/streamlining-local-development.md)
25-
* [Configuration](getting-started/deploy-settings.md)
26-
* [Extending](getting-started/extending.md)
27-
* [Handling Cache Refresher Notifications](getting-started/handling-cache-refresher-notifications.md)
2826

2927
## Deployment Workflow
3028

@@ -38,3 +36,8 @@
3836
* [Restoring content](deployment-workflow/restoring-content/README.md)
3937
* [Partial Restores](deployment-workflow/restoring-content/partial-restore.md)
4038
* [Deploy Dashboard](deployment-workflow/deploy-dashboard.md)
39+
40+
## Extending
41+
42+
* [Extend Deploy](extending/extending.md)
43+
* [Handling Cache Refresher Notifications](extending/handling-cache-refresher-notifications.md)
File renamed without changes.

13/umbraco-deploy/deployment-workflow/content-transfer.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ Media items are transferred the same way as content:
5151

5252
### Umbraco Forms
5353

54-
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.
54+
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.
5555

5656
Once the setting have been added to the source and target environment forms can be transferred the same way as content and media:
5757

13/umbraco-deploy/deployment-workflow/deploy-dashboard.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ Here you can see whether the latest deployment has been completed or failed. You
1616

1717
## Deploy Operations
1818

19-
With the Deploy operations, you can run different operations in Umbraco Deploy.&#x20;
19+
With the Deploy operations, you can run different operations in Umbraco Deploy.
2020

2121
<figure><img src="../.gitbook/assets/image (3).png" alt=""><figcaption><p>The different Deploy operations.</p></figcaption></figure>
2222

@@ -48,7 +48,7 @@ This operation is useful if you want to move to another Umbraco instance and mig
4848

4949
## Configuration Details
5050

51-
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.
51+
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.
5252

5353
<figure><img src="../.gitbook/assets/image (2).png" alt=""><figcaption><p>Example of Umbraco Deploy configuration.</p></figcaption></figure>
5454

File renamed without changes.
File renamed without changes.

13/umbraco-deploy/release-notes.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
---
22
description: >-
3-
Get an overview of the things changed and fixed in each version of Umbraco Deploy.
3+
Get an overview of the things changed and fixed in each version of Umbraco
4+
Deploy.
45
---
56

67
# Release notes
@@ -87,7 +88,7 @@ This section contains the release notes for Umbraco Deploy 13 including all chan
8788
#### [13.0.3](https://github.com/umbraco/Umbraco.Deploy.Issues/issues?q=is%3Aissue+is%3Aclosed+label%3Arelease%2F13.0.3) (January 16th 2024)
8889

8990
* Added configurable option to avoid overwriting of dictionary items with empty values [#191](https://github.com/umbraco/Umbraco.Deploy.Issues/issues/191)
90-
* For more details see the page on [Deploy's settings](./getting-started/deploy-settings.md).
91+
* For more details see the page on [Deploy's settings](deploy-settings.md).
9192
* Fixed regression issue with transfer of date values.
9293

9394
#### [13.0.2](https://github.com/umbraco/Umbraco.Deploy.Issues/issues?q=is%3Aissue+is%3Aclosed+label%3Arelease%2F13.0.2) (January 9th 2024)

13/umbraco-deploy/troubleshooting.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -38,25 +38,25 @@ In addition to transferring content via the backoffice, it is possible to move b
3838

3939
As this process requires less inter-environment communication, it's possible to transfer much larger amounts of content without running into the hard platform limits.
4040

41-
[Read more about the import/export feature here](./deployment-workflow/import-export.md).
41+
[Read more about the import/export feature here](deployment-workflow/import-export.md).
4242

4343
### Review timeouts
4444

45-
Firstly, you can review and update the [timeout settings available with Deploy](./getting-started/deploy-settings.md#timeout-settings). Increasing these from the default values may help, but won't necessarily resolve all issues. This is because, as noted, some timeouts are fixed values set by the hosting environment.
45+
Firstly, you can review and update the [timeout settings available with Deploy](deploy-settings.md#timeout-settings). Increasing these from the default values may help, but won't necessarily resolve all issues. This is because, as noted, some timeouts are fixed values set by the hosting environment.
4646

4747
### Use batch configurations
4848

4949
There are two places where Deploy operations can be batched. This allows breaking up of a single, long process into multiple, smaller ones. By doing this it's possible to complete each smaller operation within the platform imposed timeout.
5050

5151
#### For transfers to upstream environments
5252

53-
If transferring items from a downstream environment to an upstream one, it's possible to [configure a batch size](./getting-started/deploy-settings.md#batch-settings). With this in place, transfers will be batched into separate operations, allowing each single operation to complete before any hosting environment-enforced timeout.
53+
If transferring items from a downstream environment to an upstream one, it's possible to [configure a batch size](deploy-settings.md#batch-settings). With this in place, transfers will be batched into separate operations, allowing each single operation to complete before any hosting environment-enforced timeout.
5454

5555
This will take effect only for transfers to upstream environments and when multiple items are selected in the backoffice. An example is the selection of a single media folder containing many files.
5656

5757
#### For processing of a Deploy "package"
5858

59-
A package is an ordered structure containing all the items selected for a Deploy operation, plus all the determined dependencies and relations. The processing of this package in the target environment can also be batched via a [configuration setting](./getting-started/deploy-settings.md#batch-settings).
59+
A package is an ordered structure containing all the items selected for a Deploy operation, plus all the determined dependencies and relations. The processing of this package in the target environment can also be batched via a [configuration setting](deploy-settings.md#batch-settings).
6060

6161
When set, if the number of items determined for the package exceeds the batch size, the processing will be chunked into batches.
6262

@@ -76,27 +76,27 @@ Deploy will do comparisons between the entities in different environments to det
7676

7777
If a lot of files need to be checked, this can be slow, and a faster option is available that uses the file metadata. The only downside of changing this option is a marginally increased chance of Deploy considering a media file hasn't changed when it has. This would omit it from the deployment.
7878

79-
This option can be [set in configuration](./getting-started/deploy-settings.md#mediafilechecksumcalculationmethod).
79+
This option can be [set in configuration](deploy-settings.md#mediafilechecksumcalculationmethod).
8080

8181
### Consider disabling cache refresher notifications
8282

8383
When a Deploy operation completes, cache refresher notifications are fired. These are used to update Umbraco's cache and search index.
8484

8585
In production these should always be enabled, to ensure these additional data stores are kept up to date.
8686

87-
If attempting a one-off, large transfer operation, before a site is live, you could disable these via a [configuration setting](./getting-started/deploy-settings.md#suppresscacherefreshernotifications). That would omit the firing and handling of these notifications and remove their performance overhead. Following which you would need to ensure to rebuild the cache and search index manually via the backoffice _Settings_ dashboards.
87+
If attempting a one-off, large transfer operation, before a site is live, you could disable these via a [configuration setting](deploy-settings.md#suppresscacherefreshernotifications). That would omit the firing and handling of these notifications and remove their performance overhead. Following which you would need to ensure to rebuild the cache and search index manually via the backoffice _Settings_ dashboards.
8888

8989
### Review relation types included in deploy operations
9090

9191
As well as transferring entities between environments Deploy will also include the relations between them. As of 10.1.2 and 11.0.1, two relation types used for usage tracking are omitted by default. These do not need to be transferred as they are recreated by the CMS as part of the save operation on the entity.
9292

93-
If using an earlier version, or to make further adjustments, modify the [settings for relation types](./getting-started/deploy-settings.md#relationtypes) in configuration.
93+
If using an earlier version, or to make further adjustments, modify the [settings for relation types](deploy-settings.md#relationtypes) in configuration.
9494

9595
## Path too long exceptions
9696

9797
When restoring between different media systems exceptions can occur due to file paths. They can happen between a local file system and a remote system based on blob storage. What is accepted on one system may be rejected on another as the file path is too long. Normally this will only happen for files with particularly long names.
9898

99-
If you are happy to continue without throwing exceptions in these instances you can [modify the configuration](./getting-started/deploy-settings.md#continueonmediafilepathtoolongexception). If this is done such files will be skipped, and although the media item will exist there will be no associated file.
99+
If you are happy to continue without throwing exceptions in these instances you can [modify the configuration](deploy-settings.md#continueonmediafilepathtoolongexception). If this is done such files will be skipped, and although the media item will exist there will be no associated file.
100100

101101
## Schema files following upgrades
102102

13/umbraco-deploy/upgrades/version-specific.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
---
22
description: >-
3-
Version specific documentation for upgrading to new major versions of Umbraco Deploy.
3+
Version specific documentation for upgrading to new major versions of Umbraco
4+
Deploy.
45
---
56

67
# Version Specific Upgrade Details
@@ -25,7 +26,7 @@ Version 13 contains a number of breaking changes. We don't expect many projects
2526

2627
#### **Configuration**
2728

28-
* [Configuration of relations](../getting-started/deploy-settings.md#relationtypes) was changed from a list to a dictionary.
29+
* [Configuration of relations](../deploy-settings.md#relationtypes) was changed from a list to a dictionary.
2930

3031
```json
3132
// Before
@@ -47,7 +48,7 @@ Version 13 contains a number of breaking changes. We don't expect many projects
4748
},
4849
```
4950

50-
* [Configuration of value connectors](../getting-started/deploy-settings.md#valueconnectors) was changed from a list to a dictionary.
51+
* [Configuration of value connectors](../deploy-settings.md#valueconnectors) was changed from a list to a dictionary.
5152

5253
```json
5354
// Before
@@ -83,4 +84,4 @@ These updates are more minor. We don't expect many projects to be affected by th
8384

8485
## Legacy version specific upgrade notes
8586

86-
You can find the version specific upgrade notes for versions out of support in the [Legacy documentation on Github](https://github.com/umbraco/UmbracoDocs/blob/umbraco-eol-versions/11/umbraco-deploy/upgrades/version-specific.md).&#x20;
87+
You can find the version specific upgrade notes for versions out of support in the [Legacy documentation on Github](https://github.com/umbraco/UmbracoDocs/blob/umbraco-eol-versions/11/umbraco-deploy/upgrades/version-specific.md).

0 commit comments

Comments
 (0)