The docs currently detail some of the API in the architecture page (http://normandy.readthedocs.io/en/latest/dev/architecture.html) but we should really have solid docs on the sequence of requests and responses that happen on the self-repair endpoint, and each of the APIs used. This will be useful to have, and particularly useful for QAs trying to understand the system. Since the self-repair page mimicks the system addon, the docs should be pretty reusable for when the self-repair endpoint gets replaced.

This sounds good to have, but I don't think this should block our post-launch fixes. It doesn't have any affect on the production system, and everything else on that tracker bug is going to have a really good effort-to-impact ratio on performance and reliability of the servers.

I made this a blocker mainly to incite hustle behind writing it and merging it so that QA will have it in hand to help verify the post-launch release. I'm fine with removing it as a blocker if chartjes is okay with that, but also I probably will try and get a PR in for this today anyway, making it a moot discussion.

Commits pushed to master at https://github.com/mozilla/normandy https://github.com/mozilla/normandy/commit/37abc68b97cf24cb0ff0e2589f04063a6fddc7de Fix bug 1268743: Improve documentation for self-repair. https://github.com/mozilla/normandy/commit/5bf8eda967b65eefb1fd0e08e43853211bbb4fd6 Merge pull request #129 from Osmose/document-self-repair Fix bug 1268743: Improve documentation for self-repair.