GITBOOK-38: Official launch final touches

Author: Sofie Toft Kristensen

13/umbraco-engage/README.md

@@ -6,12 +6,6 @@ description: >-
 
 # Umbraco Engage Documentation
 
-{% hint style="info" %}
-This is the official documentation for the Release Candidate of Umbraco Engage.
-
-Learn more about the product and the expected release date on [the product pages on Umbraco.com](https://umbraco.com/products/add-ons/engage/).
-{% endhint %}
-
 {% hint style="warning" %}
 Umbraco Engage is currently only available for Umbraco 13.
 {% endhint %}
@@ -20,7 +14,7 @@ Umbraco Engage is a marketing suite that helps marketers and developers create p
 
 Explore the top features and learn more about Umbraco Engage on [Umbraco.com](https://umbraco.com/products/add-ons/engage/).
 
-<table data-view="cards"><thead><tr><th></th><th></th><th></th><th data-hidden data-card-target data-type="content-ref"></th><th data-hidden data-card-cover data-type="files"></th></tr></thead><tbody><tr><td></td><td><a href="installation/installation.md">Install Umbraco Engage</a></td><td>Ready to dive in? Check the installation guide to get started.</td><td><a href="broken-reference">Broken link</a></td><td><a href=".gitbook/assets/Documentations Icons_Umbraco_CMS_Install.png">Documentations Icons_Umbraco_CMS_Install.png</a></td></tr><tr><td></td><td><a href="getting-started/">Getting Started</a></td><td>Get an overview and learn how to set up Umbraco Engage.</td><td><a href="broken-reference">Broken link</a></td><td><a href=".gitbook/assets/Documentations Icons_Umbraco_Cloud_Getting_Started.png">Documentations Icons_Umbraco_Cloud_Getting_Started.png</a></td></tr><tr><td></td><td><a href="tutorials/">Tutorials</a></td><td>Find detailed step-by-step guides for personalization, analytics, A/B testing, and more.</td><td><a href="broken-reference">Broken link</a></td><td><a href=".gitbook/assets/Documentations Icons_Umbraco_CMS_Tutorials.png">Documentations Icons_Umbraco_CMS_Tutorials.png</a></td></tr></tbody></table>
+<table data-view="cards"><thead><tr><th></th><th></th><th></th><th data-hidden data-card-target data-type="content-ref"></th><th data-hidden data-card-cover data-type="files"></th></tr></thead><tbody><tr><td></td><td><a href="installation/installation.md">Install Umbraco Engage</a></td><td>Ready to dive in? Check the installation guide to get started.</td><td><a href="installation/installation.md">installation.md</a></td><td><a href=".gitbook/assets/Documentations Icons_Umbraco_CMS_Install.png">Documentations Icons_Umbraco_CMS_Install.png</a></td></tr><tr><td></td><td><a href="getting-started/">Getting Started</a></td><td>Get an overview and learn how to set up Umbraco Engage.</td><td><a href="getting-started/">getting-started</a></td><td><a href=".gitbook/assets/Documentations Icons_Umbraco_Cloud_Getting_Started.png">Documentations Icons_Umbraco_Cloud_Getting_Started.png</a></td></tr><tr><td></td><td><a href="tutorials/">Tutorials</a></td><td>Find detailed step-by-step guides for personalization, analytics, A/B testing, and more.</td><td><a href="broken-reference">Broken link</a></td><td><a href=".gitbook/assets/Documentations Icons_Umbraco_CMS_Tutorials.png">Documentations Icons_Umbraco_CMS_Tutorials.png</a></td></tr></tbody></table>
 
 ## Quick Links
 

13/umbraco-engage/SUMMARY.md

@@ -1,6 +1,7 @@
 # Table of contents
 
 * [Umbraco Engage Documentation](README.md)
+* [Support](support.md)
 
 ## Installation
 
@@ -119,7 +120,6 @@
 * [Headless](developers/headless/README.md)
   * [Using the Marketing API](developers/headless/using-the-marketing-api.md)
   * [Headless Example](developers/headless/headless-example.md)
-* [Support](developers/support.md)
 
 ## Security and Privacy
 

13/umbraco-engage/developers/ab-testing/csharp-api.md

@@ -10,22 +10,22 @@ description: >-
 
 You can retrieve the active A/B test variants for a visitor in different ways depending on your specific scenario:
 
-* **IAbTestingService.GetCurrentVisitorActiveAbTestVariants()**
+* `IAbTestingService.GetCurrentVisitorActiveAbTestVariants()`
   * Namespace: `Umbraco.Engage.Web.AbTesting`
   * Returns the active variants for the current visitor on the current page.
   * Can only be used with an active request context
-* **IAbTestingVisitorService.GetVisitorAbTestVariants(visitorExternalId, pageId, culture, contentTypeId)**
+* `IAbTestingVisitorService.GetVisitorAbTestVariants(visitorExternalId, pageId, culture, contentTypeId)`
   * Namespace: `Umbraco.Engage.Business.AbTesting`
   * Retrieves active A/B test variants on a specific page, without requiring a request context.
-  * The visitor external id can be retrieved using **IAnalyticsVisitorExternalIdHandler.GetExternalId()**
-* **IAbTestVisitorToVariantManager.GetActiveVisitorVariants(visitorExternalId)**
+  * The visitor external id can be retrieved using `IAnalyticsVisitorExternalIdHandler.GetExternalId()`
+* `IAbTestVisitorToVariantManager.GetActiveVisitorVariants(visitorExternalId)`
   * Namespace: `Umbraco.Engage.Business.AbTesting`
   * Retrieves _all_ active A/B test variants for the given visitor throughout the website.
-  * The visitor external id can be retrieved using **IAnalyticsVisitorExternalIdHandler.GetExternalId()**
+  * The visitor external id can be retrieved using `IAnalyticsVisitorExternalIdHandler.GetExternalId()`
 
 ### Example
 
-To use these services, inject the specified service into your code. The example below uses **IAbTestingService.GetCurrentVisitorActiveAbTestVariants()** by injecting the service into a controller:
+To use these services, inject the specified service into your code. The example below uses `IAbTestingService.GetCurrentVisitorActiveAbTestVariants()` by injecting the service into a controller:
 
 ```cs
 using Umbraco.Engage.Business.AbTesting;

13/umbraco-engage/developers/analytics/client-side-events-and-additional-javascript-files/google-analytics-blocker-detection.md

@@ -19,5 +19,3 @@ If you include the script one of the following events is sent:
 * Otherwise, the following event is sent: `umbEngage("send", "event", "Tracking", "Allowed", "Google Analytics");`
 
 To see the statistics of this event go to the Analytics section of Umbraco Engage and open the 'Events' report. Look for the category with the name 'Tracking'.
-
-![]()

13/umbraco-engage/developers/analytics/extending-analytics/getting-the-correct-ip-address.md

@@ -6,11 +6,11 @@ description: >-
 
 # Getting the Correct IP Address
 
-By default, Umbraco Engage extracts the IP address from the request by inspecting the **UserHostAddress** and the **X-Forwarded-For** header. The latter is commonly used if your website operates behind a load balancer. In most scenarios, this will correctly resolve the client's IP address.
+By default, Umbraco Engage extracts the IP address from the request by inspecting the `UserHostAddress` and the `X-Forwarded-For` header. The latter is commonly used if your website operates behind a load balancer. In most scenarios, this will correctly resolve the client's IP address.
 
-If IP addresses are not being resolved accurately, your website may be behind a load balancing server or another protected environment. It might not forward the original client IP in the default **X-Forwarded-For** header or could exclude it entirely.
+If IP addresses are not being resolved accurately, your website may be behind a load-balancing server or another protected environment. It might not forward the original client IP in the default `X-Forwarded-For` header or could exclude it entirely.
 
-In this case, you may need to provide a custom implementation of the **IHttpContextIpAddressExtractor** to handle your specific requirements.
+In this case, you may need to provide a custom implementation of the `IHttpContextIpAddressExtractor` to handle your specific requirements.
 
 The default extractor looks like this:
 
@@ -29,7 +29,7 @@ public string ExtractIpAddress(HttpContextBase context)
 }
 ```
 
-To override this behavior, implement your own **IHttpContextIpAddressExtractor** and instruct Umbraco to use your extractor instead of the default extractor:
+To override this behavior, implement your own `IHttpContextIpAddressExtractor` and instruct Umbraco to use your extractor instead of the default extractor:
 
 ```cs
 using Umbraco.Engage.Business.Analytics.Collection.Extractors;
@@ -47,11 +47,11 @@ public class CustomIpExtractorUserComposer : IUserComposer
 ```
 
 {% hint style="info" %}
-It is important that your UserComposer adjusts the service registration **after** Umbraco Engage has initialized.
+It is important that your `UserComposer` adjusts the service registration **after** Umbraco Engage has initialized.
 {% endhint %}
 
-This can be enforced using the **ComposeAfterAttribute**. Failing to add this attribute may result in Umbraco running your IUserComposer before the Umbraco Engage composer, causing your changes to be overwritten.
+This can be enforced using the `ComposeAfterAttribute`. Failing to add this attribute may result in Umbraco running your IUserComposer before the Umbraco Engage composer, causing your changes to be overwritten.
 
 Additionally, ensure you use `RegisterUnique<...>()` instead of `Register<...>()`. While you can use Register when multiple implementations of a single service exist, in this case, you want your own extractor to be resolved exclusively. Therefore, RegisterUnique will overwrite the Umbraco Engage extractor.
 
-After implementing both classes and running your project, your extractor should be called to resolve IP addresses. You can verify the output of your extractor by inspecting the **umbracoEngageAnalyticsIpAddress** database table. The last portion of the IP address may be anonymized (set to 0) if this option is enabled in the Umbraco Engage configuration file.
+After implementing both classes and running your project, your extractor should be called to resolve IP addresses. You can verify the output of your extractor by inspecting the `umbracoEngageAnalyticsIpAddress` database table. The last portion of the IP address may be anonymized (set to 0) if this option is enabled in the Umbraco Engage configuration file.

13/umbraco-engage/developers/analytics/extending-analytics/sending-data-to-the-gtm-datalayer.md

@@ -1,25 +1,25 @@
 ---
 description: >-
-  Discover how to push A/B testing and personalization variables from
-  Umbraco Engage to the Google Tag Manager (GTM) data layer in Razor templates.
+  Discover how to push A/B testing and personalization variables from Umbraco
+  Engage to the Google Tag Manager (GTM) data layer in Razor templates.
 ---
 
-# Sending data using Google Tag Manager
+# Sending data to the GTM Datalayer
 
 Umbraco Engage provides a partial view that pushes variables related to A/B testing and personalization to the Google Tag Manager (GTM) data layer.
 
 The following variables are pushed:
 
-* `inabtest: true` - if the visitor participates in an active A/B test on the page; otherwise **false**.
+* `inabtest: true` - if the visitor participates in an active A/B test on the page; otherwise `false`.
 
 {% hint style="info" %}
 This will also be **true** if the visitor is assigned to the "A" variant which is the original page.
 {% endhint %}
 
-* `abtestname` - The name of the A/B test the visitor is participating in. If there is no active A/B test, the value will be **null**
-* `abtestvariant` - The name of the A/B test variant assigned to the visitor. If there is no active A/B test, the value will be **null**
-* `personalized: true` - If personalization is applied to the page for the visitor; otherwise **false**.
-* `personalizationname` - The name of the active personalization. If there is no active personalization, the value will be **null**.
+* `abtestname` - The name of the A/B test the visitor is participating in. If there is no active A/B test, the value will be `null`
+* `abtestvariant` - The name of the A/B test variant assigned to the visitor. If there is no active A/B test, the value will be `null`
+* `personalized: true` - If personalization is applied to the page for the visitor; otherwise `false`.
+* `personalizationname` - The name of the active personalization. If there is no active personalization, the value will be `null`.
 
 To render the partial view in your Razor template, use the following line:
 

13/umbraco-engage/developers/analytics/forms.md

@@ -9,7 +9,7 @@ To track Umbraco Forms submissions, you need to install [Umbraco Forms](https://
 
 ## Summary
 
-Umbraco Engage measures interactions with Umbraco Forms on your website automatically if you include the Umbraco Engage [analytics JavaScript file](client-side-events-and-additional-javascript-files/additional-measurements-with-the-analytics-scripts.md). No additional configuration is needed. The data is visualized in the backoffice in **Engage > Analytics > Forms**.
+Umbraco Engage measures interactions with Umbraco Forms on your website automatically if you include the Umbraco Engage [analytics JavaScript file](client-side-events-and-additional-javascript-files/additional-measurements-with-the-analytics-scripts.md). No additional configuration is needed. The data is visualized in the backoffice in Engage > Analytics > Forms.
 
 The following is measured:
 
@@ -26,7 +26,7 @@ The following is measured:
 It is possible to track a specific visitor to your website and see if they have made any form submissions. To do so, follow these steps:
 
 1. Edit the Umbraco Form you wish to track visitors for and go to the **Design** view.
-2. Add a new field to your form called '**Analytics - VisitorId**\`.
+2. Add a new field to your form called '`Analytics - VisitorId`\`.
 3. Give the new form field a name such as **Visitor ID**.
 4. Specify a URL in the settings of the field type called **Template**:
 

13/umbraco-engage/developers/analytics/location.md

@@ -5,22 +5,26 @@ description: Learn how to implement an IP to location provider.
 
 # Capture location data
 
-The localization information is displayed under the **Location** tab in the **Analytics** section of Umbraco Engage dashboard.
+The localization information is displayed under the **Location** tab in the **Analytics** section of the Umbraco Engage dashboard.
 
-Umbraco Engage Analytics natively supports storing and reporting localization information for incoming traffic. Localization refers to identifying the (physical) origin of an incoming request. Web requests from a visitor's browser do not contain location information, so you must provide an implementation for this.
+Umbraco Engage Analytics natively supports storing and reporting localization information for incoming traffic. Localization refers to identifying the (physical) origin of an incoming request. Web requests from a visitor's browser do not contain location information. This means that you must implement this.
 
-Most localization services, such as Maxmind, use IP addresses to perform a (rough) lookup. The information is compiled into a database where lookups can be performed. However IP addresses do not contain any information regarding their (physical) origin, rather they only identify a device on the internet. Localization information for any given IP address is tracked manually and can change overtime. We recommend either using an external service or acquiring a copy of a GeoIP database for localization lookup purposes.
+Most localization services, such as Maxmind, use IP addresses to perform a (rough) lookup. The information is compiled into a database where lookups can be performed. IP addresses do not contain any information regarding their (physical) origin, rather they only identify a device on the internet. Localization information for any given IP address is tracked manually and can change over time. We recommend either using an external service or acquiring a copy of a GeoIP database for localization lookup purposes.
 
 ## Implementation
 
-Once you have a service that can provide localization information, integrating it into Umbraco Engage is straightforward.
+Once you have a service that can provide localization information, you must integrate it with Umbraco Engage.
 
-For this purpose, implement the interface **Umbraco.Engage.Business.Analytics.Processing.Extractors.IRawPageviewLocationExtractor**. This interface allows the localization information for a pageview, defined as a single visitor's visit to a specific point in time. The pageview contains the property **IpAddress** which can be used for Geo IP lookup.
+Implement the following interface:
 
-First, define a class that implements **ILocation**, to hold the localization information that will be returned through the interface in our implementation:
+`Umbraco.Engage.Business.Analytics.Processing.Extractors.IRawPageviewLocationExtractor`
 
-{% code overflow="wrap" lineNumbers="true" %}
+This interface allows information about localization for a pageview, defined as a single visitor's visit to a specific point in time. The page view contains the `IpAddress` property that can be used for Geo IP lookup.
 
+1. Define a class that implements `ILocation`
+   1. This will hold the localization information that will be returned through the interface in our implementation.
+
+{% code overflow="wrap" %}
 ```cs
 using Umbraco.Engage.Business.Analytics.Processed;
 public class GeoIpLocation : ILocation {
@@ -30,13 +34,12 @@ public class GeoIpLocation : ILocation {
     public string City { get; set; }
 }
 ```
-
 {% endcode %}
 
-Next, implement the location extractor to read and validate the incoming IP address and filter out local IP addresses with the native **IsLoopback** method. Then, call your Geo IP localization implementation:
-
-{% code overflow="wrap" lineNumbers="true" %}
+2. Implement the location extractor to read and validate the incoming IP address and filter out local IP addresses with the native `IsLoopback` method.
+3. Call your Geo IP localization implementation.
 
+{% code overflow="wrap" %}
 ```cs
 using Umbraco.Engage.Business.Analytics.Processing.Extractors;
 public class MyCustomLocationExtractor : IRawPageviewLocationExtractor
@@ -63,13 +66,15 @@ public class MyCustomLocationExtractor : IRawPageviewLocationExtractor
     }
 }
 ```
-
 {% endcode %}
 
-Lastly, let the IoC container know to use your implementation for the **IRawPageviewLocationExtractor**. Umbraco Engage has a default implementation of this service, which only returns null. This default service is registered using Umbraco's **RegisterUnique** method. To override this service, call RegisterUnique **after** the Umbraco Engage dependencies have been initialized, which is **after** the **UmbracoEngageApplicationComposer**:
+4. Let the IoC container know to use your implementation for the `IRawPageviewLocationExtractor`.
+
+Umbraco Engage has a default implementation of this service, which only returns null. This default service is registered using Umbraco's `RegisterUnique` method.
 
-{% code overflow="wrap" lineNumbers="true" %}
+5. Override this service by calling `RegisterUnique` **after** the `UmbracoEngageApplicationComposer`.
 
+{% code overflow="wrap" %}
 ```cs
 using Umbraco.Engage.Business.Analytics.Processing.Extractors;
 using Umbraco.Engage.Common.Composing;
@@ -85,13 +90,12 @@ public class UmbracoEngageComposer: IComposer
     }
 }
 ```
-
 {% endcode %}
 
-After implementing this, Umbraco Engage will begin collecting and displaying localization information for pageviews. This can be viewed in the Analytics section of the Umbraco Engage dashboard.
+After implementing this, Umbraco Engage collects and displays localization information for pageviews. This can be viewed in the Analytics section of the Umbraco Engage dashboard.
 
 {% hint style="info" %}
-If the custom implementation returns **null**, **ILocation** will display as "Unknown".
+If the custom implementation returns `null`, `ILocation` will display as "Unknown".
 {% endhint %}
 
 {% hint style="info" %}