repo: gemini-site
action: commit
revision: 
path_from: 
revision_from: 20b559543a9e299c3b2b4ebeb516a77dfef82375:
path_to: 
revision_to: 

commit 20b559543a9e299c3b2b4ebeb516a77dfef82375
Author: Solderpunk 
Date:   Sun Feb 21 19:33:37 2021 +0100

    Small updates to translation instructions in FAQ.

diff --git a/docs/faq.gmi b/docs/faq.gmi

--- a/docs/faq.gmi
+++ b/docs/faq.gmi
@@ -300,12 +300,14 @@ to create a set of patch files, which you can manually attach to an email using

 Thank you!  Volunteering to translate documentation is a wonderful way to help the project.

-To do so, first clone the git repository as described in question 4.3 above.  Change into the `doc` directory of the repository, and create a new subdirectory with your language's two letter ISO 639-1 code, e.g. Finnish translations should live in `doc/fi/`, Japanese translations in `doc/jp/`, etc.  You can find a complete list of codes at Wikipedia:
+To do so, first clone the git repository as described in question 4.3 above.  Change into the `doc` directory of the repository, and create a new subdirectory with your language's two letter ISO 639-1 code, e.g. Finnish translations should live in `doc/fi/`, Japanese translations in `doc/jp/`, etc.  You can find a complete list of codes at Wikipedia, linked below.  If you are translating into a region-specific variant of a language, you can use RFC4646-style codes instead, e.g. pt-PT or pt-BR for the Portuguese as spoken in Portugal or Brazil, respectively.

 => https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes	List of language codes at Wikipedia

 For each English file which lives in `doc` which you want to translate, create a corresponding file in your language's subdirectory.  It's okay to change the file name as part of the translation, e.g. the German translation of `doc/specification.gmi` might be called `doc/spezifikation.gmi`.  You can translate as many or as few of the files in `doc` as you have time and energy for.  Don't be shy about submitting partial translations!  Once somebody else who speaks your language sees your effort, they might provide some or all of the remaining work.  Having some content translated is better than none.

-Once you're done, copy across the `doc/index.gmi` file and modify it to match your translated filenames and document titles, and remove links for any of the original documents which you haven't translated.
+Once you're done, copy across the `doc/index.gmi` file and modify it to match your translated filenames and document titles, and remove links for any of the original documents which you haven't translated yet.
+
+Finally, update `doc/translations.gmi` to include a link to your new subdirectory.

 Commit your translations to the repository and send Solderpunk the patch as described in question 4.2 above.

-----END OF PAGE-----