[Task]: Support markdown in add-on listing fields

[abyrne-moz]

Description

Support markdown in various add-on listing fields to make it easier for add-on users to absorb information. The fields should include:

• Add-on summary description
• Privacy policy
• Developer Comments

Once this feature is enabled, straight HTML tags should no longer be allowed in any add-on fields. Existing HTML already existing in these fields before the feature is enabled should be unaffected and still render as before.

Acceptance Criteria

Milestones/checkpoints

Preview Give feedback

1. Support markdown in the add-on description
2. Support markdown in the privacy policy
3. Support markdown in the Developer comments
4. HTML is no longer able to be added to these fields when for new or updated listings
5. Existing HTML already added in these fields prior to this change renders as previously

Checks

• If I have identified that the work is specific to a repository, I have removed "repository:addons-server" or "repository:addons-frontend"

┆Issue is synchronized with this Jira Task

[willdurand]

Add-on summary

FWIW this is used in the main card on an add-on detail page, and I think it makes sense to have a "raw" string there, otherwise that might change how detail pages look.

Also, what markup are we talking about? We do support some html tags in some other fields but "straight HTML tags should no longer be allowed in any add-on fields" makes me think that we're more thinking about markdown than markup? Or is this a new thing?

[RokeJulianLockhart]

Also, what markup are we talking about? We do support some html tags in some other fields but "straight HTML tags should no longer be allowed in any add-on fields" makes me think that we're more thinking about markdown than markup? Or is this a new thing?

@willdurand, Markdown support more frequently than not includes support for a significant subset of HTML5. That is part of its popularity – it is in most situations to HTML as YAML is to JSON.

Consequently, I would say that there is no need to prevent an author using basic HTML5 tags, like <i>, <s>, or <b>. It may be useful when duplicating markup between the extension page to a webpage, as is common for extensions listed in multiple places.

[abyrne-moz]

I definitely meant mark_down,_ not mark_up_. I'll edit the ticket.

[KevinMind]

Notes:

• html to markdown compatibility
• how do we do validation on markdown, is it different to how we do it currently

[chrstinalin]

@abyrne-moz When you say 'summary', do you mean the add-on description? The fields that expect HTML on the Addon model are: description, developer_comments, eula, and privacy_policy. Summary is not included (though, FE still allows HTML included in the summary to render).

Should eula be excluded as well?

[abyrne-moz]

Excellent spot, it should be the Description, not the Summary - my mistake! the eula should be in scope for markdown as well, as it currently supports HTML.

I'll update the description with the correct field too.

[alexandruschek]

Hello,

I checked on -DEV ENV the following: addon description, privacy policy & eula, developer comments, version notes; they all display html code as expected now:

Thank you! Adding the label: verified fix to this task

[ioanarusiczki]

I looked a bit on the new markdowns in all fields and wfm except for abbreviations and filed #15316 ✔️

Tried all mentioned fields for https://addons-dev.allizom.org/en-US/firefox/addon/bun-la-toate/ ✔️

Blockquotes on frontend doesn't look as in rev tools pages (where I think it's the correct layout) -> for the same addon https://reviewers.addons-dev.allizom.org/en-US/reviewers/review/635484 but that's reproducible on stage atm too, for example developer comments versus reviewer page for https://addons.allizom.org/en-US/firefox/addon/install-and-report/ ❓

Blockquotes rev tools

Blockquotes frontend

[Juraj-Masiar]

The Ordered / Unordered lists are both wrongly rendered, it's just a normal text, there is no ul / li, and thus no padding / margin.
This is how it suppose to look:

And this is what AMO looks like:

---

And some real world example from one of my addons:

[diox]

@Juraj-Masiar thanks for catching that, could you file a new bug with that information ?

[Juraj-Masiar]

Reported: #15425