Probe description does not support <br> HTML or list item markdown

[mcomella]

The old metrics.md supported html tags like <br> and list items (lines starting with -) (example:

However, the probe dictionary doesn't support it (example):

Without lists or the ability to add paragraphs, it makes it difficult (for me) to write information about complex probes clearly.

[wlach]

Yeah, we intentionally escape some of the markdown in the description. The problem was that people were unintentionally adding HTML tags (without quoting) in the metrics files, which caused weird issues on occasion (see e.g. mozilla-mobile/fenix#19243). On reflection, the right answer is probably just to fix these issues in the source, rather than remove flexibility on what people can do to avoid footguns. I'll try to address this.

That said, lists and paragraphs are supported in markdown without having to write HTML, using plain old markdown syntax. You should be able to express what you need to for your metric above in a more legible way by doing that.

[mcomella]

That said, lists and paragraphs are supported in markdown without having to write HTML, using plain old markdown syntax. You should be able to express what you need to for your metric above in a more legible way by doing that.

Ah, this wasn't the case in the metrics.md file so I used HTML tags to work around it. 😆 It sounds better to just use markdown though – I'll do this going forward.

[wlach]

I filed a bug in glean parser to handle invalid HTML in the future: https://bugzilla.mozilla.org/show_bug.cgi?id=1733256

I'm going to just literally render anything passed in for the Glean Dictionary from now on, PR incoming...