Funsize is a new project and has very little to no documentation at the moment. Using this bug to add, track and get feedback on docs. This bug can be closed once the first revisions of all docs deemed important are on http://wiki.mozilla.org
Adding first run of docs. API description -- https://gist.github.com/ffledgling/25d7e77bd9adc719d084 Contributor's guide -- https://gist.github.com/ffledgling/71dc7bef3708546915f2 TroubleShooting guide -- https://gist.github.com/ffledgling/73b59fa8f027213f792c Feedback welcome
Things look good overall, a few suggestions: * API docs: ** "While the application is still generating the partial it will return an HTTP 202 response. Once done, the application will return an HTTP 200 response with the Partial in the response body." - This should go in the "Getting the partial" section. When only skimming, it looks like the 202 and 200 responses are potential responses to POSTs to /partial. ** "In case of failure in the process of generating the Partial, the service might abort the request and in such a case the client is informed of the same with an HTTP 500 response." - Does /partial return a 500, or /partial/<identifier>? I don't see how /partial could return one if there's a failure during generation, because it returns before the partial is generated. They both may validly return a 500, but this case you're describing sounds like it applies to /partial/<identifier>. * Contributor's Guide ** I'd recommend just saying "Windows is not supported at all." I highly doubt you get all the software to run there, and I don't think it's worth anyone's time to try. Troubleshooting looks fine, I guess. We're going to want to revise that when it's a production system. Ie, we probably won't want to do things like "truncate the entire database".
Hal anted to take a look at these.
Yes, Hal wanted to, but hasn't had the time :( At this point, :mtabara would be a better judge of any needed changes. Passing the buck to him.
After a meeting with ffledgling we've decided the following. We will update the documentation in the following two weeks at the these locations: * https://wiki.mozilla.org/ReleaseEngineering/Funsize/Troubleshooting * https://wiki.mozilla.org/ReleaseEngineering/Funsize/Hacking * https://wiki.mozilla.org/ReleaseEngineering/Funsize To avoid confusions we're gonna migrate the content from https://wiki.mozilla.org/User:Ffledgling/Senbonzakura there too. (historical reasons)