Merge pull request #6418 from umbraco/ums/initial-setup

Ums/initial setup

Author: sofietoft

13/umbraco-ums/.gitbook.yaml

@@ -0,0 +1,7 @@
+root: ./
+
+​structure:
+    readme: README.md
+    summary: SUMMARY.md
+
+redirects:

13/umbraco-ums/README.md

@@ -0,0 +1 @@
+# Umbraco uMS

13/umbraco-ums/SUMMARY.md

@@ -0,0 +1 @@
+# Table of contents

13/umbraco-ums/developers/README.md

@@ -0,0 +1 @@
+-

13/umbraco-ums/developers/ab-testing/README.md

@@ -0,0 +1,14 @@
+A/B testing is one of the main features of the uMarketingSuite. A/B testing allows you to test your website or specific webpages in a very easy and friendly way. The uMarketingSuite supports both the novice as the experienced A/B tester.
+
+This documentation section will help you out with A/B Testing:
+
+- A [brief overview](/a-b-testing/what-is-a-b-testing/) about what A/B testing is
+- The [kind of A/B Tests](/a-b-testing/types-of-a-b-tests/) that the uMarketingSuite supports
+- How you can [setup the A/B test](/a-b-testing/setting-up-the-a-b-test/)
+- How the [results during an A/B test](/a-b-testing/monitor-the-a-b-test/) can be analyzed
+- A more [detailed explaination](unpublished-item-09d829a1-c2cd-4f62-a552-67ee1867b4d8) how the uMarketingSuite A/B testing feature works
+- How [a visitor is assigned](/a-b-testing/a-b-test-distribution-algorithm/) a A, B or n-variant
+- How we [determine the winner](unpublished-item-737df3b6-823a-45fd-8e6b-3ebe5679ae74) of an experiment
+- How you could [implement your own algorithms](/a-b-testing/extending-the-algorithms/)
+
+![]()

13/umbraco-ums/developers/ab-testing/ab-test-distribution-algorithm.md

@@ -0,0 +1,9 @@
+The default implemented algorithm is based and randomness. As soon as a visitor visits the website or the specific webpage with an A/B test it get randomly assigned a variant. That variant is stored alongside the visitors cookie and as long as the visitor does not delete its cookie the same A/B test variant is shown.
+
+Because the algorithm is based on randomness the number of visitors are not exactly distributes amongst all visitors but slight difference can occur.
+
+In this A/B test you see for example that the variant distribution is not a perfect 33,333% (what you could expect with three variants) but there are slight differences.
+
+![]()
+
+In a later sprint (or if you're really in need of this) we will implement other A/B test algorithms, such as round-robin, as well.

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

@@ -0,0 +1,24 @@
+## C# API
+
+Note: this API is available for 1.10.0+
+
+### Active A/B test variants
+
+The currently active A/B test variants of a visitor can be retrieved in a few slightly different ways depending on your scenario.
+
+- **IAbTestingService.GetCurrentVisitorActiveAbTestVariants()**
+    - Namespace uMarketingSuite.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)**
+    - Namespace uMarketingSuite.Business.AbTesting
+    - To retrieve active A/B test variants on a specific page, no request context needed.
+    - The visitor external id can be retrieved using **IAnalyticsVisitorExternalIdHandler.GetExternalId()**
+- **IAbTestVisitorToVariantManager.GetActiveVisitorVariants(visitorExternalId)**
+    - Namespace uMarketingSuite.Business.AbTesting
+    - To retrieve *all* active A/B test variants of the given visitor throughout the website.
+    - The visitor external id can be retrieved using **IAnalyticsVisitorExternalIdHandler.GetExternalId()**
+
+Note you can simply inject the specified services into your own code. The code below uses the **IAbTestingService.GetCurrentVisitorActiveAbTestVariants()** by injecting the service into a controller: 
+
+    using uMarketingSuite.Business.AbTesting;using uMarketingSuite.Web.AbTesting;public class YourController : SurfaceController{    public YourController(IAbTestingService abTestingService)    {        var activeVariantsCurrentVisitor = abTestingService.GetCurrentVisitorActiveAbTestVariants();    }}

13/umbraco-ums/developers/ab-testing/extending-the-algorithms.md

@@ -0,0 +1,3 @@
+Unfortunately it is not easy at this moment to implement your own algorithm at this moment. We do want to support this in the future, but it does not have our highest priority at this moment. 
+
+If you do however think this should have a much higher priority, please [drop us a message](mailto:[email protected]?subject=I%20want%20to%20implement%20my%20own%20algorithms) and we will see what we can do for each other :)!

13/umbraco-ums/developers/ab-testing/finish-an-ab-test.md

@@ -0,0 +1,25 @@
+You can decide to finish an A/B test at any time. Normally you would end the test if it has been running long enough and you've collected enough data to gain enough confidence.
+
+The uMarketingSuite will let you know when we've collected enough data to make the results statistically significant. We will also tell you if we haven't collected enough data:
+
+![]()
+
+But even if we haven't collected enough data you can always create your own judgement of the running A/B Test. In the overview we have an overview of all tests and their performance:
+
+![]()
+
+To end a test you can click on "**End test**". This will open up a confirmation dialog which asks if you want to pick a winner directly or at a later moment. If you want to discuss the results with one of your colleagues or your client for example it makes sense to stop the A/B test not, but to complete it a later moment.
+
+![]()
+
+If you select "**Stop and complete now**" the A/B Test is stopped and you can select with variant was the winner:
+
+![]()
+
+You can always pick one of the variants or "**My test did not result in a winner**". After you confirm your selected winner the overview will show the picked winner:
+
+![]()
+
+Also the overview of A/B tests will not show that the A/B Test is stopped and a winner was selected:
+
+![]()

13/umbraco-ums/developers/ab-testing/front-end-rendering.md

@@ -0,0 +1,5 @@
+The A/B Test will automatically be rendered in your frontend. If you've setup a "[Single page A/B test](/a-b-testing/types-of-a-b-tests/single-page-a-b-test/)" the uMarketingSuite together with Umbraco will automatically render the correct properties.
+
+If you've setup of one of the other tests and added some CSS and JavaScript to your A/B Test we will automatically this JavaScript and CSS to your webpage.
+
+You do not have to do anything to render the A/B test. If want to run a more advanced A/B test that requires some coding as well, you can always do that. [Our reference](/a-b-testing/reference/) gives you an overview of all functions that we provide to you to create an advanced A/B test!