Skip to content

Commit

Permalink
Fix documentation issue (fixes #3).
Browse files Browse the repository at this point in the history
  • Loading branch information
andialbrecht committed Aug 26, 2013
1 parent f751814 commit 165e5ec
Show file tree
Hide file tree
Showing 2 changed files with 17 additions and 1 deletion.
10 changes: 9 additions & 1 deletion README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -11,10 +11,18 @@ to sentry events.
Installation
============

::
To install the comments extension run::

pip install sentry-comments

Then add ``sentry_comments`` to the ``INSTALLED_APPS`` list in your Sentry
configuration::

INSTALLED_APPS += ('sentry_comments',)

Run :command:`sentry --config=your.conf.py upgrade` to create the new tables
required by this plugin.


License
=======
Expand Down
8 changes: 8 additions & 0 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,14 @@ To install the comments extension run::

pip install sentry-comments

Then add ``sentry_comments`` to the ``INSTALLED_APPS`` list in your Sentry
configuration::

INSTALLED_APPS += ('sentry_comments',)

Run :command:`sentry --config=your.conf.py upgrade` to create the new tables
required by this plugin.

After restarting Sentry you need to enable the plugin for each project on the
project's setting page. A new comments panel appears on the event page. Click
on the panel title to read or add comments.
Expand Down

0 comments on commit 165e5ec

Please sign in to comment.