Skip to content

Commit 23d35a1

Browse files
authored
Merge branch 'main' into update-acronyms
2 parents eee4f53 + 2c39089 commit 23d35a1

File tree

11 files changed

+163
-93
lines changed

11 files changed

+163
-93
lines changed

.github/styles/UmbracoDocs/Acronyms.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -86,3 +86,4 @@ exceptions:
8686
- MDN
8787
- JPG
8888
- JPEG
89+
- BCC

.github/styles/UmbracoDocs/Brands.yml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,3 +7,5 @@ swap:
77
microsoft: "'Microsoft'"
88
slack: "'Slack'"
99
azure: "'Azure'"
10+
gitbook: "'GitBook'"
11+
github: "'GitHub'"

.github/styles/UmbracoDocs/Names.yml

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,4 +12,3 @@ swap:
1212
cms: "'CMS'"
1313
"[aA]ngular[jJ][sS]": AngularJS
1414
SUITS: "'Sales'"
15-
aka: "'also known as"

.github/styles/UmbracoDocs/Terms.yml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,3 +13,5 @@ swap:
1313
etc.: "'and so on'"
1414
\b(?:eg|e\.g\.)[\s,]: "'for example'"
1515
\b(?:ie|i\.e\.)[\s,]: "'that is'"
16+
aka: "'also known as"
17+
docs: "'documentation'"

12/umbraco-forms/editor/attaching-workflows/workflow-types.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -87,6 +87,12 @@ Sends the result of the Form to the specified email address. The following confi
8787
* Reply To Email
8888
* Subject of the email (required)
8989

90+
For fields that accept multiple email addresses (Recipient Email, CC Email, BCC Email), you can separate addresses using semicolons (';') or commas (','). For example:
91+
92+
```none
93+
94+
```
95+
9096
If the _Sender Email_ field is not populated, the address used will be read from CMS configuration.
9197

9298
The [Content Settings](https://docs.umbraco.com/umbraco-cms/reference/configuration/contentsettings) value configured at `Umbraco:CMS:Content:Notifications:Email` will be used if provided.

13/umbraco-forms/editor/attaching-workflows/workflow-types.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -87,6 +87,12 @@ Sends the result of the Form to the specified email address. The following confi
8787
* Reply To Email
8888
* Subject of the email (required)
8989

90+
For fields that accept multiple email addresses (Recipient Email, CC Email, BCC Email), you can separate addresses using semicolons (';') or commas (','). For example:
91+
92+
```none
93+
94+
```
95+
9096
If the _Sender Email_ field is not populated, the address used will be read from CMS configuration.
9197

9298
The [Content Settings](https://docs.umbraco.com/umbraco-cms/reference/configuration/contentsettings) value configured at `Umbraco:CMS:Content:Notifications:Email` will be used if provided.
Lines changed: 75 additions & 43 deletions
Original file line numberDiff line numberDiff line change
@@ -1,99 +1,131 @@
1+
---
2+
description: Learn about the different ways available for installing Umbraco uMS on your project.
3+
---
4+
15
# Installation
26

3-
Please check [the requirements](../../../installing-umarketingsuite/system-requirements/) before you start installing the uMarketingSuite.
7+
This article covers two ways for installing Umbraco uMS:
8+
9+
* [Via NuGet](#installation-via-nuget), or
10+
* [Via a terminal](#installing-using-the-terminal).
411

5-
### Installation via NuGet
12+
{% hint style="info" %}
13+
Check [the requirements](../getting-started/for-developers/system-requirements.md) before you start installing Umbraco uMS.
14+
{% endhint %}
615

7-
Install uMarketingSuite via Nuget in your IDE such as Visual Studio, Jetbrains Rider, VSCode (With [C# DevKit](https://marketplace.visualstudio.com/items?itemName=ms-dotnettools.csdevkit)) or alternatively even the terminal. Below we show how to install uMarketingSuite via Visual Studio.
16+
## Installation via NuGet
817

9-
1. To install the uMarketingSuite via NuGet go to the NuGet package manager in Visual Studio
18+
Install Umbraco uMS via Nuget in your IDE such as Visual Studio, Jetbrains Rider or VSCode (With [C# DevKit](https://marketplace.visualstudio.com/items?itemName=ms-dotnettools.csdevkit)).
1019

11-
![]() 2. Search for the **uMarketingSuite**, select the package and install it in your project
20+
The example shown below uses the Nuget Package Manager in Visual Studio.
21+
22+
1. Open the project in Visual Studio.
23+
2. Find and open the NuGet package manager from the Tools menu.
24+
25+
![]()
26+
27+
3. Navigate to the **Browse** tab.
28+
4. Search for the **Umbraco uMS** package.
29+
5. Select the package.
30+
6. Choose which project to install it into.
31+
7. Install the package.
1232

1333
![]()
1434

1535
## Installing using the terminal
1636

17-
Alternatively you can install uMarketingSuite using the package manager console inside Visual Studio, type
37+
You can install Umbraco uMS using a terminal, like the Package Manager Console in Visual Studio. The steps for doing so are outlined below.
1838

19-
```
20-
PM> install-package uMarketingSuite
39+
1. Open the project in Visual Studio.
40+
2. Find and open the Package Manager Console from the Tools menu.
41+
3. Type the following into the terminal:
42+
43+
```console
44+
PM> install-package Umbraco uMS
2145
```
2246

23-
Or if you are using a Umbraco 9+ that runs on .NET you can open a terminal window and install the Nuget package with the following command, making sure you have navigated to the folder containing the Umbraco website you wish to install uMarketingSuite into.
47+
Alternatively, Umbraco uMS can be installed via the console on your operating machine.
2448

25-
```
26-
dotnet add package uMarketingSuite
49+
1. Open a terminal window on your operating system.
50+
2. Navigate to the folder containing your Umbraco website.
51+
3. Install the Umbraco uMS Nuget package with the following command:
52+
53+
```console
54+
dotnet add package Umbraco uMS
2755
```
2856

29-
### It really is simple as that 🎉
57+
{% hint style="info" %}
58+
If you have any trouble, please go to [Troubleshooting installs](../../../installing-umarketingsuite/troubleshooting-installs/).
59+
{% endhint %}
3060

31-
_If you have any trouble, please go to_ [_Troubleshooting installs_](../../../installing-umarketingsuite/troubleshooting-installs/)_._
61+
## Next steps
3262

33-
## Next steps...
63+
![]()
64+
65+
When you have installed the Umbraco uMS, build or restart your website and the **Marketing** section will appear in the backoffice, as shown above.
3466

35-
![]()\
36-
If you've installed the uMarketingSuite you can build or restart your website and automatically the **Marketing** section will appear in the backoffice, as shown above.
67+
The next step is to [configure a license](../../../installing-umarketingsuite/licensing/) and you are ready to go.
3768

38-
The next step is to [configure a license](../../../installing-umarketingsuite/licensing/) and you're ready to go, but to get the best out of uMarkerktingSuite make sure to follow these additional steps.
69+
To get the best out of Umbraco uMS it is recommended to consider the information detailed in the sections below.
3970

4071
### Umbraco Forms
4172

42-
If you've installed **Umbraco Forms** as well and want to automatically track submissions of Umbraco Forms. Please install the package [uMarketingSuite.UmbracoForms](https://www.nuget.org/packages/uMarketingSuite.UmbracoForms) via NuGet as well using your preferred approach as above.
73+
If you have installed **Umbraco Forms** as well and want to automatically track submissions of Umbraco Forms. Please install the package [uMarketingSuite.UmbracoForms](https://www.nuget.org/packages/uMarketingSuite.UmbracoForms) via NuGet as well using your preferred approach as above.
4374

44-
```
75+
PUT THE FOLLOWING TWO INTO TABS
76+
77+
```console
4578
PM> install package uMarketingSuite.UmbracoForms
4679
```
4780

48-
For modern Umbraco 9+ use
49-
50-
```
81+
```console
5182
dotnet add package uMarketingSuite.UmbracoForms
5283
```
5384

5485
### Clientside tracking
5586

56-
To capture events that happen on the clientside (frontend) of your website, you will need to add the [clientside tracking script](../../../analytics/clientside-events-and-additional-javascript-files/additional-measurements-with-our-ums-analytics-scripts/) by including this snippet on all of your pages.
87+
To capture events that happen on the clientside (frontend) of your website, you need to add the [clientside tracking script](../../../analytics/clientside-events-and-additional-javascript-files/additional-measurements-with-our-ums-analytics-scripts/). This is done by including the following snippet on all of your pages.
5788

58-
```
89+
```html
5990
<script src="/Assets/uMarketingSuite/Scripts/uMarketingSuite.analytics.js"></script>
6091
```
6192

6293
### Cockpit
6394

64-
Cockpit is a tool to help with testing segments and diagnose the data uMarkertingSuite is collecting and can be viewed on the frontend of your website, only if you are logged into Umbraco as well.\
65-
Install cockpit on your website by adding the following Razor Partial View in your templates in Umbraco just before the closing \</body> tag
95+
Cockpit is a tool to help with testing segments and diagnose the data uMarkertingSuite collects. It can be viewed on the frontend of your website, only if you are logged into Umbraco as well.
6696

67-
Learn more [what Cockpit is and how you can use](../../../installing-umarketingsuite/cockpit/) it.
97+
Install cockpit on your website by adding the following Razor Partial View in your templates in Umbraco before the closing `</body>` tag
6898

69-
```
99+
```html
70100
@Html.Partial("uMarketingSuite/Cockpit")</body>
71101
```
72102

73-
### Optional Extras
103+
Learn more [what Cockpit is and how you can use](../../../installing-umarketingsuite/cockpit/) it.
74104

75-
Here are some optional extras you can do to improve your experience with uMarketingSuite.
105+
### Optional Extras
76106

77-
1. Add a [Google Analytics bridging script](../../../analytics/clientside-events-and-additional-javascript-files/bridging-library-for-google-analytics/) that automatically sends events that you send to Google Analytics, to uMarketingSuite as well.
107+
Here are some optional extras you can do to improve your experience with uMS.
78108

79-
```
80-
<script src="~/Assets/uMarketingSuite/Scripts/uMarketingSuite.analytics.ga4-bridge.min.js"></script>
81-
```
82-
2. Optionally, add the [Google Analytics blocker detection script](../../../analytics/clientside-events-and-additional-javascript-files/google-analytics-blocker-detection/) as well. This gives you insights in which page traffic the uMarketingSuite will track, and Google Analytics won't track!
109+
* Add a [Google Analytics bridging script](../../../analytics/clientside-events-and-additional-javascript-files/bridging-library-for-google-analytics/) that automatically sends events that you send to Google Analytics, to uMS as well.
83110

84-
```
85-
<script src="/Assets/uMarketingSuite/Scripts/uMarketingSuite.analytics.blockerdetection.js"></script>
86-
```
111+
```html
112+
<script src="~/Assets/uMarketingSuite/Scripts/uMarketingSuite.analytics.ga4-bridge.min.js"></script>
113+
```
87114

88-
## That's it! Now you're ready to start! 🚀
115+
* Add the [Google Analytics blocker detection script](../../../analytics/clientside-events-and-additional-javascript-files/google-analytics-blocker-detection/). This gives you insights in which page traffic the uMS will track, and Google Analytics will not track.
89116

90-
Some final notes:
117+
```html
118+
<script src="/Assets/uMarketingSuite/Scripts/uMarketingSuite.analytics.blockerdetection.js"></script>
119+
```
91120

92121
### Cookie consent
93122

94-
If you would like to influence the default [uMarketingSuite cookie](../../../the-umarketingsuite-broad-overview/the-umarketingsuite-cookie/) behaviour please go [here](../../../security-privacy/gdpr/). Or go to an example [implementation using Cookiebot](../../../security-privacy/gdpr/how-to-become-gdpr-compliant-using-cookiebot/) which can be used as an example for other cookie consent providers.\
95-
Important! If you [change the default cookie behaviour](../../../the-umarketingsuite-broad-overview/the-umarketingsuite-cookie/module-permissions/) always make sure to perform a **client side reload of the initial page after cookie consent** or else the visitor referrer and/or campaigns will not be tracked!
123+
If you would like to influence the default [uMS cookie](../../../the-umarketingsuite-broad-overview/the-umarketingsuite-cookie/) behaviour please go [here](../../../security-privacy/gdpr/). Or go to an example [implementation using Cookiebot](../../../security-privacy/gdpr/how-to-become-gdpr-compliant-using-cookiebot/) which can be used as an example for other cookie consent providers.\
124+
125+
{% hint style="warning" %}
126+
If you [change the default cookie behaviour](../../../the-umarketingsuite-broad-overview/the-umarketingsuite-cookie/module-permissions/) make sure to perform a **client side reload of the initial page after cookie consent**. If this is not done, visitor referrer and/or campaigns will not be tracked.
127+
{% endhint %}
96128

97129
### Loadbalancing and CM / CD environments
98130

99-
Using a loadbalanced setup and/or separate CM and CD environments? Please check our documentation about this topic \[here]\(/installing-umarketingsuite/loadbalancing-and-cm-cd-environment
131+
Using a loadbalanced setup and/or separate CM and CD environments? Please check our documentation about this topic [here](/installing-umarketingsuite/loadbalancing-and-cm-cd-environment).

0 commit comments

Comments
 (0)