Download as
Browse Code »

Commit e4337dcc6db043547e2aefd7c2a21938a91e2789

Authored by Nathan Broadbent
1 parent 3659a05e
Exists in master and in 1 other branch production

Added section to README about Errbit's internal errors. Wrote guide for how to p… 

…ost bug reports to the Github Issues account for errbit/errbit.
Showing 1 changed file with 23 additions and 7 deletions   Show diff stats
README.md
  Diff comments   View file @e4337dc
... ... @@ -164,17 +164,33 @@ Issue Trackers
164 164 **Github Issues Integration**
165 165  
166 166 * For 'Account/Repository', the account will either be a username or organization. i.e. **errbit/errbit**
167   -* Errbit uses token-based authentication. Get your API Token or visit [http://help.github.com/set-your-user-name-email-and-github-token/](http://help.github.com/set-your-user-name-email-and-github-token/) to learn how to get it.
  167 +* On [https://github.com](https://github.com), click "Account Settings", and then "Account Admin" to find your **API Token**.
168 168 * You will also need to provide the username that your API Token is connected to.
169 169  
170 170  
171   -Errbit for Errbit
172   ------------------
  171 +What if Errbit has an error?
  172 +----------------------------
173 173  
174   -There is a central Errbit instance running on heroku at **http://errbit-central.heroku.com**.
175   -Your Errbit instance will send it's errors there by default.
176   -If you are running vanilla Errbit, it would be really helpful if you could leave these settings unchanged.
177   -However, if you fork Errbit and are making lots of changes, please do point your errors back to your own instance of Errbit.
  174 +Errbit will log it's own errors to an internal app named 'Self.Errbit'.
  175 +The 'Self.Errbit' app will be automatically created whenever the first error happens.
  176 +
  177 +If your Errbit instance has logged an error, we would appreciate a bug report on Github Issues.
  178 +You can do this manually at [https://github.com/errbit/errbit/issues](https://github.com/errbit/errbit/issues),
  179 +or you can set up our Github Issues as the issue tracker for your 'Self.Errbit' app:
  180 +
  181 + 1. Go to the **Self.Errbit** app's edit page. If that app does not exist yet, go to the apps page and click **Add a new App** to create it. (You can also create it by running `rake hoptoad:test`.)
  182 +
  183 + 2. In the **Issue Tracker** section, click **Github Issues**.
  184 +
  185 + 3. Fill in the **Account/Repository** field with **errbit/errbit**.
  186 +
  187 + 4. Fill in the **Username** field with your github username.
  188 +
  189 + 5. On [https://github.com](https://github.com), click "Account Settings", and then "Account Admin" to find your **API Token**.
  190 +
  191 + 6. Save the settings by clicking **Update App** (or **Add App**)
  192 +
  193 + 7. You will now be able to easily post a bug report on Github Issues.
178 194  
179 195  
180 196 TODO
... ...