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

Added translation of 3 files as mentioned in issue #1772

Merged
merged 34 commits into from
Oct 26, 2023

Conversation

aneeshd27
Copy link
Contributor

@aneeshd27 aneeshd27 commented Oct 21, 2023

Worked on Issue- #1771
Added translation of quick-start.md,installation.md and index.md and made changes in yml file.
@Wauplin can you please take a look at it ?
It would mean to lot.
Thank you.

@Wauplin
Copy link
Contributor

Wauplin commented Oct 23, 2023

Hey @aneeshd27 🤗 Thanks a lot for starting this work! 🔥 I'll definitely have a look at it yes :)

A few things I've spotted:

  1. It's preferable to not add the pages that are not translated yet. You can either remove them from _toctree.yml which will have as an effect to redirect the user to the English version of the page. Otherwise you can also create a page "in translation" and redirect to this one instead (to let users know it's not translated yet. My fear with adding duplicated English pages is that we lose track of which files are translated and which ones aren't (and also would need duplicated work when updating the English docs). Here is an example of how it has been done in the Korean documentation.
  2. The package_reference section can be removed IMO. This is not a section that can be translated given that it is 90% auto-generated content from the function docstrings (which are hard-coded in English). The translated documentation should focus more on the how-to guides themselves.
  3. A nice addition if you have the time would be to translate the README as well (example here for German). Since this is the entry-point for the Github repository, it is good to have it translated so that Hindi-speaking users can directly see that some content is dedicated to their language. If you prefer, this can also be done in a future PR.
  4. Finally, the build_pr_documentation.yml and build_documentation.yml have to be updated so that Hindi documentation are generated as well by the CI. You just need to update the language line by languages: en de hi ko in both files.

And I think that's it from a technical point of view. About the Hindi content itself I'll ping some members from the Hindi-speaking community to review 🤗 Thanks again for the hard work!

@Vaibhavs10 Vaibhavs10 self-assigned this Oct 23, 2023
Copy link
Member

@Vaibhavs10 Vaibhavs10 left a comment

Choose a reason for hiding this comment

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

Very cool! Thanks for beginning translation work! <3

There are some inconsistencies in the translation:

  1. IMO, whenever we mention the package then, it should be mentioned as huggingface_hub
  2. Next, let's make sure that all the URLs work, some URLs are in Hindi and the others in English, do make sure to test this.

happy to re-review after you take a pass.

docs/source/hi/index.md Outdated Show resolved Hide resolved
docs/source/hi/index.md Outdated Show resolved Hide resolved
docs/source/hi/index.md Outdated Show resolved Hide resolved
docs/source/hi/index.md Outdated Show resolved Hide resolved
docs/source/hi/installation.md Outdated Show resolved Hide resolved
docs/source/hi/installation.md Outdated Show resolved Hide resolved
docs/source/hi/installation.md Outdated Show resolved Hide resolved
docs/source/hi/installation.md Outdated Show resolved Hide resolved
docs/source/hi/installation.md Outdated Show resolved Hide resolved
docs/source/hi/installation.md Outdated Show resolved Hide resolved
Added hindi translation in file to avoid redirects for non-translated files
Added Hindi Translation for README file
Added hi-ISO 639 code in yaml file
Added hi code in file
Added the changes mentioned in code review
Made the required changes mentioned in the code review
Corrected a typo
@aneeshd27
Copy link
Contributor Author

aneeshd27 commented Oct 23, 2023

@Wauplin I have made the necessary changes as mentioned before review.
@Vaibhavs10 I have made the required changes as mentioned during review like replace translated library into English.
It would be great if you take a look at it.
Thank you,
Aneesh.
😄

Issue: #1771
Pull Request: #1772

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 making the changes to the workflow files and incorporating feedback from the previous review. I left a few new comments about files that are not necessary yet. We will add them iteratively in future PRs.

Thank you also for translating the README.md file! That's a very important one to get started. @Vaibhavs10 would you mind taking a look at it?

@aneeshd27 most of my comments are about setting up the translated docs for the first time. I promise that next PRs will be much easier to write :)

docs/source/hi/_redirects.yml Outdated Show resolved Hide resolved
docs/source/hi/_toctree.yml Outdated Show resolved Hide resolved
docs/source/hi/_toctree.yml Outdated Show resolved Hide resolved
README_hi.md Outdated Show resolved Hide resolved
Delete redirects.yml as mentioned during review
Updated _toctree.yml Removed all the Hindi translation that have not been done yet.Have kept the english translation for redirection
Changed the order to en de hi ko
Added translation link of README_hi.md in file
Added translation links of Korean files as mentioned in review
Updated file
@aneeshd27
Copy link
Contributor Author

Made Changes as mentioned in Review 2 of the branch aneeshd27-translation

Copy link
Member

@Vaibhavs10 Vaibhavs10 left a comment

Choose a reason for hiding this comment

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

The README looks good to me! Great job!

README_hi.md Outdated Show resolved Hide resolved
Updated the suggested changes
Updated the changes
@aneeshd27
Copy link
Contributor Author

Updated the necessary changes as mentioned in the review.
@Vaibhavs10 Can you please take a look at it?
Thank you,
Aneesh 😄

@aneeshd27
Copy link
Contributor Author

I have made the told changes as mentioned in the review.
@Wauplin Can you please take a look at it?
Thank you,
Aneesh 😄

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 making the changes @aneeshd27! I think the last thing to change from a technical point of view is to remove all guides/concepts pages from this PR. The goal is that only Hindi-written pages are added in the PR, nothing else.
Thank you in advance!
Wauplin

README_hi.md Outdated Show resolved Hide resolved
@@ -0,0 +1,62 @@
<!--⚠️ Note that this file is in Markdown but contain specific syntax for our doc-builder (similar to MDX) that may not be
Copy link
Contributor

Choose a reason for hiding this comment

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

Since this file is not translated and not referenced in the toctree, can you remove it from the PR?
(same for all files in /concepts and /guides)

@@ -0,0 +1,5 @@
<!--⚠️ Note that this file is in Markdown but contain specific syntax for our doc-builder (similar to MDX) that may not be
Copy link
Contributor

Choose a reason for hiding this comment

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

In the end this file can be removed as it is not referenced anywhere.

@aneeshd27
Copy link
Contributor Author

I have made all the changes like deleting files from concepts and guides folder which have not been translated.
@Wauplin Can you please check if the right changes have been made?
Thank you,
Aneesh 😄

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.

Perfect! Everything looks good now! Thanks for the additional changes 🙏

@Vaibhavs10 would you like to make a last review or are we good to merge?
EDIT: I just realized you already reviewed the README as well. Will merge then :)

@HuggingFaceDocBuilderDev
Copy link

HuggingFaceDocBuilderDev commented Oct 26, 2023

The documentation is not available anymore as the PR was closed or merged.

@Wauplin Wauplin merged commit b3e06ae into huggingface:main Oct 26, 2023
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