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

🌐 [i18n-KO] Translated README, landing docs to Korean #1667

Merged
merged 13 commits into from
Oct 2, 2023

Conversation

wonhyeongseo
Copy link
Contributor

@wonhyeongseo wonhyeongseo commented Sep 15, 2023

What does this PR do?

Key features

  • Translates main README to Korean;
  • Translates the main landing docs (index, installation , quick-start) to Korean;

Part of #1626

Before reviewing

  • Check for missing / redundant translations (번역 누락/중복 검사)
  • Grammar Check (맞춤법 검사)
  • Review or Add new terms to glossary (용어 확인 및 추가)
  • Check Inline TOC (e.g. [[lowercased-header]])
  • Check live-preview for gotchas (live-preview로 정상작동 확인)

Who can review? (Initial)

Team PseudoLab, may you please review this PR? @0525hhgus, @kihoon71, @sim-so, @gabrielwithappy, @HanNayeoniee, @wonhyeongseo, @jungnerd

Before submitting

  • This PR fixes a typo or improves the docs (you can dismiss the other checks if that's the case).
  • Did you read the contributor guideline,
    Pull Request section?
  • Was this discussed/approved via a Github issue or the forum? Please add a link
    to it if that's the case.
  • Did you make sure to update the documentation with your changes? Here are the
    documentation guidelines, and
    here are tips on formatting docstrings.
  • Did you write any new necessary tests?

Who can review? (Final)

@wonhyeongseo wonhyeongseo changed the title 🌐 [i18n-KO] Translated README.md to Korean 🌐 [i18n-KO] Translated docs to Korean Sep 15, 2023
@wonhyeongseo wonhyeongseo marked this pull request as draft September 15, 2023 06:51
@wonhyeongseo wonhyeongseo changed the title 🌐 [i18n-KO] Translated docs to Korean 🌐 [i18n-KO] Translated README, landing docs to Korean Sep 15, 2023
@wonhyeongseo wonhyeongseo marked this pull request as ready for review September 15, 2023 07:51
@wonhyeongseo wonhyeongseo marked this pull request as draft September 15, 2023 08:16
@Wauplin
Copy link
Contributor

Wauplin commented Sep 18, 2023

Hi @wonhyeongseo, thanks for working on this PR!
Please let me know if you have any questions or want some feedback on something. Unfortunately I will not be able to review myself the content but happy to help if you have technical questions. Once the PR is ready, please let me know. If you know potential reviewers in the Korean community, that's for the best. Otherwise, we will figure out a way! :)

@wonhyeongseo
Copy link
Contributor Author

wonhyeongseo commented Sep 18, 2023

Hi @Wauplin , really appreciate it.

I will be able to translate seven of the guides (highlighted in the README) by this week Friday.

This is quite different from what we have done previously, which was one document at a time. But like you said, we together will figure out a way.

I will be sure to ask questions on the content throughout the process. Please stay tuned 😆

Best regards from Korea,
Won

@Wauplin
Copy link
Contributor

Wauplin commented Sep 18, 2023

I will be able to translate seven of the guides (highlighted in the README) by this week Friday.
This is quite different from what we have done previously, which was one document at a time.

That's a big effort! Thanks for the commitment to make those docs available to more ML-enthusiast!
If making everything in a single PR is a lot, it's also perfectly fine to do it incrementally and do not add links in the README yet. Please do as you find it the more convenient! :)

@wonhyeongseo wonhyeongseo marked this pull request as ready for review September 20, 2023 07:25
@wonhyeongseo
Copy link
Contributor Author

Opening the remaining Hub docs to our mentees and the community, as requested in our Tuesday meeting.
I linked the untranslated guides to the English versions and added the German link to the main README.md.

This PR is ready for review, have a wonderful day @Wauplin!

Copy link
Contributor

@Wauplin Wauplin left a comment

Choose a reason for hiding this comment

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

Thanks for the great effort @wonhyeongseo! I've reviewed the PR but only from a high-level aspect (checking links and configs). Found an inconsistency for overview and upload guides but apart from that it looks good to me. I like the idea of a in_translation page so that we already get an first version to iterate on.

Have a great day as well 🤗

Comment on lines +11 to +16
- local: guides/overview
title: 개요
- local: guides/download
title: 파일 다운로드하기
- local: in_translation
title: (번역 중) Upload files
Copy link
Contributor

Choose a reason for hiding this comment

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

  • guides/overview has not being added to this PR. Would be best to either remove it (set to in_translation) or add a translated version of the overview page
  • The upload guide has being uploaded to this PR but entirely in English. Maybe just a mistake?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Hi @Wauplin, thank you for your helpful feedback!

There was a mistake in deleting overview.md instead of upload.md. It has been fixed in a new commit.
The document will be proof-read for the next 3 days. Please feel free to share any suggestions or comments. Otherwise, I think we can merge it after that.

Copy link
Contributor

@Wauplin Wauplin left a comment

Choose a reason for hiding this comment

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

Looks good to me! Thanks for making the change @wonhyeongseo :)
Approved the PR but as you said, let's wait for proof-reading before merging.

@wonhyeongseo
Copy link
Contributor Author

Hello @Wauplin, hope you are doing well.
With no further review comments, I think we are ready to merge! Thank you so much for your support.

@Wauplin Wauplin merged commit 18e7cf3 into huggingface:main Oct 2, 2023
@Wauplin
Copy link
Contributor

Wauplin commented Oct 2, 2023

And... it's live! https://huggingface.co/docs/huggingface_hub/main/ko/index 🚀 Well done for this first doc sprint @wonhyeongseo !

@wonhyeongseo wonhyeongseo deleted the ko-readme branch October 2, 2023 08:13
@julien-c
Copy link
Member

julien-c commented Oct 2, 2023

very cool great job @wonhyeongseo !!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants