Skip to content

[i18n-KO] Translated index page to Korean #20180

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

Merged
merged 1 commit into from
Nov 14, 2022

Conversation

wonhyeongseo
Copy link
Contributor

@wonhyeongseo wonhyeongseo commented Nov 12, 2022

What does this PR do?

Translated the Getting started - index.mdx file of the documentation to Korean. I use transformers for my side-project and wanted to contribute. As a beginner, this seemed appropriate.

Some questions:

  • I can't access the pr documentation endpoint for Korean. Is there a missing step?
  • I left all the other files alone after copying the English docs. Is this acceptable for future updates or should I add contents to the _toctree.yml only when translation is complete? Should I delete all other files for a cleaner review?
  • In Korea, people use both Transformer and 트랜스포머 to describe the model. However, as this is more of a product of HuggingFace I opted not to translate it. May you please let me know which you would prefer?

Thank you in advance for your review.

Part of #20179

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?

@sgugger, may you please review this PR?

@HuggingFaceDocBuilderDev

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

@HuggingFaceDocBuilderDev

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

@HuggingFaceDocBuilderDev

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

@ArthurZucker ArthurZucker self-assigned this Nov 12, 2022
@ArthurZucker
Copy link
Collaborator

Hey! 만나서 반가워요! Would love to hear more about the project you were working on and how transformers is used in Korea! 🤗

Thanks a lot for your work!

  • The PR documentation endpoint was updating and should now be visible! The KO is not appearing because I think you did not add the file to the toctree indeed.
  • You should delete all the other files! We don't keep template files and if someone wants to translate for futur updates, they will just copy the single file 😄
  • I think you did a great job in keeping Transformer as it is indeed more the name of the library! When talking about actual transformers architecture, its up to you, and depends on what is more used/understandable!

I will be glad to review once you have cleaned up the modified files! 👍🏻 Also cc @eunseojo just FYI 😉

@HuggingFaceDocBuilderDev

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

@wonhyeongseo
Copy link
Contributor Author

wonhyeongseo commented Nov 12, 2022

Hello @ArthurZucker, 저도 만나서 반가워요! Thank you so much for your warm welcome and guidance.
Thank you for your help with this PR, @eunseojo 🤗

  • I made updates to _toctree.yml as you suggested and also added a language code to .github/workflows/build_*_documentation.
  • So much simpler now! I translated the big section titles as they were mentioned in the index.mdx page. This raised errors from the pr docs workflow saying sections were empty,
    image
    so I added a placeholder called in_translation.mdx. As a result, the left sidebar is a zebra now 🦓 🤣 .
    image
    How would you solve this problem?
  • Yay, 🧨 thank you very much for your compliment hehe

P.S.
I'm just a beginner but Korea, at least a community I learn lots from- PseudoLab, is extensively using huggingface. The government funds a yearly hackathon called OSSCA, kinda like hacktoberfest but with dedicated mentors. RustPython and i18n-Kubernetes team got the Gold and Silver for this year. Our team AzureSDK got Bronze with 5 others.

My side-project goal is to enhance "google translator-ish" results: to a more friendly, neighbourhood tone in Korean (grammar checking included!) I'm still tinkering, just learning mostly how to get this to work. I have another idea for generating children's books, but for a later time perhaps. Thank you for your interest!

@HuggingFaceDocBuilderDev

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

2 similar comments
@HuggingFaceDocBuilderDev

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

@HuggingFaceDocBuilderDev

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

@HuggingFaceDocBuilderDev

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

Copy link
Collaborator

@sgugger sgugger left a comment

Choose a reason for hiding this comment

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

Looking great, thanks a lot for working on this!

Comment on lines 3 to 5
# Transformers installation
! pip install transformers datasets
# To install from source instead of the last release, comment the command above and uncomment the following one.
Copy link
Collaborator

Choose a reason for hiding this comment

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

Would be nice to translate the two comments in Korean!

docs: i18n: first draft of index page
docs: fix: first revision of index page
docs: i18n: missed section - supported frameworks
docs: fix: second revision of index page
review by @ArthurZucker

refactor: remove untranslated files from korean
docs: fix: remove untranslated references from toctree.yml
feat: enable korean docs in gh actions
docs: feat: add in_translation page as placeholder
docs: bug: testing if internal toc need alphabet chars
docs: fix: custom english anchor for non-alphanumeric headings
review by @sgugger

docs: i18n: translate comments on install methods in _config.py
docs: refactor: more concise wording for translations
@HuggingFaceDocBuilderDev

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

@sgugger sgugger merged commit 07d8d6e into huggingface:main Nov 14, 2022
@sgugger
Copy link
Collaborator

sgugger commented Nov 14, 2022

Thanks for working on this! Excited to see a new doc in Korean!

@wonhyeongseo wonhyeongseo deleted the ko-index branch November 14, 2022 17:15
mpierrau pushed a commit to mpierrau/transformers that referenced this pull request Dec 15, 2022
docs: i18n: first draft of index page
docs: fix: first revision of index page
docs: i18n: missed section - supported frameworks
docs: fix: second revision of index page
review by @ArthurZucker

refactor: remove untranslated files from korean
docs: fix: remove untranslated references from toctree.yml
feat: enable korean docs in gh actions
docs: feat: add in_translation page as placeholder
docs: bug: testing if internal toc need alphabet chars
docs: fix: custom english anchor for non-alphanumeric headings
review by @sgugger

docs: i18n: translate comments on install methods in _config.py
docs: refactor: more concise wording for translations
@NoB0 NoB0 mentioned this pull request Feb 4, 2023
10 tasks
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.

4 participants