750918 - [improve-devhub] Markdown!

Status: RESOLVED WONTFIX

(addons.mozilla.org Graveyard :: Developer Pages, defect, P5)

Description

[Gregory Koberger (:gkoberger)]

Some fields on the site let developers use HTML.

Instead, let's just use Markdown. Markdown lets us do everything the few allowed HTML tags do, reduces possible exploits, is much easier for us to format with HTML, looks cleaner, is easier for non-developers and means we can remove my horrible code (https://github.com/mozilla/zamboni/blob/master/apps/amo/utils.py#L350).

Things to remember:
* Make sure whatever we do works with the add-on manager. The add-on manager expects HTML, not markdown.
* We need a link to a pop-up markdown guide under each field that allows markdown.
* We need a preview button that will show the output of the Markdown.

The only problem is that we have thousands of rows in the database that use HTML rather than markdown. It would be best if we wrote (or found) something that converts HTML to Markdown. If we can't, we'll have to show a little box when the user edits the field the next time indicating they need to convert it to Markdown in order to save. We store sanitized HTML separate from the raw HTML (I think), so we can safely remove the HTML5 parser without breaking backwards compatibility. When a developer saves, we'll save the markdown version and the resulting HTML version.

Comment 1

[Matt Basta [:basta]]

(In reply to Gregory Koberger (:gkoberger) from comment #0)
> The only problem is that we have thousands of rows in the database that use
> HTML rather than markdown. It would be best if we wrote (or found) something
> that converts HTML to Markdown. If we can't, we'll have to show a little box
> when the user edits the field the next time indicating they need to convert
> it to Markdown in order to save. We store sanitized HTML separate from the
> raw HTML (I think), so we can safely remove the HTML5 parser without
> breaking backwards compatibility. When a developer saves, we'll save the
> markdown version and the resulting HTML version.

No problem! Markdown already allows inline HTML, meaning everything is already fully forward-compatible.

Comment 2

[Andy McKay]

One bug and its closed already.

Comment 3

[Andy McKay]

Oops thought it was a tracker. After four years there's been no movement on this bug and I'm not really fussed about it. If you care about it, please re-open.