1227904 - Write documentation for Super Search

Status: RESOLVED FIXED

(Socorro :: General, task, P1)

Description

[[DEACTIVATED] Adrian Gaudebert]

I am not sure yet where it will go, probably on my blog or personal website at first, but we really need an incredibly great documentation for Super Search. We are asking people to use it, we need to give them awesome tools for that, and documentation is the very first step.

Comment 1

[Peter Bengtsson [:peterbe]]

If you want to just create a .html file as a django view function and stick it in crashstats/supersearch/views.py. 

Personally I'm much more excited about an interactive documentation with executable examples.

Comment 2

[[DEACTIVATED] Adrian Gaudebert]

Attachment: Link to Github pull-request: https://github.com/mozilla/socorro/pull/3152

Comment 3

[[github robot]]

Commit pushed to master at https://github.com/mozilla/socorro

https://github.com/mozilla/socorro/commit/ba3a4a8932a121185ca3cfd4c83198d339314116
Fixes bug 1227904 - Added user documentation for Super Search API. r=peterbe