GITBOOK-6: Getting Started +

Author: Sofie Toft Kristensen

13/umbraco-ums/getting-started/for-developers/cockpit.md

@@ -1,10 +1,12 @@
 ---
-description: The Cockpit is a tool to let you view data directly on the front end of the website.
+description: >-
+  The Cockpit is a tool to let you view data directly on the front end of the
+  website.
 ---
 
 # Cockpit
 
-The cockpit gives you the option to check out all the stored data when browsing through the website. It is also a good way to verify your personalization setup.
+The cockpit lets you check out all the stored data when browsing the website. It is also a good way to verify your personalization setup.
 
 To enable the uMS Cockpit add the following code above the `</body`> tag.
 
@@ -14,48 +16,50 @@ To enable the uMS Cockpit add the following code above the `</body`> tag.
 
 Once the code is added, reload the page to see the uMS Cockpit on the left or right side of the screen:
 
-![]()
+![](../for-marketers-and-editors)
 
 Click **Open** to see all the features of the Cockpit:
 
-![]()
+![](../for-marketers-and-editors)
 
 ## Access to the cockpit
 
-When the uMS Cockpit code has been added to the page you can see it when you are logged in to Umbraco. Visitors of your website will not see the Cockpit.
+When the uMS Cockpit code has been added to the page you can see it when you are logged in to Umbraco. Visitors to your website do not have access to the Cockpit.
 
-If you do not see the Cockpit and Umbraco is running on a different domain please refer to the [load balancing / CM / CD environments](/installing-umarketingsuite/loadbalancing-and-cm-cd-environments/) section.
+If you do not see the Cockpit while Umbraco runs on a different domain please refer to the [load balancing / CM / CD environments](../../../../installing-umarketingsuite/loadbalancing-and-cm-cd-environments/) section.
 
-### Data reporting client side
+### Data reporting client-side
 
-If you have setup the [additional Analytics-script](/analytics/clientside-events-and-additional-javascript-files/additional-measurements-with-our-ums-analytics-scripts/) of the uMS you can find all tracked data in the Cockpit.
+If you have set up the [additional analytics script](../../../../analytics/clientside-events-and-additional-javascript-files/additional-measurements-with-our-ums-analytics-scripts/) of the uMS you can find all tracked data in the Cockpit.
 
 The following is tracked:
 
-- The time on page. This is defined betweened the time the page was loaded and the current time. If you visit the website at 11:23:12 and it is now 11:25:30, your time on page is 2 minutes and 18 seconds.
-- The engaged time on page. This measures the time you were active on the page. When you scroll, move your mouse, type or select text on the website you are considered "engaged". As soon as you stop one of these actions and have no other interaction in the next five seconds this engaged timer will be stopped. This could happen when you are browsing in another window or tab of your browser or system or when you left your computer. The time on page is still counting, but you are not engaged at that moment.
-- The script tracks the maximum scrolldepth that you have reached. This counts in absolute pixels and as a percentage.
-- All [fired events](/analytics/clientside-events-and-additional-javascript-files/create-your-own-events/) are tracked.
-- Every outclick to other domains, a pdf-file or excel-file is measured by default.
+* The time on page. This is defined between the time the page was loaded and the current time. If you visit the website at 11:23:12 and it is now 11:25:30, your time on page is 2 minutes and 18 seconds.
+* The engaged time on page. This measures the time you were active on the page. When you scroll, move your mouse, type or select text on the website you are considered "engaged". As soon as you stop one of these actions and have no other interaction in the next five seconds this engaged timer will be stopped. This could happen when you are browsing in another window or tab of your browser or system or when you leave your computer. The time on the page is still counting, but you are not engaged at that moment.
+* The script tracks the maximum scroll depth that you have reached. This counts in absolute pixels and as a percentage.
+* All [fired events](../../../../analytics/clientside-events-and-additional-javascript-files/create-your-own-events/) are tracked.
+* Every outclick to other domains, a pdf-file or excel-file is measured by default.
 
-![]()
+![](../for-marketers-and-editors)
 
-### Data reporting server side
+### Data reporting server-side
 
 In this section you can see all the data that is captured on the server side:
 
-- The browser,
-- The type of device,
-- The IP address (anonymized or not; depending on your [settings](/installing-umarketingsuite/configuration-options-1-x/))
-- The total number of pages visited in this session
-- The total number of sessions with this cookie
+* The browser,
+* The type of device,
+* The IP address (anonymized or not; depending on your [settings](../../../../installing-umarketingsuite/configuration-options-1-x/))
+* The total number of pages visited in this session
+* The total number of sessions with this cookie
 
-Also you have the option to delete your uMS cookie
+Also, you have the option to delete your uMS cookie
 
-![]()
+![](../for-marketers-and-editors)
 
 ### Segments
 
-In the segments section you can see which segments are configured and which are applied to the current visitor.
+In the segments section, you can see which segments are configured and which are applied to the current visitor.
+
+![](../for-marketers-and-editors)
 
-![]()
+![]()

13/umbraco-ums/getting-started/for-developers/configuration-options-1-x.md

@@ -2,7 +2,7 @@
 
 Most of the uMS configuration options are stored in the configuration file. For uMarketingSuite 1.x, the configuration file can be found in `/config/uMarketingSuite/umarketingsuite.config`. For uMS 2.x we have adopted the new standard for .NET Core applications, in which we make use of the `appsettings.json` (and environment variable support). See [Configuration options 2.x](../../../../installing-umarketingsuite/configuration-options-2-x/) if you are using uMS version 2.
 
-If you open the configuration file with your prefered texteditor, you can see all the options you can configure. If you make changes to the file you should touch the `web.config` in order to make sure these new settings are used. Making changes to the `web.config` file will restart the website.
+If you open the configuration file with your preferred text editor, you can see all the options you can configure. If you make changes to the file you should touch the `web.config` to ensure the new settings are used. Making changes to the `web.config` file will restart the website.
 
 The configuration file will look like this:
 

13/umbraco-ums/getting-started/for-developers/configuration-options-2-x.md

@@ -1,11 +1,16 @@
+---
+description: Get an overview of the configurations options in uMS.
+---
+
 # Configuration options 2.x
 
-Most of the uMS configuration options are stored in the configuration file. For uMS 2.x we have adopted the new standard for .NET Core applications, in which we make use of the `appsettings.json` (and environment variable support). Because of this new standard most of the configuration options no longer require the application to restart in order for them to take effect. This comes with a few with some exceptions.
+Most of the uMS configuration options are stored in the configuration file. For uMS 2.x we have adopted the new standard for .NET Core applications, in which we make use of the `appsettings.json` (and environment variable support). Because of this new standard, most configuration options no longer require the application to restart to take effect. This comes with a few exceptions.
 
-uMS 2.x ships with an **appsettings-schema.json** file, allowing Visual Studio or Jetbrains Rider to auto-complete the configuration options. It allows comes with information about default values and a description of what each configuration option does.
+uMS 2.x ships with an `appsettings-schema.json` file, allowing Visual Studio or Jetbrains Rider to auto-complete the configuration options. It comes with information about default values and a description of what each configuration option does.
 
 The default configuration will look like this:
 
+{% code title="appSettings.json" %}
 ```json
 {
   "uMarketingSuite": {
@@ -78,6 +83,7 @@ The default configuration will look like this:
   }
 }
 ```
+{% endcode %}
 
 All these settings are also visualized in the uMS. This overview can be found in the section 'Marketing' -> Settings -> Configuration.
 

13/umbraco-ums/getting-started/for-developers/content-delivery-network-recommendations.md

@@ -1,19 +1,21 @@
 ---
-description: Learn more about recommendations when working with the Content Delivery Network.
+description: >-
+  Learn more about recommendations when working with the Content Delivery
+  Network.
 ---
 
-# Content Delivert Network Recommendations
+# Content Delivery Network recommendations
 
-In this section you will find information and best-practices how to use a Content Delivery Network (CDN) in combination with uMarketingSuite.
+This article provides information and best practices on using Content Delivery Network (CDN)  with uMarketingSuite.
 
 ## Pages (HTML)
 
-You should not cache pages on CDN level. uMS is based on serving a unique page to every (returning) visitor. By enabling page caching every visitor will be assigned the same uMS ID and Analytics, A/B testing and Personalisation will not work correctly.
+D not cache pages on the CDN level. uMS is based on serving a unique page to every (returning) visitor. By enabling page caching every visitor will be assigned the same uMS ID and Analytics, A/B testing and Personalisation will not work correctly.
 
 ### Cache static files (CSS and JavaScript)
 
-It is possible to cache static CSS and JavaScript files. Please refer to the documentation of the CDN provider for the best-practice setup.
+It is possible to cache static CSS and JavaScript files. Refer to the documentation of the CDN provider for the best-practice setup.
 
-### Media files (Umbraco /media folder, images and PDF's)
+### Media files (Umbraco /media folder, images, and PDFs)
 
-It is possible to cache `/media` files. Please refer to the documentation of the CDN provider for best-practice the setup.
+It is possible to cache `/media` files. Refer to the documentation of the CDN provider for best-practice setup.

13/umbraco-ums/getting-started/for-developers/infrastructure-sizing.md

@@ -4,31 +4,31 @@ description: Learn more about recommendation when is comes to infrastructure and
 
 # Infrastructure sizing
 
-To determine the optimal infrastructure sizing the most important metric is the number of page views you need to process. Peak load is also an important factor.
+The number of page views and Peak Load are two important metrics for determining the optimal infrastructure sizing for a project.
 
-The following presents recommendations based on environment as well as the number of expected page views.
+The following presents recommendations based on the environment and the number of expected page views.
 
 ## Non-cloud
 
-- **100.000 page views per month or less:** Database: CPU 2, 4-8 GB RAM, 50GB disk
-- **500.000 page views per month or less:** Database: CPU 4, 8-16 GB RAM, 100GB SSD disk
-- **1.000.000 page views per month or less:** Database: CPU 8, 16-32 GB RAM, 250GB SSD disk
-- **1.000.000 page views per month or more:** Please [contact our Expert Services](mailto:[email protected]) team to discuss the infrastructure requirements.
+* **100.000 page views per month or less:** Database: CPU 2, 4-8 GB RAM, 50GB disk
+* **500.000 page views per month or less:** Database: CPU 4, 8-16 GB RAM, 100GB SSD disk
+* **1.000.000 page views per month or less:** Database: CPU 8, 16-32 GB RAM, 250GB SSD disk
+* **1.000.000 page views per month or more:** Please [contact our Expert Services](mailto:[email protected]) team to discuss the infrastructure requirements.
 
 ## Cloud environments
 
-Due to the rapidly changing naming and sizing of Azure instances we recommend using the appropriate supplier tools to determine the exact sizing. Base the exact sizing on the non-cloud recommendations above.  
+Due to the rapidly changing naming and sizing of Azure instances, we recommend using the appropriate supplier tools to determine the exact sizing. Base the sizing on the non-cloud recommendations above.
 
-In general, for Azure SQL use at least a S3 instance for production purposes.
+In general, for Azure SQL, use at least a S3 instance for production purposes.
 
 ## Umbraco Cloud
 
-- **100.000 page views per month or less:** Standard / Professional
-- **500.000 page views per month or less:** Professional
-- **500.000 page views per month or more:** Professional / Enterprise
+* **100.000 page views per month or less:** Standard / Professional
+* **500.000 page views per month or less:** Professional
+* **500.000 page views per month or more:** Professional / Enterprise
 
-Always discuss the exact requirements with your agency or the Umbraco Cloud team. If needed discuss Prioritized Cloud Computing, Prioritized Database Performance and Dedicated Resources based on the expected load.
+Always discuss the exact requirements with your agency or the Umbraco Cloud team. Discuss Prioritized Cloud Computing, Prioritized Database Performance, and Dedicated Resources based on the expected load.
 
 {% hint style="info" %}
-Above you will find general recommendations on which infrastructure parameters to use. While these should work well for most cases, you may need to adjust the infrastructure parameters to suit your page view processing workload. Large or heavily trafficked websites may have higher requirements. If you expect high page view peaks it is recommended to scale to a tier higher then normally.
+Above you will find general recommendations on which infrastructure parameters to use. While these should work well for most cases, you may need to adjust the infrastructure parameters to suit your page view processing workload. Large or heavily trafficked websites may have higher requirements. If you expect high page view peaks it is recommended to scale to a tier higher than normal.
 {% endhint %}

13/umbraco-ums/getting-started/for-developers/loadbalancing-and-cm-cd-environments.md

@@ -2,22 +2,22 @@
 description: Recommendations for using uMS within a load-balanced setup.
 ---
 
-# Load balancing and CM/CD Environments
+# Load Balancing and CM/CD Environments
 
 ## Umbraco setup
 
-Make sure your Umbraco is setup according to best-practices. Please refer to the [Umbraco documentation](https://docs.umbraco.com/umbraco-cms/fundamentals/setup/server-setup/load-balancing) for more details.
+Make sure your Umbraco is set up according to best practices. Please refer to the [Umbraco documentation](https://docs.umbraco.com/umbraco-cms/fundamentals/setup/server-setup/load-balancing) for more details.
 
 ## Cockpit
 
 For the Cockpit to function properly it is necessary that the cockpit can read the Umbraco login cookie. Umbraco and the site should run on the same domain or sub-domain.
 
 For example:
 
-**Umbraco:** `umbraco.domain.com`  
+**Umbraco:** `umbraco.domain.com`\
 **Site:** `domain.com`
 
-Make sure the AuthCookieDomain in your SecuritySettings of your Umbraco config has the following value:
+Make sure the `AuthCookieDomain` in your SecuritySettings of your Umbraco config has the following value:
 
 ```json
 "AuthCookieDomain": ".domain.com",
@@ -35,16 +35,16 @@ To learn more, read the [Load Balancing article](https://docs.umbraco.com/umbrac
 
 ## Bot detection (ping)
 
-uMS will perform a ping (POST) to detect if the [visitor is a visitor or a bot](/analytics/types-of-clients/). The `umbraco/umarketingsuite/pagedata/ping` URL should be accessible from the content delivery and front-end servers. Make sure no firewall or other mechanism is blocking POST requests to `umbraco/umarketingsuite/pagedata/ping`. If this URL is blocked, all visitors will be treated like a bot and no analytics data is collected.
+uMS will perform a ping (POST) to detect if the [visitor is a visitor or a bot](../../../../analytics/types-of-clients/). The `umbraco/umarketingsuite/pagedata/ping` URL should be accessible from the content delivery and front-end servers. Make sure no firewall or other mechanism is blocking POST requests to `umbraco/umarketingsuite/pagedata/ping`. If this URL is blocked, all visitors will be treated like a bot and no analytics data is collected.
 
 ## Configuration
 
-Make sure the `IsProcessingServer` is set to `true` on the content management (Umbraco) environment and to `false` on the content delivery or front-end servers. 
+Make sure the `IsProcessingServer` is set to `true` on the content management (Umbraco) environment and to `false` on the content delivery or front-end servers.
 
-The setting can be found in your `uMarketingSuite.config` ([uMarktingSuite v1.x](/installing-umarketingsuite/configuration-options-1-x/)) or `AppSettings.json` ([uMarketingSuite v2.x](/installing-umarketingsuite/configuration-options-2-x/)) file.
+The setting can be found in your `uMarketingSuite.config` ([uMarktingSuite v1.x](../../../../installing-umarketingsuite/configuration-options-1-x/)) or `AppSettings.json` ([uMarketingSuite v2.x](../../../../installing-umarketingsuite/configuration-options-2-x/)) file.
 
 ## Sticky sessions
 
 Sticky sessions, also known as session affinity, are essential for the proper functioning of uMS in a load-balanced environment. Sticky sessions can be enabled using different methods such as cookie-based, IP-based, or URL-based session affinity, depending on the load balancer configuration. By enabling sticky sessions, you can ensure that user sessions remain intact and data consistency is maintained across the uMarketingSuite application. Sticky sessions will ensure that analytics, A/B testing and personalization works properly.
 
-Please refer to the documentation or configuration settings of your load balancer for specific instructions on enabling sticky sessions.
+For specific instructions on enabling sticky sessions, refer to the documentation or configuration settings of your load balancer.

13/umbraco-ums/getting-started/for-developers/system-requirements.md

@@ -4,19 +4,19 @@ description: Learn about the system requirements before installing uMS.
 
 # System Requirements
 
-The uMS has the following requirements:
+uMS has the following requirements:
 
 * Umbraco version 8.7+, 9, 10, 11, 12 and 13.
-* SQL Server 2014+, LocalDB or Azure SQL.
-  * **SQL CE & SQLite is not supported.**
+* SQL Server 2014+, LocalDB, or Azure SQL.
+  * **SQL CE & SQLite are not supported.**
 
 {% hint style="info" %}
-It is recommended to upgrade your Umbraco installation to the latest version.
+It is recommended upgrading your Umbraco installation to the latest version.
 {% endhint %}
 
-See the [Troubleshooting](../../../../installing-umarketingsuite/troubleshooting-installs/)-section if you need to upgrade from SQL CE to SQL Server.
+See the [Troubleshooting](../../../../installing-umarketingsuite/troubleshooting-installs/) section if you need to upgrade from SQL CE to SQL Server.
 
-The uMS is compatible with Umbraco Cloud.
+uMS is compatible with Umbraco Cloud.
 
 ![]()