Bug 317280 - Move the docs into the bodega server??
Summary: Move the docs into the bodega server??
Status: RESOLVED FIXED
Alias: None
Product: bodega
Classification: Unmaintained
Component: Server (show other bugs)
Version: unspecified
Platform: Other Linux
: NOR wishlist
Target Milestone: ---
Assignee: Aaron J. Seigo
URL:
Keywords:
Depends on:
Blocks:
 
Reported: 2013-03-24 16:31 UTC by Giorgos Tsiapaliokas
Modified: 2013-09-12 23:19 UTC (History)
2 users (show)

See Also:
Latest Commit:
Version Fixed In:
Sentry Crash Report:


Attachments

Note You need to log in before you can comment on or make changes to this bug.
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.