Skip to content

Commit

Permalink
GITBOOK-12: No subject
Browse files Browse the repository at this point in the history
  • Loading branch information
Sofie Toft Kristensen authored and gitbook-bot committed Nov 21, 2024
1 parent 32c187e commit f15e1ee
Show file tree
Hide file tree
Showing 8 changed files with 15 additions and 15 deletions.
4 changes: 2 additions & 2 deletions 13/umbraco-deploy/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,8 @@ Umbraco Deploy is a deployment tool that helps you with the process of transferr
Umbraco Deploy Overview
{% endembed %}

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

{% content-ref url="extending/extending.md" %}
Expand Down
2 changes: 1 addition & 1 deletion 13/umbraco-deploy/SUMMARY.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,6 @@
* [Legacy Documentation](legacy-documentation.md)
* [Release notes](release-notes.md)
* [Troubleshooting](troubleshooting.md)
* [Configuration](deploy-settings.md)

## Installation

Expand All @@ -23,6 +22,7 @@
* [Azure DevOps](getting-started/cicd-pipeline/ci-cd-azure-dev-ops.md)
* [Github actions](getting-started/cicd-pipeline/ci-cd-github-actions.md)
* [Streamlining Local Development](getting-started/streamlining-local-development.md)
* [Configuration](getting-started/deploy-settings.md)

## Deployment Workflow

Expand Down
2 changes: 1 addition & 1 deletion 13/umbraco-deploy/deployment-workflow/content-transfer.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ Media items are transferred the same way as content:

### Umbraco Forms

In order for Deploy to handle Forms data as content, you will need to ensure that the `transferFormsAsContent` setting in configuration is set to `true`. See details in the [Deploy Settings for Umbraco 9+](../deploy-settings.md) article.
In order for Deploy to handle Forms data as content, you will need to ensure that the `transferFormsAsContent` setting in configuration is set to `true`. See details in the [Deploy Settings for Umbraco 9+](../getting-started/deploy-settings.md) article.

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

Expand Down
2 changes: 1 addition & 1 deletion 13/umbraco-deploy/deployment-workflow/deploy-dashboard.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ This operation is useful if you want to move to another Umbraco instance and mig

## Configuration Details

In the Configuration details, you can see how Umbraco Deploy has been [configured](../deploy-settings.md) on your environment. You get an overview of the Setting options, the current value(s), and notes help you understand each of the settings. Updates to the need to be applied in the `appsettings.json` file.
In the Configuration details, you can see how Umbraco Deploy has been [configured](../getting-started/deploy-settings.md) on your environment. You get an overview of the Setting options, the current value(s), and notes help you understand each of the settings. Updates to the need to be applied in the `appsettings.json` file.

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

Expand Down
File renamed without changes.
2 changes: 1 addition & 1 deletion 13/umbraco-deploy/release-notes.md
Original file line number Diff line number Diff line change
Expand Up @@ -88,7 +88,7 @@ This section contains the release notes for Umbraco Deploy 13 including all chan
#### [13.0.3](https://github.com/umbraco/Umbraco.Deploy.Issues/issues?q=is%3Aissue+is%3Aclosed+label%3Arelease%2F13.0.3) (January 16th 2024)

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

#### [13.0.2](https://github.com/umbraco/Umbraco.Deploy.Issues/issues?q=is%3Aissue+is%3Aclosed+label%3Arelease%2F13.0.2) (January 9th 2024)
Expand Down
14 changes: 7 additions & 7 deletions 13/umbraco-deploy/troubleshooting.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,21 +42,21 @@ As this process requires less inter-environment communication, it's possible to

### Review timeouts

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

### Use batch configurations

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.

#### For transfers to upstream environments

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

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.

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

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

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

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

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.

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

### Consider disabling cache refresher notifications

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

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

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

### Review relation types included in deploy operations

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.

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

## Path too long exceptions

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.

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

## Schema files following upgrades

Expand Down
4 changes: 2 additions & 2 deletions 13/umbraco-deploy/upgrades/version-specific.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ Version 13 contains a number of breaking changes. We don't expect many projects

#### **Configuration**

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

```json
// Before
Expand All @@ -48,7 +48,7 @@ Version 13 contains a number of breaking changes. We don't expect many projects
},
```

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

```json
// Before
Expand Down

0 comments on commit f15e1ee

Please sign in to comment.