[ABTEST-36] DOC: Install and configure AB testing module(s) Created: 15/Jul/19  Updated: 16/Sep/20  Resolved: 16/Sep/20

Status: Closed
Project: A/B Testing
Component/s: None
Affects Version/s: None
Fix Version/s: None

Type: Task Priority: Neutral
Reporter: Julie Legendre Assignee: Alex Mansell
Resolution: Fixed Votes: 0
Labels: 1.0
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original Estimate: Not Specified

Attachments: PNG File image-2020-09-02-17-22-38-059.png    
Template:
Acceptance criteria:
Empty
Task DoR:
Empty
Date of First Response:
Epic Link: DOC: A/B Testing add-ons documentation
Sprint: Add-Ons 46
Story Points: 3

 Description   

Standard module page, see https://documentation.magnolia-cms.com/display/DOCS62/E-commerce+module as an example (minus the tabbed organisation for the different connectors).

Note that A/B/n Testing will also need the release history section at the bottom that is then included in the https://documentation.magnolia-cms.com/display/DOCS62/Connector+Pack+and+Special+Feature+changelog page.


Doc page: https://documentation.magnolia-cms.com/pages/viewpage.action?pageId=224797051

Useful links:

Tips:

 From Julie chat – Model after other Modules (for example Backup Module, Connector Packs, etc.) - copy and restrict page and work on the following:

  • Introduction
  • Module Structure
  • Configuration (if applicable)
  • Usage (from UI)
  • Release history/compatibility 

The following are also important to note:

  • Cache configuration
  • Scheduler configuration
  • What is the endpoint for? Retrieving data from DynamoDB? Can another data source be configured?
  • YAML file are typically the source for configuration


 Comments   
Comment by Julie Legendre [ 03/Oct/19 ]

Explain https://jira.magnolia-cms.com/browse/ABTEST-81 - How pages is a test are locked and unlocked.

Comment by Julie Legendre [ 07/Sep/20 ]

Hi amansell, looks good  i've put a few comments in the page.
I'd add an explanation of how the locking mechanism for pages used in tests work. There is nothing necessarily for dev users to do but I think it's valuable info for them to understand what is going on.

Comment by Alex Mansell [ 16/Sep/20 ]

Finalize module when post SNAPSHOT (ready for release)

Generated at Sun Feb 11 22:52:14 CET 2024 using Jira 9.4.2#940002-sha1:46d1a51de284217efdcb32434eab47a99af2938b.