[DOCU-1582] Periscope module page Created: 05/Jul/18  Updated: 14/Sep/18  Resolved: 10/Sep/18

Status: Closed
Project: Documentation
Component/s: None
Affects Version/s: None
Fix Version/s: 6.0

Type: Task Priority: Neutral
Reporter: Christoph Meier Assignee: Julie Legendre
Resolution: Done Votes: 0
Labels: None
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original Estimate: Not Specified

Issue Links:
causality
is causing DOCU-1693 Update Find bar documentation pages o... Closed
Template:
Acceptance criteria:
Empty
Task DoR:
Empty
Date of First Response:
Epic Link: Find bar and Periscope docu
Sprint: Docu Sprint 57, Docu Sprint 58
Story Points: 5

 Description   

"Classic" module page for these backend modules.

GIT: https://git.magnolia-cms.com/projects/MODULES/repos/periscope

I expect it to be a rather short page - since afaik the complete configuration is handled by the Findbar module

This is where search result suppliers and operations are configured. Bumping up story points to reflect this + addition of new periscope-result-ranking module today.

List of modules (so far):

  • periscope-api
  • periscope-core
  • speech-recognition


 Comments   
Comment by Julie Legendre [ 21/Aug/18 ]

https://documentation.magnolia-cms.com/display/DOCS57/Periscope+module

Started. Updated description and increased story points.

Comment by Julie Legendre [ 22/Aug/18 ]

https://documentation.magnolia-cms.com/display/DOCS57/Result+Ranker+module

 

Comment by Julie Legendre [ 27/Aug/18 ]

After meeting with ilgun&creichenbach, we have agreed the following sections be suspended until things are cleaned up dev side.

  • "Configuring a PeriscopeOperation" section on hold until until 07/09 - will change
  • "Sample REST integration" section properties table on hold until 07/09 - will change
Comment by Julie Legendre [ 27/Aug/18 ]

Dev ticket created for partial review: https://jira.magnolia-cms.com/browse/DEV-1045

Sections ready for review:
Module structure
Installing
Configuration
Default search result suppliers
Creating a custom search result supplier
For JCR workspaces
For REST integrations
Sample REST integration

Not ready for review, pending dev changes:
Default periscope operations
Configuring a PeriscopeOperation

Dev input for the pending sections is planned for 07/09. This ticket will need to be moved to the next sprint for the pending sections as well as for integrating feedback for the sections in review.

Comment by Julie Legendre [ 04/Sep/18 ]

Met with creichenbach and ilgun. The Operations part has been refactored as planned. They will provide content directly in the draft page: https://documentation.magnolia-cms.com/display/DOCS57/Periscope+module
as well as review the search result supplier parts.

Comment by Julie Legendre [ 10/Sep/18 ]

All excellent content from Cedric and Ilgun integrated into the page in 60: https://documentation.magnolia-cms.com/display/DOCS60/Periscope+module
Passed to PM (Antti) for review

Comment by Julie Legendre [ 13/Sep/18 ]

https://documentation.magnolia-cms.com/display/DOCS60/Periscope+Result+Ranker+module reviewed by dev (cedric). Feedback integrated.

Comment by Julie Legendre [ 14/Sep/18 ]

Closing after creating DOCU-1693 as follow up ticket

Generated at Mon Feb 12 01:19:25 CET 2024 using Jira 9.4.2#940002-sha1:46d1a51de284217efdcb32434eab47a99af2938b.