Convert noteblocks for glossary folder

[queengooborg]

This PR converts the noteblocks for the 'glossary' folder to GFM syntax, using a conversion script.

[github-actions]

Preview URLs (24 pages)

• /en-US/docs/Glossary/Base64
• /en-US/docs/Glossary/Block-level_content
• /en-US/docs/Glossary/Boolean/HTML
• /en-US/docs/Glossary/Breadcrumb
• /en-US/docs/Glossary/Certificate_authority
• /en-US/docs/Glossary/Color_space
• /en-US/docs/Glossary/Composite_operation
• /en-US/docs/Glossary/Entity_header
• /en-US/docs/Glossary/First-class_Function
• /en-US/docs/Glossary/First_meaningful_paint
• /en-US/docs/Glossary/Forbidden_header_name
• /en-US/docs/Glossary/General_header
• /en-US/docs/Glossary/HTML5
• /en-US/docs/Glossary/HTTP_header
• /en-US/docs/Glossary/Inline-level_content
• /en-US/docs/Glossary/Method
• /en-US/docs/Glossary/Object
• /en-US/docs/Glossary/Serializable_object
• /en-US/docs/Glossary/Site
• /en-US/docs/Glossary/TLS
• /en-US/docs/Glossary/Transient_activation
• /en-US/docs/Glossary/Void_element
• /en-US/docs/Glossary/XForms
• /en-US/docs/Glossary

External URLs (8)

URL: /en-US/docs/Glossary/Forbidden_header_name
Title: Forbidden header name

• https://crbug.com/571722 (1 time) (Note! This may be a new URL 👀)
• https://fetch.spec.whatwg.org/ (2 times) (Note! This may be a new URL 👀)

---

URL: /en-US/docs/Glossary/First_meaningful_paint
Title: First Meaningful Paint

• https://wicg.github.io/largest-contentful-paint/ (2 times) (Note! This may be a new URL 👀)

---

URL: /en-US/docs/Glossary/Serializable_object
Title: Serializable object

• https://github.com/w3c/webref/tree/main/ed/idl (1 time) (Note! This may be a new URL 👀)

---

URL: /en-US/docs/Glossary/HTML5
Title: HTML5

• https://www.w3.org/blog/news/archives/7753 (1 time) (Note! This may be a new URL 👀)

---

URL: /en-US/docs/Glossary/TLS
Title: Transport Layer Security (TLS)

• https://bugzil.la/1606734 (1 time) (Note! This may be a new URL 👀)
• https://support.mozilla.org/en-US/kb/secure-connection-failed-firefox-did-not-connect (1 time) (Note! This may be a new URL 👀)

---

URL: /en-US/docs/Glossary/Breadcrumb
Title: Breadcrumb

• https://html.spec.whatwg.org/multipage/semantics-other.html (1 time) (Note! This may be a new URL 👀)

(comment last updated: 2024-07-25 21:58:51)

[Josh-Cena]

@queengooborg There is a rendering difference with an extra blank line:

And I don't find it acceptable to make this change, because it doesn't appear revertible to me (once we make this workaround it would be hard to discover all places that are intended as workaround, vs. those intended to start a new paragraph). We may have to wait on the Prettier bug.

In your conversion script, could you not do conversion for any note that starts with non-letters?

In the meantime, I think we should revert all notes with the > \[![A-Z]+\]\n>\n form to the previous state (except callouts, which were supposed to look like that). There aren't many on main.

[queengooborg]

Agh, okay, there is a difference in rendering, whoops -- I genuinely thought that I had added logic to make the rendering identical with a newline in between... 🤦‍♀️

In your conversion script, could you not do conversion for any note that starts with non-letters?

I could make that change, but, uh...I already ran the script on all the files locally, fixed issues related to Prettier/Markdownlint malformatting, and submitted PRs for the vast majority of the docs... 😅

---

Truth be told, I don't think that this rendering difference is too much of an issue if it was styled better (AKA, more like how GitHub renders the noteblocks). But that's just my opinion and would be something that should be discussed before proceeding with!

[Josh-Cena]

@queengooborg Fear not, I'm checking out each of your branches and running a regex search on each one, so you can just look at the cases I pointed out. If you want to do a self-check first, you can search > \[!(NOTE|WARNING)+\]\n>\n|(NOTE|WARNING)\] >.

Truth be told, I don't think that this rendering difference is too much of an issue if it was styled better (AKA, more like how GitHub renders the noteblocks). But that's just my opinion and would be something that should be discussed before proceeding with!

Agreed; I would be equally happy if we render like GitHub (put "Note" on a separate line).

[hochan222]

@queengooborg Hello.

I recently confirmed this change in the locale-ko. Is there a locale guide? 🙇

[queengooborg]

There isn't really a guide for performing the conversion, even for English content -- but there is a script I wrote, which can be found in the description of this PR!

Edit: thinking about it again, I'd say that the closest thing to a guide would be the Markdown in MDN page -- so completing mdn/translated-content#14373 would help!

[hochan222]

I asked because I wanted to change NOTE to Korean, but it looks like I should use NOTE as is!

I understand. I am leaving some of the contents of the MDN Markdown guide for other people. Thank you :)

• https://developer.mozilla.org/en-US/docs/MDN/Writing_guidelines/Howto/Markdown_in_MDN

> [!NOTE]  
> Highlights information that users should take into account, even when skimming.

> [!TIP]
> Optional information to help a user be more successful.

> [!IMPORTANT]  
> Crucial information necessary for users to succeed.

> [!WARNING]  
> Critical content demanding immediate user attention due to potential risks.

> [!CAUTION]
> Negative potential consequences of an action.

[queengooborg]

That's correct -- the magic keywords should stay in English now, rather than being localized. This ensures consistency across locales and better compatibility with Markdown renderers besides Yari (like GitHub's web editor)!

[hochan222]

Agreed; I would be equally happy if we render like GitHub (put "Note" on a separate line).

@queengooborg, @Josh-Cena How about adding prettier ignore?

<!-- prettier-ignore-start -->
> [!NOTE]
> [Here is another example without Canvas or external libraries.](https://jsfiddle.net/jlr7245/teb4znk0/20/)
<!-- prettier-ignore-end -->

[Josh-Cena]

I don't find it necessary and it adds more noise than just keeping it unmigrated.