Bug 317280

Summary: Move the docs into the bodega server??
Product: [Unmaintained] bodega Reporter: Giorgos Tsiapaliokas <giorgos.tsiapaliokas>
Component: ServerAssignee: Aaron J. Seigo <aseigo>
Status: RESOLVED FIXED    
Severity: wishlist CC: active, giorgos.tsiapaliokas
Priority: NOR    
Version: unspecified   
Target Milestone: ---   
Platform: Other   
OS: Linux   
Latest Commit: Version Fixed In:
Sentry Crash Report:

Description Giorgos Tsiapaliokas 2013-03-24 16:31:58 UTC 
In bodega-client/doc/json_api there is the documentation of the bodega API.

I suggest to
* move it in the bodega server, since it fits better there.
* make the docs in markdown format
** its easy to make them in markdown format
** most of them are already in markdown format
** jade supports the markdown format
*and to render them in the '/' route

what do you think?

P.S.: I volunteer for the task.


Reproducible: Always
Comment 1 Aaron J. Seigo 2013-03-25 15:43:24 UTC 
Yes, I think this makes sense. I assume the API docu is probably somewhat out of date at this point. 

What would be nice is to also be able to check this API against the test scripts as well, but that could be a second step.