Skip to content

Commit

Permalink
[GH-830]: Explained the jira subscription modal in the doc (#904)
Browse files Browse the repository at this point in the history
* [MI-2608]: Explained the jira subscription modal in the doc. (#31)

* [MI-2608]: Explained the jira subscription modal in the doc.

* [MI-2608]:Review fixes done
1. Modified the doc
2. Connected the doc from frontend

* [MI-2608]: Review fixes done
1. Modified the administrator guide doc

* Fixed CI errors

* [MI-2698]: Review fixes done of PR #904 (#33)

* [MI-2698]: Review fixes done of PR #904

* [MI-2698]: Review fixes done
1. Improved the content of a administrative guide doc

* [MI-2799]: Done review fixes of Jira PR #904 (#38)

* Fixed CI errrors

* [MM-830] Remove extra file

* [MM-830] Update snapshot

* [MM-830] Remove extra parameter from link

* [MM-830] Update snapshot

---------

Co-authored-by: ayusht2810 <ayush.thakur@brightscout.com>
Co-authored-by: raghavaggarwal2308 <raghav.aggarwal@brightscout.com>
  • Loading branch information
3 people authored Jan 18, 2024
1 parent ceac791 commit ea9ab23
Show file tree
Hide file tree
Showing 4 changed files with 44 additions and 0 deletions.
23 changes: 23 additions & 0 deletions readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -201,6 +201,29 @@ The following Jira event notifications are supported:

![This is the Channel Subscription modal](https://github.com/mattermost/mattermost-plugin-jira/assets/74422101/4dab17fa-5d49-48eb-91b1-cb9596780787)

## Create a channel subscription

1. Type the `/jira subscribe` command to open the "Create subscription" modal in the particular channel.
2. Click on the **Create Subscription** button to create a subscription to receive Jira issue notifications in the current channel.
3. Write the name of the subscription in the **Subscription Name** field.
4. Select the project name to which you want to subscribe.
5. Select the events and issue types for which you want to receive the notifications in the Mattermost channel.
6. To be more specific, you can add filters as well. You can either include or exclude the particular filter by adding its type or name. We have many types of filters including some custom fields as well :
* Affects versions
* Epic Link
* Fix versions
* Labels
* Priority

**Few custom fields :**
* Checkboxes
* Labels
* Radio Buttons
* Select List (multiple choices)
* Select List (single choice)
7. Based on the above given constraints in **Issue Type** and **Filters** fields an **Approximate JQL Output** is generated.
8. Click on the **Add Subscription** button to add the subscription to that channel with the specific constraints that you have selected above.

#### Setting up the webhook in Jira

In order to have Jira post events to your Mattermost instance, you'll need to set up a webhook inside of Jira. See the configure webhooks on the Jira server section for details.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3630,6 +3630,17 @@ exports[`components/EditChannelSubscription should match snapshot after fetching
that since you have not selected a security level filter, the subscription will only allow issues that have no security level assigned.
</span>
</div>
<div
className="channel-subscriptions-modal__learnMore"
>
<a
href="https://github.com/mattermost/mattermost-plugin-jira#create-a-channel-subscription"
rel="noopener noreferrer"
target="_blank"
>
Learn More
</a>
</div>
</div>
</div>
<ConfirmModal
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,9 @@
}
}
}
&__learnMore {
margin-top: 1em;
}

.title-message {
justify-content: space-between;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -418,6 +418,13 @@ export default class EditChannelSubscription extends PureComponent<Props, State>
</span>
</div>
)}
<div className='channel-subscriptions-modal__learnMore'>
<a
href='https://github.com/mattermost/mattermost-plugin-jira#create-a-channel-subscription'
target='_blank'
rel='noopener noreferrer'
>{'Learn More'}</a>
</div>
</div>
</React.Fragment>
);
Expand Down

0 comments on commit ea9ab23

Please sign in to comment.