Documentation for the inner workings of the results tracker are imperative to it's adoption beyond platform services

Registered by Chris Gregan on 2011-08-17

The QA CoP requests formal system documentation for the results tracker. In order for the group to consider adopting a new reporting tool we require detailed documentation of it's inner workings. This will not only facilitate the adoption once completed but also allow for more significant contribution along the way.

Documentation needs:

- Overview of the database schema
- How to backup the database ?
- How to create a new field/table ?
- How to trigger some actions on particular events (such as a new submission, to refresh the stats)
- How to create a webservice from scratch ?
- How to use lazr.restful to provide webservices fields that are not included in a storm resultSet ?
- What are the role of the different lzr.restful decorators found in the interfaces ?
- What are the levels of cache of the application (PostgreSQL, storm, ...)
- Describe the YUI widget used to render the site.

Blueprint information

Status:
Not started
Approver:
Marc Tardif
Priority:
Undefined
Drafter:
Chris Gregan
Direction:
Needs approval
Assignee:
Marc Tardif
Definition:
New
Series goal:
None
Implementation:
Unknown
Milestone target:
None

Related branches

Sprints

Whiteboard

(?)

Work Items

This blueprint contains Public information 
Everyone can see this information.