Find a Doc - Localization
Find a Doc is a free online resource aimed at helping connect the foreign community in Japan with health services in their native language.
Translations are initially created by machine in a special file format, and then edited by volunteers to be published on the site.
How to Contribute
If you speak a foreign language and can help translate files, Go to
If are a developer trying to add internationalization (i18n) keys, Go to
Translator Guide
The easiest and fastest way to contribute is through Git. Simply clone this repo and open a PR to merge your changes.
If you're new to Git, here are some easy steps you can take to get started:
Beginner Git
-
Go into the locales folder and click on the language file you wish to contribute to. It will take you to a screen that will show you its content. (Note if you are creating a new language file, copy from
en.jsonand please name the new file using the two-letter language codes defined here)
-
Click the
editbutton so you can directly edit the translation through your browser. Use theen.jsonfile and the website as the reference content.
Make sure to only edit the part inside of the quotation marks of your selected language.
You might notice the files are in a special format so the computer can read it. This format is called JSON (JavaScript Object Notation) and contains a key on the left side, and a value on the right side. Notice that the key names are in English, and sometimes the letters are squished together like this noSpacesHere. Please only edit the values, not the keys. Note the example below has a key of "vaccine" and a value translated into Japanese.
{
"key": "value",
"vaccine": "ワクチン"
}
If this is confusing or you get stuck, we are here to help. See contact information below
-
Select the
Create a new branch for this commit and start a pull requestoption at the bottom of the page. Then click thePropose changesbutton.
-
Optional - Add any comments you want to make on the pull request screen.
-
Click the
Create pull requestbutton.
Thank you! Your changes will be reviewed!
If you have any trouble with this document, please file an issue or reach out to @stonecoldkilzer on Twitter
Developer Guide
- Fork & clone this repo to your computer
- Edit the
locales/en.jsonto contain the new keys. - If you know another language, feel free to add the same key and translation to the appropriate locale file. Omit if you don't know it; we use English as the fallback language so nothing will break.
- Make a pull request in this repo and wait for it to be merged to
main - Make your change in the parent repository with the new i18n keys and submit your PR
🎉
3 Sep 27, 2022
8.8k Jan 08, 2023
1 Apr 20, 2022
29 Dec 20, 2022
1 Nov 17, 2021
2.4k Dec 31, 2022
8 May 07, 2022
3.4k Jan 08, 2023
48 Dec 21, 2022
2 Oct 12, 2021
0 Apr 29, 2022
3 Nov 21, 2022
1 Jan 30, 2022
4 Aug 13, 2021
146 Dec 18, 2022
3.1k Dec 29, 2022
56 Jan 22, 2022
5 Nov 06, 2021
111 Dec 19, 2022
45 Jan 05, 2023