From d6743441dc5dcc6e6103e715b385958a5a36d611 Mon Sep 17 00:00:00 2001 From: kshitij katiyar Date: Mon, 18 Nov 2024 15:36:01 +0530 Subject: [PATCH 1/4] [MM-1137]: Updated the Jira docs with help text for Admin API Token and Admin Email --- source/integrate/jira-interoperability.rst | 2 ++ 1 file changed, 2 insertions(+) diff --git a/source/integrate/jira-interoperability.rst b/source/integrate/jira-interoperability.rst index 71c1089e521..afc6e440920 100644 --- a/source/integrate/jira-interoperability.rst +++ b/source/integrate/jira-interoperability.rst @@ -43,6 +43,8 @@ A Mattermost system admin must perform the following steps in Mattermost. - **Hide issue descriptions and comments**: Show or hide issue descriptions and comments from subscription and webhook messages. - **Enable slash command**: Enable or disable slash command autocompletion to guide users through available ``/jira`` slash commands. - **Display Subscription name in notifications**: Show or hide subscription name in notification messages posted to a channel. + - **Admin API Token**: Set this [API token](https://support.atlassian.com/atlassian-account/docs/manage-api-tokens-for-your-atlassian-account/) to get notified for comment and issue created events even if the user triggering the event is not connected to Jira and setup autolink.\n **Note:** API token should be created using an admin Jira account. Otherwise, the notification will not be delivered for the project the user cannot access and autolink will not work. + - **Admin Email**: Set Admin email to setup Autolink for Jira plugin 2. Run ``/jira setup`` to start the wizard to configure the plugin. If you wish to set up the plugin manually, then please follow the steps below. From b97004d85a6f812e0bca282f0f05c7b1e0eb1e67 Mon Sep 17 00:00:00 2001 From: "Carrie Warner (Mattermost)" <74422101+cwarnermm@users.noreply.github.com> Date: Mon, 25 Nov 2024 10:01:37 -0500 Subject: [PATCH 2/4] Editorial updates --- source/integrate/jira-interoperability.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/source/integrate/jira-interoperability.rst b/source/integrate/jira-interoperability.rst index cca49f0267f..ccdd5089820 100644 --- a/source/integrate/jira-interoperability.rst +++ b/source/integrate/jira-interoperability.rst @@ -50,8 +50,8 @@ A Mattermost system admin must perform the following steps in Mattermost. - **Hide issue descriptions and comments**: Show or hide issue descriptions and comments from subscription and webhook messages. - **Enable slash command**: Enable or disable slash command autocompletion to guide users through available ``/jira`` slash commands. - **Display Subscription name in notifications**: Show or hide subscription name in notification messages posted to a channel. - - **Admin API Token**: Set this [API token](https://support.atlassian.com/atlassian-account/docs/manage-api-tokens-for-your-atlassian-account/) to get notified for comment and issue created events even if the user triggering the event is not connected to Jira and setup autolink.\n **Note:** API token should be created using an admin Jira account. Otherwise, the notification will not be delivered for the project the user cannot access and autolink will not work. - - **Admin Email**: Set Admin email to setup Autolink for Jira plugin + - **Admin API Token**: Set an `API token `_ to get notified for comments and issue creation events, even when the user triggering the event isn't connected to Jira, and set up Autolink. API tokens must be created using an admin Jira account, otherwise, notifications won't be delivered for projects the user can't access, and autolink won't work. + - **Admin Email**: Set Admin email to set up Autolink for the Jira plugin 2. Run ``/jira setup`` to start the wizard to configure the plugin. If you wish to set up the plugin manually, then please follow the steps below. From 79b368a08bfc216f214a8778af32b1e78ed0bf63 Mon Sep 17 00:00:00 2001 From: "Carrie Warner (Mattermost)" <74422101+cwarnermm@users.noreply.github.com> Date: Mon, 25 Nov 2024 10:02:26 -0500 Subject: [PATCH 3/4] Update source/integrate/jira-interoperability.rst --- source/integrate/jira-interoperability.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/integrate/jira-interoperability.rst b/source/integrate/jira-interoperability.rst index ccdd5089820..73bb1cb1cae 100644 --- a/source/integrate/jira-interoperability.rst +++ b/source/integrate/jira-interoperability.rst @@ -50,7 +50,7 @@ A Mattermost system admin must perform the following steps in Mattermost. - **Hide issue descriptions and comments**: Show or hide issue descriptions and comments from subscription and webhook messages. - **Enable slash command**: Enable or disable slash command autocompletion to guide users through available ``/jira`` slash commands. - **Display Subscription name in notifications**: Show or hide subscription name in notification messages posted to a channel. - - **Admin API Token**: Set an `API token `_ to get notified for comments and issue creation events, even when the user triggering the event isn't connected to Jira, and set up Autolink. API tokens must be created using an admin Jira account, otherwise, notifications won't be delivered for projects the user can't access, and autolink won't work. + - **Admin API Token**: Set an `API token `_ to get notified for comments and issue creation events, even when the user triggering the event isn't connected to Jira, and set up Autolink. API tokens must be created using an admin Jira account; otherwise, notifications won't be delivered for projects the user can't access, and Autolink won't work. - **Admin Email**: Set Admin email to set up Autolink for the Jira plugin 2. Run ``/jira setup`` to start the wizard to configure the plugin. If you wish to set up the plugin manually, then please follow the steps below. From 9e17bd12400c0f87e00eb2da5af879b6230a2e8d Mon Sep 17 00:00:00 2001 From: "Carrie Warner (Mattermost)" <74422101+cwarnermm@users.noreply.github.com> Date: Wed, 4 Dec 2024 16:40:51 -0500 Subject: [PATCH 4/4] Update source/integrate/jira-interoperability.rst --- source/integrate/jira-interoperability.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/integrate/jira-interoperability.rst b/source/integrate/jira-interoperability.rst index 73bb1cb1cae..28a1da44c28 100644 --- a/source/integrate/jira-interoperability.rst +++ b/source/integrate/jira-interoperability.rst @@ -51,7 +51,7 @@ A Mattermost system admin must perform the following steps in Mattermost. - **Enable slash command**: Enable or disable slash command autocompletion to guide users through available ``/jira`` slash commands. - **Display Subscription name in notifications**: Show or hide subscription name in notification messages posted to a channel. - **Admin API Token**: Set an `API token `_ to get notified for comments and issue creation events, even when the user triggering the event isn't connected to Jira, and set up Autolink. API tokens must be created using an admin Jira account; otherwise, notifications won't be delivered for projects the user can't access, and Autolink won't work. - - **Admin Email**: Set Admin email to set up Autolink for the Jira plugin + - **Admin Email**: Set Admin email to set up Autolink for the Jira plugin. 2. Run ``/jira setup`` to start the wizard to configure the plugin. If you wish to set up the plugin manually, then please follow the steps below.