Skip to content
This repository has been archived by the owner on Aug 28, 2023. It is now read-only.

Commit

Permalink
Update readme
Browse files Browse the repository at this point in the history
- Remove broken images (fixes GH-76)
- Update location of settings
  • Loading branch information
dcramer committed Feb 8, 2016
1 parent 79fcf1e commit 5b917e5
Showing 1 changed file with 6 additions and 31 deletions.
37 changes: 6 additions & 31 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ sentry-jira
===========

A flexible extension for Sentry which allows you to create issues in JIRA based on sentry events.
It is capable of rendering and saving many custom fields, and will display the proper fields depending on
It is capable of rendering and saving many custom fields, and will display the proper fields depending on
which issue type you are trying to create.

Attention
Expand All @@ -15,32 +15,6 @@ I am developing this plugin against 2 different configurations of JIRA:

Since JIRA is so configurable, I'm looking for lots of feedback of the different ways that this breaks
with specialized configurations. Provide your feedback here: https://github.com/thurloat/sentry-jira/issues

Visual Walkthrough
------------------

Per-Project configurations

.. image:: http://sentry-jira.s3.amazonaws.com/ss4.png

When viewing a Sentry event, the Actions dropdown now contains a "Create JIRA Issue" button.

.. image:: http://sentry-jira.s3.amazonaws.com/ss1.jpg

The Create JIRA Issue form is fully customized based on your JIRA Configuration and loads different
fields depending on which issue type you choose.

.. image:: http://sentry-jira.s3.amazonaws.com/ss2.png

You can now [0.5] use an auto-complete field to pull users from JIRA for any
user field.

.. image:: http://sentry-jira.s3.amazonaws.com/ss5.png

Once the Issue has been linked through JIRA there's a link that you can follow from Sentry to
go directly to the issue on your configurated JIRA instance.

.. image:: http://sentry-jira.s3.amazonaws.com/ss3.jpg

Installation
------------
Expand All @@ -55,10 +29,11 @@ Install the package via ``pip``:
Configuration
-------------

Go to your project's configuration page (Projects -> [Project]) and select the
JIRA tab. Enter the JIRA credentials and Project configuration and save changes.
Filling out the form is a two step process (one to fill in data, one to select
project).
Go to your project's configuration page (Dashboard -> [Project] -> Settings), select the
Issue Tracking tab, and then click the JIRA button under available integrations.

Enter the JIRA credentials and Project configuration and save changes. Filling out the form is
a two step process (one to fill in data, one to enter additional options).

More Documentation
------------------
Expand Down

0 comments on commit 5b917e5

Please sign in to comment.