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

Chore - convert all HTML files to Markdown #7486

Closed
7 tasks done
queengooborg opened this issue Aug 9, 2022 · 22 comments
Closed
7 tasks done

Chore - convert all HTML files to Markdown #7486

queengooborg opened this issue Aug 9, 2022 · 22 comments
Labels
help wanted If you know something about this, we would love your help! l10n-es Issues related to Spanish content. l10n-pt-br Issues related to Brazilian Portuguese l10n-ru Issues related to Russian content. markdown-conversion 100% markdown project

Comments

@queengooborg
Copy link
Collaborator

queengooborg commented Aug 9, 2022

This issue is an overview issue for the Markdown conversion project. Throughout the localized content, there are still 20,919 6,813 files that have yet to be converted from HTML to Markdown. This applies to all locales and should be considered a high priority task.

Instructions:

Please carefully read the conversion guide in the mdn/markdown repository. The script that you will need is also contained within this repository.

Reviewers: remember to rebase merge instead of squash merge to retain Git history for converted files!

Locales:

@queengooborg queengooborg added help wanted If you know something about this, we would love your help! l10n-ja Issues related to Japanese content. l10n-fr Issues related to French content. l10n-zh Issues related to Chinese content. l10n-es Issues related to Spanish content. l10n-ru Issues related to Russian content. l10n-ko Issues related to Korean content. l10n-pt-br Issues related to Brazilian Portuguese markdown-conversion 100% markdown project and removed l10n-fr Issues related to French content. labels Aug 9, 2022
@queengooborg queengooborg added this to the Markdown conversion milestone Aug 9, 2022
@hochan222 hochan222 pinned this issue Aug 10, 2022
@SphinxKnight
Copy link
Member

SphinxKnight commented Aug 10, 2022

Thanks a lot @queengooborg
I hope https://github.com/mdn/translated-content/discussions/2474 may also be useful to provide a guide/process.

@queengooborg
Copy link
Collaborator Author

Thanks for linking that guide, @SphinxKnight, this is really amazing!

Do you mind if I update the guide text, including pointing translators to my fork of mdn/markdown, and update a few descriptions of special cases that don't need to be handled any longer? I know that sounds like a little bit of self-advertising (since it's my own fork and all), but the upstream script contains a critical issue that causes loss of information (and my updates do handle a lot of the special cases previously unhandled) and I want to discourage the upstream script's use until the issues have been resolved (AKA my PR is merged)!

@SphinxKnight
Copy link
Member

Do you mind if I update the guide text, including pointing translators to my fork of mdn/markdown, and update a few descriptions of special cases that don't need to be handled any longer?

Please do if you can edit it :)
And if you can't directly, let me know your version over a pastebin or Matrix and I'll apply it

@queengooborg
Copy link
Collaborator Author

Good news: my changes were now merged upstream and I have write access to the upstream repository now, so I'll be able to update the script much easier!

@hochan222
Copy link
Member

  1. Run yarn h2m <folder> --locale <locale> --mode replace

It seems that md is missing somehow, is that correct..? Or are there any other recent changes?

yarn md h2m <folder> --locale <locale> --mode replace

@queengooborg
Copy link
Collaborator Author

That's correct, yes! Because "h2m" is the only command in the repository, I removed the "md" part of the command for a little more simplicity!

@hochan222
Copy link
Member

If so, the code merge hasn't been done yet. Thanks for the reply :)

package.json for yari

"md": "ts-node markdown/cli.ts",

@queengooborg
Copy link
Collaborator Author

Ah, you should actually be using https://github.com/mdn/markdown, not Yari -- the code has been moved out of Yari a long time ago (I thought it was actually removed from Yari), and the version in Yari is not getting any updates!

@queengooborg

This comment was marked as outdated.

@queengooborg queengooborg added the l10n-pl (retired) Issues related to Polish content. label Aug 13, 2022
@mfuji09

This comment was marked as outdated.

@queengooborg

This comment was marked as outdated.

@hochan222

This comment was marked as outdated.

@queengooborg

This comment was marked as outdated.

@hochan222

This comment was marked as outdated.

@yin1999

This comment was marked as outdated.

@mfuji09

This comment was marked as outdated.

@yin1999 yin1999 removed the l10n-zh Issues related to Chinese content. label Aug 20, 2022
@mfuji09
Copy link
Collaborator

mfuji09 commented Aug 26, 2022

'ja' locale is done.

@hochan222
Copy link
Member

ko locale is done :)

@cw118 cw118 removed the l10n-ko Issues related to Korean content. label Oct 3, 2022
@SphinxKnight
Copy link
Member

pt-BR is done apart from conflicting and orphaned folders :) Thanks @josielrocha and @nathipg for the reviews 🙇

@Graywolf9
Copy link
Contributor

es locale is done!

@SphinxKnight
Copy link
Member

and ru is done as well thanks to @sashasushko :)

Only HTML files remaining are oprhaned/conflicting for ru and pt-BR

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
help wanted If you know something about this, we would love your help! l10n-es Issues related to Spanish content. l10n-pt-br Issues related to Brazilian Portuguese l10n-ru Issues related to Russian content. markdown-conversion 100% markdown project
Projects
None yet
Development

No branches or pull requests

8 participants
@SphinxKnight @queengooborg @mfuji09 @Graywolf9 @yin1999 @hochan222 @cw118 and others