Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Markdown] [Glossary] Convert Glossary to markdown - DO NOT SQUASH MERGE #9384

Closed
wants to merge 2 commits into from

Conversation

wbamberg
Copy link
Collaborator

This PR converts the Glossary (https://developer.mozilla.org/en-US/docs/Glossary) to Markdown.

The preparation PR for this: #9361.

The conversion report:

# Report from 9/30/2021, 11:38:32 AM
## All unhandled elements
- sub (8)
- section#Quick_links (1)
## Details per Document
### [/en-US/docs/Glossary/Bézier_curve](https://developer.mozilla.org/en-US/docs/Glossary/Bézier_curve)
### Missing conversion rules
- sub (13:173)
- sub (13:188)
- sub (13:203)
- sub (13:222)
- sub (15:64)
- sub (15:81)
- sub (15:114)
- sub (15:131)
### [/en-US/docs/Glossary](https://developer.mozilla.org/en-US/docs/Glossary)
### Missing conversion rules
- section#Quick_links (28:1)

(unconverted elements were discussed in #9361).

@wbamberg wbamberg requested a review from a team as a code owner September 30, 2021 18:47
@wbamberg wbamberg requested review from Rumyra and removed request for a team September 30, 2021 18:47
@github-actions github-actions bot added the Content:Glossary Glossary entries label Sep 30, 2021
@github-actions

This comment has been minimized.

@wbamberg
Copy link
Collaborator Author

To coordinate reviews I've created https://docs.google.com/spreadsheets/d/1wefKa0rTmHLZAg0GVZ69aNQL_h5eatUYBX0DmeE9MqE/edit?usp=sharing

As before, the purpose of this is just to ensure different people review different pages.


## Advantages of Data Abstraction

* Helps the user to avoid writing low level code.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@wbamberg Why has the double space reappeared in bullets? I saw this in Ruth's PR too.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't know about Ruth's PR, but in my case I was using the wrong branch of the converter, so Prettier formatting wasn't being applied :(. I can force-push an update.

This also means I need to Prettify the SVG and HTML docs, which will be fun.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should be fixed now.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes it is. Much better.

Good luck with prettifying the SVG and HTML docs. Can you apply to MDN too (if that has already gone in)?

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Here's a draft PR: https://github.com/mdn/content/pull/9395/files - I am too tired to look at it properly, but it's not as bad as I had feared.

Interesting thing is you can also ask Prettier to format quoted code blocks - I have switched it off here (and h2m has it switched off too) but I think it would be great to have consistently formatted code samples!

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@wbamberg I would have approved it - easy to review. I like consistent code samples too - by quoted, do you mean using the backticks? If so, yes, we should always do that.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That's much nicer, at least in this case. I worry about other cases.

* [ECMAScript Language Specification](https://tc39.es/ecma262/#sec-white-space)
* [Glossary](/en-US/docs/Glossary)

1. {{Glossary("Character")}}
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not a conversion issue, but this is odd.

@hamishwillee
Copy link
Collaborator

@wbamberg I might do a proper review later, but for now looks great except for the double spaces on bullets.

We could fix up the remaining quick_links divs too, if only because the converter will then do the work for us of bulletizing that.

@wbamberg
Copy link
Collaborator Author

wbamberg commented Oct 6, 2021

Since this has rotted I've closed it and opened a new one at #9630.

@wbamberg wbamberg closed this Oct 6, 2021
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Oct 6, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
Content:Glossary Glossary entries
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants