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

Add translation guide + update repo structure #1602

Merged
merged 5 commits into from
Aug 28, 2023
Merged

Conversation

Wauplin
Copy link
Contributor

@Wauplin Wauplin commented Aug 18, 2023

Triggered by #1601 and private slack thread.

This PR adds:

  • a docs/source/en/ folder in which all current documentation had been moved
  • a docs/README.md guide to explain how to write docs (adapted from transformers)
  • a docs/TRANSLATING.md guide to explain how to start translating to a new language (adapted from transformers)
  • a .github/ISSUE_TEMPLATE/i18n.md template to create a new translation issue
  • a new install group (pip install -e ".[docs]")

The goal is to start translating huggingface_hub's docs to other languages like for transformers and diffusers libraries.

Copy link
Member

@julien-c julien-c left a comment

Choose a reason for hiding this comment

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

very supportive of this!

@LysandreJik
Copy link
Member

@stevhliu, would be interested in your review!

Also cc @wonhyeongseo in case you'd be interested in launching a similar event to huggingface/transformers#20179 once this has landed and been merged.

@wonhyeongseo
Copy link
Contributor

Would love to! We'll start as soon as possible. Thank you for the heads up, @LysandreJik !

Much love from Korea,
Won

Copy link
Member

@LysandreJik LysandreJik 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! Thanks for working on this @Wauplin 🙌

docs/README.md Outdated Show resolved Hide resolved
docs/README.md Outdated Show resolved Hide resolved
docs/TRANSLATING.md Outdated Show resolved Hide resolved
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.

Super cool, looking forward to all the translations! 🤗 🌐

docs/README.md Outdated Show resolved Hide resolved
Wauplin and others added 3 commits August 28, 2023 12:14
Co-authored-by: Lysandre Debut <lysandre.debut@reseau.eseo.fr>
Co-authored-by: Steven Liu <59462357+stevhliu@users.noreply.github.com>
@Wauplin
Copy link
Contributor Author

Wauplin commented Aug 28, 2023

Thanks for the review @LysandreJik @stevhliu! 🙏
I'll merge this PR asap so that future PRs are not impacted by it. I'll work on event/promoting it once I'm done with unpiling my notifications after my time off :)

@Wauplin Wauplin merged commit e16089a into main Aug 28, 2023
10 of 15 checks passed
@Wauplin Wauplin deleted the 1601-enable-translations branch August 28, 2023 10:20
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.

None yet

5 participants