•  
     
    story #18337 markdown replace text
Summary
Empty
markdown replace text
Empty
  • Wherever markdown can be used, the user can ask for a preview of the markdown she is editing:
    • New follow-up comments in the Artifact view
    • Existing follow-up comments (edit) in the Artifact view
    • Text fields in the Artifact view
    • Test steps fields in the Artifact view
    • New follow-up comment in the Mass change view
    • Text fields in modal v2 in Cardwall
    • Text fields and new follow-up comments in the Artifact modal (modal v3) in Kanban, Planning view and Test management
  • In user preferences, one can choose "markdown" as default format
    • Users with "Text" preference are upgraded to Markdown
  • "Text" format is no longer available for new comments & fields
  • Existing comments and text fields that are in "Text" format can stay "Text" or switch to "Markdown" or "HTML"
    • Existing conversion to HTML is preserved (see request #18360)
    • As soon as another format is saved, it's no longer possible to switch back to "Text".
    • If the conversion is not what user intended, there is a way to "Cancel" the conversion and revert to the original content in "Text" (existing conversion is preserved)
  • Existing comments that are in "HTML" can be converted to "Markdown"
  • Existing comments that are in "Markdown" can be converted to "HTML"
    • Via a rendering of Markdown to HTML

https://www.figma.com/proto/gDrBYTYQVYKTSNJYKH3aXl/Markdown?node-id=1%3A3&viewport=-1040%2C692%2C1&scaling=scale-down-width

Empty
Empty
Status
Empty
Done
Development
  • [ ] Does it involves User Interface? 
  • [ ] Are there any mockups?
  • [ ] Are permissions checked?
  • [ ] Does it need Javascript development?
  • [ ] Does it need a forge upgrade bucket?
  • [ ] Does it need to execute things in system events?
  • [ ] Does it impact project creation (templates)?
  • [ ] Is it exploratory?
Empty
Details
#18337
Manuel Vacelet (vaceletm)
2021-04-01 14:25
2020-11-20 14:38
3780

References
Referencing story #18337

Git commit

tuleap/tuleap/stable

Add the route which interpret a raw text in CommonMark 42606e8edd
Add the Markdown option in user preference 29f7ddce2f
Use "rich-text-editor" lib in Artifact modal 79006cffc3
Remove the 'Text' format in user preference 49e81e1d3d
Remove @tuleap/mention from rich-text-editor 3c9b22fdf5
Fix user preference E2E test 30adc2cf94
Add the CommonMark syntax preview button in step definition in artifact view b14664a87c
Enable the automatic creation of links in Markdown content 29ec003a7b
Refactoring: build format selector with lit-html cdf01bf403
Add data-project-id on Edit comment textarea 7b98748e48
Make the CommonMark preview button functional for the step defintion e6e8e101a8
Add the CommonMark "Preview" button in the artifact modal c71af765c5
Add the markdown "Preview" button in Artifact view 91f0ecfc70
Remove the 'text' format if a step does not initially use this format a36809e99a
Preview in Tracker artifact view 9d7715c14c
Remove Text format for new comments / text fields 99ecb7cdbe
Hide "Help" popover on Escape 7ec6ffb52e
Improve the error handling when the CommonMark preview fail in Step 826eac5e37
Be able to preview CommonMark syntax in artifact modal f1fa92992f
Remove Text format for new comments / text fields in Artifact modal 92cf797eee
Default format is now "commonmark" in the Backend a3bc592340
Be able to preview Markdown in follow up comment in artifact modal 453f29c2cf
Document the triple implementation choice c938faa4d7
league/commonmark: 1.5.7 -> 1.5.8 f8a5eefbf8
Close Artifact modal "Help" popover on Escape a70158edd1
Allow mermaid or syntax highlight in the preview 944fd4f2ab
Write an ADR for "why lit-html ?" f130cf3caf
'text' fromat are not supported anymore when submitting Step Definition 65a9288575

Follow-ups

User avatar
Joris MASSON (jmasson)2021-03-08 11:32

Edit the list of places where Markdown can be used:

  • Modal v1 does not allow choosing format (so it stays that way)
  • Mass change does not allow choosing format (so it stays that way)

  • Acceptance criteria
    Something went wrong, the follow up content couldn't be loaded
    Only formatting have been changed, you should switch to markup to see the changes
  • Status changed from Ready (stalled) to On going
User avatar
Joris MASSON (jmasson)2021-01-28 15:25
Explain that conversion from HTML to Text and Text to HTML was already added.

  • Acceptance criteria
    Something went wrong, the follow up content couldn't be loaded
    Only formatting have been changed, you should switch to markup to see the changes
User avatar
Joris MASSON (jmasson)2021-01-28 14:59
Complete the list of places where Markdown can be used

  • Acceptance criteria
    Something went wrong, the follow up content couldn't be loaded
    Only formatting have been changed, you should switch to markup to see the changes
User avatar
  • Acceptance criteria
    Something went wrong, the follow up content couldn't be loaded
    Only formatting have been changed, you should switch to markup to see the changes
User avatar
  • Acceptance criteria
    Something went wrong, the follow up content couldn't be loaded
    Only formatting have been changed, you should switch to markup to see the changes