Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[GH-830]: Explained the jira subscription modal in the doc #904

Merged
merged 11 commits into from
Jan 18, 2024
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
Loading