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

Multilingualization of the user manual #323

Closed
btbf opened this issue Apr 23, 2022 · 7 comments
Closed

Multilingualization of the user manual #323

btbf opened this issue Apr 23, 2022 · 7 comments

Comments

@btbf
Copy link
Contributor

btbf commented Apr 23, 2022

Why & What

There is no doubt that the Hydra Head Protocol is a Cardano Blockchain Layer 2 solution that many developers will need.
However, in order for more people around the world to build the Hydra Head Protocol, a shortcut is to make it available in multiple languages. Especially for those who are not fluent in English, English documentation is a hurdle that will slow down the deployment of Hydra.

However, it is difficult to support many languages with a limited number of people.

The https://hydra.family/ documentation is built on the Docusaurus base, which allows for i18n markdown translation.

For this reason, it is possible to seek localization cooperation from the community.

I am Japanese and can translate it into Japanese.

Product requirements (optional)

Docusaurus v2

Technical requirements (optional)

https://docusaurus.io/docs/i18n/introduction

RFC
facebook/docusaurus#3317

PR
facebook/docusaurus#3325

@btbf btbf changed the title Multilingualization of the use manual Multilingualization of the user manual Apr 23, 2022
@KtorZ
Copy link
Collaborator

KtorZ commented Apr 23, 2022

@btbf thanks for reaching out and, I definitely support your initiative! if you can work on the translation, I (or we) will make sure to rework the doc sources to work with i18n and make adding new translations easy; shouldn't be too hard with Docusaurus indeed.

@KtorZ
Copy link
Collaborator

KtorZ commented Apr 23, 2022

On a second note: we'll have to think about how to keep the translations in-sync. Given that the project is still under heavy development, we add and change documentation quite a lot.

@btbf
Copy link
Contributor Author

btbf commented Apr 23, 2022

@KtorZ I would be delighted to help you with the project.
Would you like to start with Japanese to build a foundation to begin with?
I am currently available to work full time on Cardano and can add or change documentation as needed.

@abailly
Copy link
Contributor

abailly commented Apr 24, 2022

@btbf Thank you so much for your contribution, that's a great idea! I wish we find the time with @KtorZ to provide a French version :)

@ch1bo
Copy link
Member

ch1bo commented Jul 5, 2022

@btbf in case you missed it, we have a translatable documentation / user manual / website now and are happy to accept any translation contributions :)

@ch1bo ch1bo closed this as completed Jul 5, 2022
@btbf
Copy link
Contributor Author

btbf commented Jul 6, 2022

@ch1bo
I Just cloned git to my server and the translation environment is ready.
I would be delighted to help you with the project :)

@Agustinblockchain
Copy link
Contributor

Hello, I am translating into Spanish. With the help of @abailly who answered some questions. In case anyone else is planning to contribute to the Spanish translation you can contact me.

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

No branches or pull requests

5 participants