Closed Bug 1282088 Opened 9 years ago Closed 9 years ago

update balrog README

Categories

(Release Engineering Graveyard :: Applications: Balrog (backend), defect)

Product:
Release Engineering Graveyard
Component:
Applications: Balrog (backend)
Type:
defect
Priority:
Not set
Severity:
normal

Tracking

(Not tracked)

Status:
RESOLVED DUPLICATE of bug 1279231

People

(Reporter: bhearsum, Assigned: ninad101)

Details

The README in the backend Balrog repo has some basics on how to run Balrog, but not an awful lot of other information. Most of the written information on Balrog is currently on https://wiki.mozilla.org/Balrog, which is quite detached from the code. I think it would be good to put more information into the README, and move the complete documentation elsewhere in the repo, and generate a readthedocs site with it.
Ninad is going to give this a try. He's planning to update the README, move the wiki documentation to Sphinx, and add integration with ReadTheDocs.
Assignee: nobody → bhat.ninadmb
This happened as part of https://bugzilla.mozilla.org/show_bug.cgi?id=1279231.
Status: NEW → RESOLVED
Closed: 9 years ago
Resolution: --- → DUPLICATE
Product: Release Engineering → Release Engineering Graveyard
You need to log in before you can comment on or make changes to this bug.