Skip to content

Commit fd372a4

Browse files
authored
Merge pull request #7407 from umbraco/deploy-vale-fixes
Fixed vale errors for Deploy articles
2 parents 8f96654 + cde7bcf commit fd372a4

File tree

18 files changed

+54
-53
lines changed

18 files changed

+54
-53
lines changed

16/umbraco-deploy/deployment-workflow/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -23,13 +23,13 @@ In summary:
2323

2424
### Deploying meta data
2525

26-
In order to be able to transfer content and media, the source environment and the target environment needs to have the same setup - meaning they need to be completely in sync and have the same file structure. To achieve this you need to deploy your meta data changes to the target environment.
26+
To transfer content and media, the source and target environments 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 meta data changes to the target environment.
2727

2828
* [Deploying from your local machine to your environments](deploying-changes.md)
2929

3030
### Transfer Content and Media
3131

32-
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 production or staging environment.
32+
Moving your content and media between your environments is done through the Umbraco backoffice. You can transfer content from one environment to another, for example, from local to your development environment. You also have the option to restore content and media to your local or development environment from your production or staging environment.
3333

3434
* [Transfer Content and Media](content-transfer.md)
3535
* [Restore Content and/or Media](restoring-content/)

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ You want to transfer the whole site. You start from the `Home` node and choose t
3636

3737
1. Go to the Deployment dashboard by clicking on the Content section header.
3838
* You will be able to see which items are currently ready to be transferred - this will include both content and media that you've _queued for transfer_.
39-
2. Confirm by clicking **Transfer toDevelopment** and monitor the progress of the transfer.
39+
2. Confirm by clicking **Transfer to Development** and monitor the progress of the transfer.
4040

4141
<figure><img src="../.gitbook/assets/image (1).png" alt="Transfer queue"><figcaption><p>Transfer queue</p></figcaption></figure>
4242

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@ This operation is useful if you want to move to another Umbraco instance and mig
5050

5151
<div align="left">
5252

53-
<figure><img src="../.gitbook/assets/image (9).png" alt="Donwload the Deploy artifacts"><figcaption><p>Donwload the Deploy artifacts</p></figcaption></figure>
53+
<figure><img src="../.gitbook/assets/image (9).png" alt="Donwload the Deploy artifacts"><figcaption><p>Download the Deploy artifacts</p></figcaption></figure>
5454

5555
</div>
5656

16/umbraco-deploy/deployment-workflow/deploying-changes.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
description: "How to Deploy changes between a local machine and an environment in Umbraco Deploy using either a Git Gui or without."
2+
description: "How to Deploy changes between a local machine and an environment in Umbraco Deploy using either a Git GUI or without."
33
---
44

55
# Deploying Changes
@@ -47,4 +47,4 @@ When pulling new commits, it is a good idea to see if any of these commits conta
4747

4848
The local site should be running when you do this. The deploy marker will change to `deploy-progress` while updating the site and to `deploy-complete` when done. If there are any conflicts/errors you will see a `deploy-failed` marker instead, which contains an error message with a description of what went wrong.
4949

50-
Another way is to use the Deploy Dashboard in the Settings section of the Umbraco backoffice. Here you can see the status of ongoing or completed deployment processes. The status will show whether an operation has been triggered and whether it is in progress, has completed or has failed. The dashboard will show the status based on the marker files on the disk, eg. `deploy-progress`. From the Deploy Dashboard it is also possible to trigger processes. Learn more about this dashboard in the [Deployment ](README.md#deploy-dashboard)article.
50+
Another way is to use the Deploy Dashboard in the Settings section of the Umbraco backoffice. Here you can see the status of ongoing or completed deployment processes. The status will show whether an operation has been triggered and whether it is in progress, has completed or has failed. The dashboard will show the status based on the marker files on the disk, for example, `deploy-progress`. From the Deploy Dashboard it is also possible to trigger processes. Learn more about this dashboard in the [Deployment](README.md#deploy-dashboard)article.

16/umbraco-deploy/deployment-workflow/deploying-deletions.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -8,9 +8,9 @@ With Umbraco Deploy deletions are environment specific. This means that in order
88

99
In this article you can read about the correct way of deleting files, schema and content when using Umbraco Deploy.
1010

11-
When you are using Umbraco Deploy, you might have more than one environment - including a local clone of the project. These environments each have their own database. The databases will contain references to all of your content and media, as well as to all of your schema files (e.g. Document Types, Templates etc).
11+
When you are using Umbraco Deploy, you might have more than one environment - including a local clone of the project. These environments each have their own database. The databases contain references to all content, media, and schema files such as Document Types and Templates etc.
1212

13-
The databases are environment specific. When you deploy from one environment to another, Umbraco Deploy will compare incoming schema files with references to these in the databases using both _alias_ and _GUID_. If something doesn't add up - e.g. there is a mismatch between the database references and the files deployed - you will see an error. Learn more about this in the [Troubleshooting section](../troubleshooting.md).
13+
Databases are environment-specific. When deploying between environments, Umbraco Deploy compares incoming schema files with database references using both _alias_ and _GUID_. If a mismatch occurs between the database references and deployed files, an error appears. Learn more in the [Troubleshooting section](../troubleshooting.md).
1414

1515
The workflow described above does not pick up deletions of content and schema from the database, which is why you'll need to delete the content and/or schema on all your environments, in order to fully complete the deletion.
1616

@@ -32,15 +32,15 @@ Once the deployment is complete, you will notice the following:
3232

3333
You might wonder why the Document Type that you have deleted, is still there. The reason is, that deploy only deletes the associated UDA file, and not the actual Document Type in the database.
3434

35-
In order to completely delete the Document Type from your entire project, you need to delete it from the backoffice of any of the other environments you have as well. When the Document Type has been deleted from the backoffice of all environments and no UDA file exists, you can consider it completely gone.
35+
To fully delete a Document Type from the project, delete it from the backoffice of every environment in use. A Document Type is fully deleted once it has been removed from all environments and no UDA file remains.
3636

3737
You should however keep in mind that if you at any point during the process, save your Document Type again, a UDA file will be regenerated and when you start deploying changes between environments, this will likely end up recreating your deleted Document Type.
3838

3939
## Which deletions are deployed?
4040

4141
Every **file** that's deleted, will also be deleted on the next environment when you deploy. However, there are some differences depending on what you have deleted.
4242

43-
Here's an overview of what happens when you deploy various deletions to the next environment.
43+
Here's an overview of what happens when you deploy different deletions to the next environment.
4444

4545
### Deleting Schema (Document Types, Datatypes etc.)
4646

16/umbraco-deploy/deployment-workflow/restoring-content/README.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -12,25 +12,25 @@ The restore option also comes in really handy when you have content editors crea
1212

1313
There are four options when it comes to restoring content.
1414

15-
1. [Restore when starting up the project locally](./#restore-when-starting-up-the-project-locally)
16-
2. [Restore everything through the Umbraco backoffice](./#restore-everything-through-the-umbraco-backoffice)
17-
3. [Restore a single tree through the Umbraco backoffice](./#restore-a-single-tree-through-the-umbraco-backoffice)
15+
1. [Restore when starting up the project locally](#restore-when-starting-up-the-project-locally)
16+
2. [Restore everything through the Umbraco backoffice](#restore-everything-through-the-umbraco-backoffice)
17+
3. [Restore a single tree through the Umbraco backoffice](#restore-a-single-tree-through-the-umbraco-backoffice)
1818
4. [Partial Restores](partial-restore.md)
1919

2020
### Restore when starting up the project locally
2121

2222
The first time you run your project locally you will have the option to restore your content and media before going to the Umbraco backoffice.
2323

2424
{% hint style="info" %}
25-
This will restore **all** content and media, plus any other entities configured for back-office transfer.
25+
This will restore **all** content and media, plus any other entities configured for backoffice transfer.
2626
{% endhint %}
2727

2828
1. When your site is done spinning up, click the green _Restore_ button - this will restore all content and media.
2929
2. Wait till the process completes - this might take a while, depending on the amount of content and media you have on your Umbraco site.
3030
3. When it's complete select _Open Umbraco_ to go to the backoffice.
3131
4. You will now see all your content and media in the Umbraco backoffice.
3232

33-
![Restore from start-up](../../../umbraco-cloud/deployment/restoring-content/images/Normal-Restore.gif)
33+
![Restore from start-up](images/Normal-Restore.gif)
3434

3535
### Restore everything through the Umbraco backoffice
3636

@@ -45,7 +45,7 @@ The second option for restoring your content and media is found in the Umbraco b
4545
7. When it's done, click **...** next to the Content tree again and choose _Reload_ to see your content in the tree.
4646

4747
{% hint style="info" %}
48-
As well as content, media and any other entities configured for back-office transfer, will also be restored in the process.
48+
As well as content, media and any other entities configured for backoffice transfer, will also be restored in the process.
4949

5050
To see the media, go to the Media section and _Reload_ the tree.
5151
{% endhint %}
@@ -62,4 +62,4 @@ For example, if triggered from the content tree, only content entities will be r
6262

6363
### [Partial Restore](partial-restore.md)
6464

65-
By using the Partial Restore option, you can make sure that you only restore the part of the content that you need to work with. You can either restore a single item, or include all the descendents of that item too.
65+
By using the Partial Restore option, you can make sure that you only restore the part of the content that you need to work with. You can either restore a single item, or include all the descendants of that item too.

16/umbraco-deploy/deployment-workflow/restoring-content/partial-restore.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -16,9 +16,9 @@ You can use Partial Restore on
1616
In this scenario you've cloned down your environment to your local machine or setup a new environment. In both cases the new environment will have an empty Content section as well as an empty Media section.
1717

1818
{% hint style="info" %}
19-
Be aware that this feature will also restore all dependencies on the selected content.
19+
This feature also restores all dependencies of the selected content.
2020

21-
E.g. when you restore a content node which references media items as well as other content nodes, these will all be restored as well, including any parent nodes that these nodes depend on.
21+
For example, restoring a content node that references media or other content will also restore those items, including any parent nodes they depend on.
2222
{% endhint %}
2323

2424
Follow these steps to perform a partial restore to get only the parts you need:
@@ -57,4 +57,4 @@ Imagine that you are working with your Umbraco project locally. One of your cont
5757
6. Start the restore by clicking _Restore_
5858
7. When the restore is done, reload the content tree to see the changes
5959

60-
![Partial restore](../../../umbraco-cloud/deployment/restoring-content/images/partialRestore-onEnvWithContent.png)
60+
![Partial restore](images/partialRestore-onEnvWithContent.png)

16/umbraco-deploy/extending/extending.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -464,7 +464,7 @@ If the optimal deployment workflow for your entity is to have editors control th
464464

465465
An introduction to this feature can be found in the second half of [this recorded session from Codegarden 2021](https://youtu.be/8bgZmlJ7ScI?t=938).
466466

467-
There's also a code sample, demonstrated in the video linked above, available [here](https://github.com/AndyButland/RaceData).
467+
There's also a code sample, demonstrated in the video linked above, available at [GitHub](https://github.com/AndyButland/RaceData).
468468

469469
The following code shows the registration of an entity for Backoffice deployment, where we have the simplest case of a single tree for the entity.
470470

16/umbraco-deploy/getting-started/Streamlining-Local-Development/index.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,9 +18,9 @@ When working with Umbraco Cloud, this step is configured automatically for you w
1818

1919
The process works by using the marker file Umbraco Deploy uses to trigger an update of the Umbraco schema from the `.uda` files from source control.
2020

21-
If a file named `deploy-on-start` is found in the `/umbraco/Deploy` folder, an update will run automatically when the site starts up.
21+
If a file named `deploy-on-start` is found in the `/umbraco/Deploy` folder, an update will run automatically when the site starts up.
2222

23-
Therefore, if we ensure that the file is created everytime the source code is pulled from the remote repository, we can automate the update.
23+
Therefore, if we ensure that the file is created every time the source code is pulled from the remote repository, we can automate the update.
2424

2525
To do this, carry out the following steps:
2626

16/umbraco-deploy/getting-started/cicd-pipeline/ci-cd-azure-dev-ops.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -14,11 +14,11 @@ We then have a number of variables defined, that are used in the build configura
1414

1515
Most tasks in the pipeline are standard steps that will be used in any .NET web application release, such as the first steps:
1616

17-
\#1 Install of the NuGet tooling,
17+
1. Install of the NuGet tooling,
1818

19-
\#2 Restore of NuGet dependencies,
19+
2. Restore of NuGet dependencies,
2020

21-
\#3 And the project build.
21+
3. And the project build.
2222

2323
Additional steps can be added as required, for example for running automated tests.
2424

@@ -31,7 +31,8 @@ Firstly a web deployment (#4), takes the packaged build artifact and deploys it,
3131
The final step (#5) is Umbraco Deploy specific - to call a function defined in the PowerShell script and trigger the extraction. Replace `ApiSecret` with `ApiKey` if you're using the deprecated API key setting instead.
3232

3333
{% hint style="info" %}
34-
The Microsoft docs contain useful information, if you are unsure of how to set secrets for your pipeline:
34+
The Microsoft documentation contain useful information, if you are unsure of how to set secrets for your pipeline:
35+
3536
* [Set secret variables](https://learn.microsoft.com/en-us/azure/devops/pipelines/process/set-secret-variables?view=azure-devops&tabs=yaml%2Cbash)
3637

3738
* [Protecting secrets in Azure Pipelines](https://learn.microsoft.com/en-us/azure/devops/pipelines/security/secrets?view=azure-devops)

0 commit comments

Comments
 (0)