Cavemanon/cavemanon-wagtail-personalisation
Archived
7
Fork 0
Code Issues Pull Requests Activity

WIP Adds default rules documentation

Browse Source
This commit is contained in:
Jasper Berghoef
2017-04-14 13:56:51 +02:00
parent d6b4f45998
commit fe3fddab51
3 changed files with 18 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
docs/default_rules.rst Normal file
View File

@ -0,0 +1,14 @@
Included rules
==============
Time rule
---------
The time rule allows you to segment visitors based on the time of their visit.
==================== ================================================================================================
Option Functionality
==================== ================================================================================================
Start time
End time
==================== ================================================================================================

1
docs/index.rst
View File

@ -13,6 +13,7 @@ Welcome to the Wagxperience documentation!
getting_started getting_started
implementation implementation
usage_guide usage_guide
default_rules
Indices and tables Indices and tables

6
docs/usage_guide.rst
View File

@ -1,5 +1,5 @@
Usage guide Usage guide
=================================================== ===========
Creating a segment Creating a segment
------------------ ------------------
@ -12,7 +12,7 @@ On this page you will be presented with a form. Follow the steps to create a seg
1. Enter a name for your segment. 1. Enter a name for your segment.
2. (Optional) Select wether to match any or all defined rules. 2. (Optional) Select whether to match any or all defined rules.
``match any`` will result in a segment that is applied as soon as one of your rules matches the visitor. ``match any`` will result in a segment that is applied as soon as one of your rules matches the visitor.
When ``match all`` is selected, all rules must match before the segment is applied. When ``match all`` is selected, all rules must match before the segment is applied.
@ -23,7 +23,7 @@ On this page you will be presented with a form. Follow the steps to create a seg
4. Define your segment rules. 4. Define your segment rules.
Wagxperience comes with a basic set of rules that allow you to get started quickly. The rules you define will be evaluated once a visitor makes a request to your application. Wagxperience comes with a basic set of rules :doc:`default_rules` that allow you to get started quickly. The rules you define will be evaluated once a visitor makes a request to your application.
5. Save your segment. 5. Save your segment.