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.

Sign up for GitHub

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-1003] Update Readme 'What are notifications?' section screenshot #1005

Merged
merged 8 commits into from
Jan 24, 2024
Merged

[GH-1003] Update Readme 'What are notifications?' section screenshot #1005

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
be0e53c
chore: Update Readme 'What are notifications?' section screenshot
chriswachira Dec 13, 2023
3257174
Merge branch 'master' into update-readme-notifications-screenshot
mattermost-build Jan 4, 2024
3464b44
use relative path for screenshot in readme
mickmister Jan 4, 2024
b252e4d
revert relative path for image. use pasted hash URL instead
mickmister Jan 4, 2024
4de9049
try relative path without dot
mickmister Jan 4, 2024
def48b5
revert relative path change
mickmister Jan 4, 2024
b88a59f
Try image from relative path
chriswachira Jan 4, 2024
149b746
show attach-from-post.png in "Attach messages to Jira issues" section
mickmister Jan 24, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Binary file modified assets/attach-from-post.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
6 changes: 4 additions & 2 deletions readme.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,8 @@ Each user in Mattermost is connected with their own personal Jira account and no

Keep all information in one place by attaching parts of Mattermost conversations in Jira issues as comments. Then, on the resulting dialog, select the Jira issue you want to attach it to. You may search for issues containing specific text.

![image](./assets/attach-from-post.png)

![image](https://user-images.githubusercontent.com/13119842/59113267-b627f780-8912-11e9-90ec-417d430de7e6.png)

#### Transition Jira issues
Expand Down Expand Up @@ -159,7 +161,7 @@ Jira notifications are messages sent to a Mattermost channel when a particular e

Notifications and webhooks can be used together or you can opt for one of them.

![This is a channel notification of a new bug that was created in Jira](https://github.com/mattermost/mattermost-plugin-jira/assets/74422101/e7020c3e-48f6-4825-8193-6a189f6c96eb)
![This is a channel notification of a new bug that was created in Jira](./assets/ticket-created.png)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should this path point to the attach-from-post.png image file rather than ticket-created.png?

Copy link
Contributor Author

@chriswachira chriswachira Jan 22, 2024 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I believe it should be the ticket-created.png image since we want to show a sample notification triggered from Jira

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The image file committed to this PR is named attach-from-post.png, but the code to display an image is a different file name. An incorrect file name would be one reason we're seeing an image error placeholder in a rich preview.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This PR was supposed to have two changes:

  1. Change attach-from-post.png image to show the new location of the Jira actions buttons.
  2. Update the image in the "What are notifications?" section to show a notification triggered from Jira.

Please see this conversation we had earlier: #1005 (comment)

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@mickmister I'm not sure why the rich diff is displaying a broken image; the image is being rendered correctly if you click on "View file"

Copy link
Contributor

@mickmister mickmister Jan 24, 2024 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks I think I understand now. IIUC we now have a fixed attach-from-post.png file, but it's no longer being used as it was incorrectly being used?

I went ahead and put the image in the "attach message" section, and it looks good to me. What do you think?

CleanShot 2024-01-24 at 14 36 25


When any webhook event is received from Jira the plugin reviews all the notification subscriptions. If it matches a rule it will post a notification to the channel. If there are no subscription matches, the webhook event is discarded.

Expand Down Expand Up @@ -421,4 +423,4 @@ You can also find issues labeled ["Help Wanted"](https://github.com/mattermost/m

- For Mattermost customers - Please open a support case.
- For questions, suggestions, and help, visit the [Jira Plugin channel](https://community.mattermost.com/core/channels/jira-plugin) on our Community server.
- To report a bug, please [open an issue](https://github.com/mattermost/mattermost-plugin-jira/issues).
- To report a bug, please [open an issue](https://github.com/mattermost/mattermost-plugin-jira/issues).
Loading