Skip to content
This repository has been archived by the owner on Jan 4, 2024. It is now read-only.

Documentation translation #1

Open
nlepage opened this issue Oct 4, 2021 · 6 comments
Open

Documentation translation #1

nlepage opened this issue Oct 4, 2021 · 6 comments
Assignees
Labels
documentation Improvements or additions to documentation hacktoberfest Hacktoberfest 2021 contributions welcome help wanted Extra attention is needed

Comments

@nlepage
Copy link
Owner

nlepage commented Oct 4, 2021

We need help translating templural's documentation to different languages.

For now templural's documentation is available/being translated in the following languages:

If you would like to help translating to another language, please follow this steps:

  1. check this issue's responses to see if someone has already come forward for your chosen language
    1.a. if it is the case, contact that person to offer your help
    1.b. if it is not the case, proceed to step 2
  2. respond to this issue to say which language you would like to translate the documentation to
  3. start the translation by creating a new README_xx.md file in the docs directory
  4. as soon as you started the translation, you may open a draft pull relquest to show your work in progress, and link it in this issue by editing your comment
  5. any further discussion regarding the translation should take place in the pull request

Here are some guidelines for a new translation:

  • use the main README as a reference
  • try to find examples that are relevant to the language, translating examples found in the main README might not be the best choice
  • bring extra attention to the i18n section, its content might need some adaptation to be relevant in the language
  • add a link the new translation in the other README files
  • adding a test file in the test directory is a good way to validate your examples (ask for help if you need any on this point)
  • if you think the language you are translating needs some default locales options (see i18n section about category priority, order and fallback), please open separate pull request
  • ask for help if you need any
  • credit yourself (and whoever helped you) in the "Authors & Contributors" section of the translated README
@nlepage nlepage added hacktoberfest Hacktoberfest 2021 contributions welcome documentation Improvements or additions to documentation help wanted Extra attention is needed labels Oct 4, 2021
@SvA1
Copy link
Contributor

SvA1 commented Oct 5, 2021

Hi, I could help with translating the documentation into German & Russian, could you assign this issue to me?

@nlepage
Copy link
Owner Author

nlepage commented Oct 5, 2021

Hi @SvA1
You're now assigned to the issue.
Do you need help to start the translation ?
I tried to give all the necessary information in my first comment: #1 (comment)
You can also refer to the contributing guide for information on how to contribute.
Tell me if you have any questions 🙂

@Mayie
Copy link
Contributor

Mayie commented Oct 14, 2021

Hey, I can help translate the documentation in spanish.

@bantya
Copy link

bantya commented Oct 27, 2021

Hey @nlepage, I can help translate the documentation in Hindi and Marathi (Indian) languages.

@nlepage
Copy link
Owner Author

nlepage commented Oct 27, 2021

Hey @nlepage, I can help translate the documentation in Hindi and Marathi (Indian) languages.

Hi @bantya, okay, let me know if you need any help, I tried to put as much information as possible in my first comment: #1 (comment).

@nlepage nlepage assigned bantya and unassigned SvA1 Oct 27, 2021
@bantya
Copy link

bantya commented Oct 27, 2021

Thank you @nlepage.
I'll push the new locales ASAP.

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
documentation Improvements or additions to documentation hacktoberfest Hacktoberfest 2021 contributions welcome help wanted Extra attention is needed
Projects
None yet
Development

No branches or pull requests

4 participants