Skip to content

Conversation

mjk0618
Copy link
Contributor

@mjk0618 mjk0618 commented Aug 30, 2023

What does this PR do?

Translated the contributing.md file of the documentation to Korean.
Thank you in advance for your review.

Part of #20179

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)

@bolizabeth, @nuatmochoi, @heuristicwave, @mjk0618, @keonju2, @harheem, @HongB1, @junejae, @54data, @seank021, @augustinLib, @sronger, @TaeYupNoh, @kj021, @eenzeenee

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)

May you please review this PR? @sgugger, @ArthurZucker, @eunseojo

@mjk0618 mjk0618 changed the title 🌐 [i18n-KO] contributing.md to Korean 🌐 [i18n-KO] Translated contributing.md to Korean Aug 31, 2023
mjk0618 and others added 12 commits August 31, 2023 17:37
Co-authored-by: Haewon Kim <ehdvkf02@naver.com>
Co-authored-by: Haewon Kim <ehdvkf02@naver.com>
Co-authored-by: Haewon Kim <ehdvkf02@naver.com>
Co-authored-by: Haewon Kim <ehdvkf02@naver.com>
Co-authored-by: Haewon Kim <ehdvkf02@naver.com>
Co-authored-by: Haewon Kim <ehdvkf02@naver.com>
Co-authored-by: SeongWooChoi <46990061+nuatmochoi@users.noreply.github.com>
Co-authored-by: SeongWooChoi <46990061+nuatmochoi@users.noreply.github.com>
Co-authored-by: SeongWooChoi <46990061+nuatmochoi@users.noreply.github.com>
Copy link
Member

@stevhliu stevhliu 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 translation! 🤗

Can you copy the contents of CONTRIBUTING_ko.md into contributing.md? We should just have one file for this.

@mjk0618
Copy link
Contributor Author

mjk0618 commented Aug 31, 2023

Thanks for the translation! 🤗

Can you copy the contents of CONTRIBUTING_ko.md into contributing.md? We should just have one file for this.

Thank you for reviewing the translation!

In that case, should I delete the CONTRIBUTING_ko.md file in the root directory and just leave the contributing.md file in the docs/source/ko directory? The reason I added the CONTRIBUTING_ko.md file in the root directory is because the contributing.md file in the original English document had a different directory structure compared to the other documents.

@stevhliu
Copy link
Member

stevhliu commented Sep 1, 2023

Oh nevermind, I see what you mean! You can feel free to mark the PR as ready for review and we can merge!

@mjk0618 mjk0618 marked this pull request as ready for review September 1, 2023 18:40
@mjk0618
Copy link
Contributor Author

mjk0618 commented Sep 2, 2023

Oh nevermind, I see what you mean! You can feel free to mark the PR as ready for review and we can merge!

Thank you for your help! I marked the PR as ready for review. Could you please review and merge it?

@mjk0618
Copy link
Contributor Author

mjk0618 commented Sep 5, 2023

May you please review this PR? @sgugger, @ArthurZucker, @eunseojo

@stevhliu
Copy link
Member

stevhliu commented Sep 5, 2023

@ArthurZucker, I think the build_pr_documentation test is failing because docs/source/ko/contributing.md is just a path to the actual docs and the generate_frontmatter_in_text function is expecting a level 1 header. Would it still be ok to merge this PR?

@ArthurZucker
Copy link
Collaborator

@stevhliu would be better if we find a fix! It's my first time seeing this so not really sure

@mjk0618
Copy link
Contributor Author

mjk0618 commented Sep 8, 2023

@stevhliu Thank you for reviewing my PR! Then, should I try to fix something so that the error does not occur? I think I have to try to find out the reason for the error, if I can help fixing the problem. If it's something I can't do, would it be better to wait while translating other documents?

@stevhliu
Copy link
Member

stevhliu commented Sep 8, 2023

I think it's an issue with the test not recognizing the path to contributing_ko.md in the docs. We'll look into this issue, but in the meantime, feel free to keep up the good work translating other docs. This issue is probably only affecting this specific doc. 🙂

@@ -0,0 +1 @@
../../../CONTRIBUTING_ko.md
Copy link
Member

Choose a reason for hiding this comment

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

I think the simplest solution would be to copy everything from CONTRIBUTING_ko.md into contributing.md. Then we can update the original English CONTRIBUTING.md doc with a link to the Korean one in the docs.

Copy link
Contributor Author

@mjk0618 mjk0618 Sep 12, 2023

Choose a reason for hiding this comment

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

Before I make a new commit, I wanted to confirm if I understood correctly. Then, should I delete the CONTRIBUTING_ko.md file I added to the root directory, and copy all the contents to docs/source/ko/contributing.md file?

Copy link
Member

Choose a reason for hiding this comment

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

Correct!

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Thank you for your help! I've just finished what I should do.

Copy link
Member

Choose a reason for hiding this comment

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

Nothing left to do except merge! 🚀

@HuggingFaceDocBuilderDev

The docs for this PR live here. All of your documentation changes will be reflected on that endpoint.

Copy link
Member

@stevhliu stevhliu left a comment

Choose a reason for hiding this comment

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

Great work! Thanks for being patient and working with us on this 😄

@stevhliu stevhliu merged commit 92f2fba into huggingface:main Sep 12, 2023
@mjk0618
Copy link
Contributor Author

mjk0618 commented Sep 12, 2023

Great work! Thanks for being patient and working with us on this 😄

Thank you so much for helping me complete this work successfully! Have a nice day!

parambharat pushed a commit to parambharat/transformers that referenced this pull request Sep 26, 2023
* docs: ko-contributing.md

* feat: chatGPT draft

* feat: manual edits

* feat: change linked document

* fix: resolve suggestion

Co-authored-by: Haewon Kim <ehdvkf02@naver.com>

* fix: resolve suggestion

Co-authored-by: Haewon Kim <ehdvkf02@naver.com>

* fix: resolve suggestion

Co-authored-by: Haewon Kim <ehdvkf02@naver.com>

* fix: resolve suggestion

Co-authored-by: Haewon Kim <ehdvkf02@naver.com>

* fix: resolve suggestion

Co-authored-by: Haewon Kim <ehdvkf02@naver.com>

* fix: resolve suggestion

Co-authored-by: Haewon Kim <ehdvkf02@naver.com>

* fix: resolve suggestion

Co-authored-by: SeongWooChoi <46990061+nuatmochoi@users.noreply.github.com>

* fix: resolve suggestion

Co-authored-by: SeongWooChoi <46990061+nuatmochoi@users.noreply.github.com>

* fix: resolve suggestion

Co-authored-by: SeongWooChoi <46990061+nuatmochoi@users.noreply.github.com>

* fix: resolve suggestion

* fix: resolve suggestion

* feat: delete file to resolve error

---------

Co-authored-by: Haewon Kim <ehdvkf02@naver.com>
Co-authored-by: SeongWooChoi <46990061+nuatmochoi@users.noreply.github.com>
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.

7 participants