1828390 - Update "myst_parser" to version 2.0

Status: RESOLVED FIXED

(Developer Infrastructure :: Firefox Source Docs: Content, defect)

Description

[Julian Descottes [:jdescottes]]

Examples:

• Matrix link in https://firefox-source-docs.mozilla.org/bug-mgmt/processes/accessibility-review.html (source)
• DevTools performance alerts from PerfHerder link in https://firefox-source-docs.mozilla.org/devtools/performance-sheriffing.html (source)

Probably others?

How can we write those links to be properly rendered by Sphinx?

Comment 1

[BugBot [:suhaib / :marco/ :calixte]]

The severity field is not set for this bug.
:Sylvestre, could you have a look please?

For more information, please visit BugBot documentation.

Comment 2

[Nick Alexander :nalexander [he/him]]

I wondered if URL (%) encoding these URLs would work, but it doesn't. With:

diff --git a/docs/bug-mgmt/processes/accessibility-review.md b/docs/bug-mgmt/processes/accessibility-review.md
index 3358defd7e3dc..47bc7e53521da 100644
--- a/docs/bug-mgmt/processes/accessibility-review.md
+++ b/docs/bug-mgmt/processes/accessibility-review.md
@@ -94,7 +94,7 @@ If you have any questions, please don't hesitate to contact the Accessibility
 team:
 
 * \#accessibility on
-  [Matrix](https://matrix.to/#/!jmuErVonajdNMbgdeY:mozilla.org?via=mozilla.org&via=matrix.org)
+  [Matrix](https://matrix.to/#/!jmuErVonajdNMbgdeY:mozilla.org?via=mozilla.org%26via=matrix.org)
   or [Slack](https://mozilla.slack.com/archives/C4E0W8B8E)
 * Email: [e-mail]
 * Please avoid reaching out to individual team members directly -- containing review requests and questions in these channels helps us balance our workload. Thank you!

I get rendering like:

$ grep -i matrix ../objdirs/objdir-browser-compile/docs/html/bug-mgmt/processes/accessibility-review.html
<a class="reference external" href="https://matrix.to/#/!jmuErVonajdNMbgdeY:mozilla.org?via=mozilla.org%26via=matrix.org">Matrix</a>

But the browser doesn't interpret that URL as expected. :(

This is a known issue in myst_parser: https://github.com/executablebooks/MyST-Parser/issues/127.

Comment 3

[Nick Alexander :nalexander [he/him]]

A helpful soul suggested that this is addressed in newer myst_parser versions -- we're on 1.0 and the latest is 2.0.0.

Comment 4

[Henrik Skupin [:whimboo][⌚️UTC+2]]

Hi Sylvestre, would an upgrade of myst_parser to at least version 2.0.0 be doable? It would fix quite a bit of broken links in our documentation. Thanks.

Comment 5

[Sylvestre Ledru [:Sylvestre]]

Attachment: Bug 1828390 - doc: upgrade to myst-parser 2.0 (fixes link issues) r?#firefox-source-docs-reviewers

Comment 6

[Pulsebot]

Pushed by [e-mail]:
https://hg.mozilla.org/integration/autoland/rev/83d790607247
doc: upgrade to myst-parser 2.0 (fixes link issues) r=firefox-source-docs-reviewers,championshuttler DONTBUILD

Comment 7

[pstanciu]

https://hg.mozilla.org/mozilla-central/rev/83d790607247

Comment 8

[Henrik Skupin [:whimboo][⌚️UTC+2]]

(In reply to Nick Alexander :nalexander [he/him] from comment #3)

A helpful soul suggested that this is addressed in newer myst_parser versions -- we're on 1.0 and the latest is 2.0.0.

I actually do not see a change with the new 2.0.0 version. & is still not correctly encoded. Now when I take a look at the referenced GitHub issue I can actually see that the topic of it was around URLs within a table.

Nick, can you confirm that it also still not work for you? If not we should file a follow-up bug.

Comment 9

[Julian Descottes [:jdescottes]]

The specific issue we have here is discussed at https://github.com/executablebooks/MyST-Parser/issues/760 and is still not resolved

Comment 10

[Henrik Skupin [:whimboo][⌚️UTC+2]]

Lets then just make this bug about updating the myst_parser to version 2.0.

Comment 11

[Nick Alexander :nalexander [he/him]]

(In reply to Julian Descottes [:jdescottes] from comment #9)

The specific issue we have here is discussed at https://github.com/executablebooks/MyST-Parser/issues/760 and is still not resolved

Oh damn, sorry to mislead.

Comment 12

[Sylvestre Ledru [:Sylvestre]]

(In reply to Nick Alexander :nalexander [he/him] from comment #11)

Oh damn, sorry to mislead.

no worries, it is still relevant to upgrade it :)