Switch description and comments to ADF rendering using guarana
Description
First lets rollout new ADF (rich-text) renderer for
- description
- comments
- custom field (there can be ADF custom fields ❗ - like
environment
field or other) - filter view > rich-text column (images might stop working)
that works only if special query param is available in url ?render=adf
Otherwise we will use current rendered.
Image mapping can be done using HTML from Jira api v2.
Please watch of E2E tests 🔍 , specially those related with Issue formatting
`description-display.spec.ts`, `comment-formatting.spec.ts`
Linked issues
relates to
ESFJ-391
[Blocked] Expand is not working on JES pages
Withdrawn
ESFJ-368
[Blocked] Table layout breaks when line break appears in cell between two values
Withdrawn
ESFJ-576
Videos included in comment doesn't work on External Share page
Withdrawn
ESFJ-730
Incorrect conversion of HTML text formatting when using text color change
Withdrawn
ESFJ-629
Text and code snippet overflow in comment section
Released
ESFJ-497
Certain links are not automatically converted to inline (Smart) links and cannot be manually converted to inline or card view either
Withdrawn
ESFJ-1020
Non-formatted images fail to display correctly in shared issue descriptions
Withdrawn
ESFJ-652
Images are not displated on shared page
Withdrawn
ESFJ-1073
Add same linking behaviour to comments as in share description
To Do
Activity
Show:
Improvement implemented - QA env
@Polina Naumenko Expand fixed, please retest again
Expand stopped working
@Daniel Siara
linki nie wyswietlaja sie jako inline, card, embed
w prodzie tez nie dziala
OK
attachments iare not displayed
OK
group mention displayed as url instead of mention
OK
video, image, attachment zip file are not supported in a table
adf ES has word.doc attachment that supposed to be displayed above in issue 2.
OK
scrollbar is a code snippet and code is not rendered
How about rendering? In Jira some strings are in different text
scrollbar code snippet in expand
OK
image in expand is not supported
OK
info panels dark mode icons and strings are not visible
OK
image in info panel is not supported (prod the same, might need a new ticket)
OK
Decision macro in dark mode is not supported
OK
Divider should be in dark mode
OK
Statuses should be in dark mode
OK
@Polina Naumenko task is ready to restest
Problem with emoticons / unicodes.
Headers size. Code block size. Panel icons broken.
https://jira-test-3.kz-test.ovh/issue/2b6a5621-0878-4e51-aed6-979450fc9b4e
https://jira-test-3.kz-test.ovh/issue/2b6a5621-0878-4e51-aed6-979450fc9b4e?render=adf
https://jira.external-share.com/issue/66fc9e11-28e0-4821-a8c6-37ca19bdaba6?render=adf
https://jira.external-share.com/issue/66fc9e11-28e0-4821-a8c6-37ca19bdaba6
@Polina Naumenko
This new ADF render is still broken. I found numerous problems. Please re-test this fully.
Improvement implemented - QA env
image size
smart link & comments
Edit do not work in old mode
Edit do not work in new mode
Embedded attachments in description in edit mode - do not work (zip)
image size - non proper size (should be smaller)
If you adjust size in Jira and refresh a page, size is applied correctly
Info panel issue (fyi colors are not mapped yet)
code block and inline code block is visually broken.
unexpected margins in smart link & comments
prism removed in adf
external-styles-min removed in adf
panel-icons removed in adf
styles-new removed in adf
If render=adf mode:
Remove prism
Remove external-styles-min
Remove panel-icons css
Remove styles-new.css?
Fix panel render:
@Krzysztof Bogdan all problems fixed. Please take a look into PR.
https://bitbucket.org/%7B8d3fc384-2d68-40d9-a994-c4d0d7086569%7D/%7B1dbc18bb-54b4-4788-8de0-44bdf37fe7ca%7D/pull-requests/1995
https://jira.external-share.com/issue/fd3ceefd-0900-42a4-b54d-7d66650be17e/DS-590?render=adf
Code block is visually broken,
inline code block is visually broken.
Unexpected margins:
Edit do not work in old mode:
Edit do not work on new mode:
https://jira.external-share.com/issue/ad8979a1-da9c-47fc-a6db-4b58d43d09cf/SCM-1?render=adf
Ensure include EDITOR JS/CSS only if edit description / add comments is enabled
EDITOR JS
if render=adf - include our wysywig.js
by default include ckeditor
Embedded attachments in description in edit mode - do not work (zip)
https://jira.external-share.com/issue/ad8979a1-da9c-47fc-a6db-4b58d43d09cf/SCM-1?render=adf
Image size - non proper size (should be smaller)
https://jira.external-share.com/issue/ad8979a1-da9c-47fc-a6db-4b58d43d09cf/SCM-1?render=adf
Hello @Daniel Siara,
Please merge code to dev branch.
This is the best moment to add more information that can be helpful to prepare release notes.
Can you prepare short overview of change that can be used in release notes?
Please provide short GIF that showcase feature.
If GIF make no sense, can you provide image that highlights feature that can be used in release notes (cropped & annotated)?
Improvement implemented - QA env
expand does not work in edit mode (as per jira)
videos are not supported outside of a table
mp4 is not displayed
webm displayed, but unable to play a video
mkv displayed, but unable to play a video
info panels to be fixed in a separated bug as discussed
status color to be fixed in a separated bug as discussed
1- User is able to edit description when config is disabled -
2- Expand does not work (impossible to collapse) -
3- Size of an image in expand gets bigger - looks good - tested
5- Image size expands
6 - status color is good
7 - problem with mp4 in table
8 - Divider is not supported -
9 - looks good - tested
10 - Missing leading -
11 - Info panel is really weird - looks good - tested
All problems should be fixed
User is able to edit description when config is disabled
Expand does not work (impossible to collapse)
Size of an image in expand gets bigger
Image size expands
Status colors are not as per jira, info panel is not in dark mode
checked with multiple users, browsers, instances. The issue is replicated
MP4 video is not supported? Weird cuz in a table i’m able to play it
Divider is not supported
Image is not supported in expand
Missing leading
Info panel is really weird
https://jes-qa.warsawdynamics.com/issue/87cd2bbe-08a5-4416-8152-4dea161220f0?render=adf
Unable to render image, code snippet
added extra column, should be 3 instead of 4
Info panel is not visible
Hello @Daniel Siara
This is the best moment to add more information that can be helpful for tester.
What areas are affected?
What are potential edge cases?
Was it checked for XSS problems?
Does change affect security, is new data exposed?
Please attach - Before / After screenshot if possible.
Hello @Daniel Siara,
Change was reviewed and approved.
Task is ready to be deployed to QA.
Once it is deployed to QA please move ticket to "To Test"
Thank you!
@Krzysztof Bogdan you can look again, changes applied
@Krzysztof Bogdan changes applied
@Daniel Siara
@Krzysztof Bogdan please take a look again
@Daniel Siara I think some big refactoring is needed
@Krzysztof Bogdan task is ready for review
Hello [~accountid:],
Task is ready for review.
@Daniel Siara please make sure reviewer
have easy access to contend to be reviewed.
If this is code change. Please make sure PR is created.
If this is new documentation, blogpost, etc. Please provide link to page.
Added linking behaviour to comments (ESFJ-1073) and to custom fields also
@Krzysztof Bogdan ok, I will refer to https://warsaw-dynamics.atlassian.net/browse/ESFJ-1073
@Krzysztof Bogdan Comments, description, environment are ADF rendered. I am currently working on custom fields (Today will be done). I still need to fix a few things related to the editor, as I showed you on Monday call. I estimate that I will finish up to Friday, but first the https://warsaw-dynamics.atlassian.net/browse/ESFJ-863 task need to be finished, because I am using editor implemented in this task
@Daniel Siara What is status of this task? When you estimate finishing it?
@Daniel Siara Please refer tohttps://warsaw-dynamics.atlassian.net/browse/ESFJ-1073
- to update links in ADF to share if possible