search

mattermost / mattermost-plugin-jira

JIRA plugin for Mattermost 🔌
https://mattermost.gitbook.io/plugin-jira/
Apache License 2.0
97 stars 127 forks source link

Hyperlinks in link tooltip are shown in plaintext #1081

Open mickmister opened 1 month ago

mickmister commented 1 month ago

Jira's "markdown" system is a bit different than Mattermost's, which can cause some issues with interoperability between the platforms. For example, the link tooltip feature will show "smart links" in plaintext like the screenshot below.

From the investigation here: [https://mattermost.atlassian.net/browse/MM-52952|https://mattermost.atlassian.net/browse/MM-52952|smart-link] Seems like the a...

Should instead render as:

From the investigation here: https://mattermost.atlassian.net/browse/MM-52952 Seems like the a...

image

It is a general problem that there are fundamental differences between the two markdown systems, and there have been some efforts to holistically address this, though it may make sense to address the known inconsistencies individually https://github.com/mattermost/mattermost-plugin-jira/issues/599#issuecomment-1662049748. Meaning, we can have certain things in the code like "replace Jira smart link with regular markdown link" when the information is fetched from Jira before returning to the UI for the tooltip.

mickmister commented 1 month ago

@Kshitij-Katiyar Curious about your thoughts on having an effort to handle individual markdown discrepancies between the two systems. I think starting with documenting differences we know would be a good first step (maybe @AayushChaudhary0001 can help produce/find these) Then we can create HW tickets to address the known issues there. This would involve:

Kshitij-Katiyar commented 1 month ago

@Kshitij-Katiyar Curious about your thoughts on having an effort to handle individual markdown discrepancies between the two systems. I think starting with documenting differences we know would be a good first step (maybe @AayushChaudhary0001 can help produce/find these) Then we can create HW tickets to address the known issues there. This would involve:

  • For the create issue feature, format anything necessary things to fit Jira's markdown model
  • For any rendering (posts, tooltip) of Jira issue descriptions format anything to fit Mattermost's markdown model

sure @mickmister we should start by creating the differences list first and depending upon the complexity and time, we can create the help wanted tickets as well.