This is an automated email from the ASF dual-hosted git repository.
radcortez pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/tomee.git
commit 5a175b73f77a315c0aa5ff8f85637dc6813646a8
Author: CesarHernandezGt <cfhernan...@gmail.com>
AuthorDate: Fri Jan 18 10:44:51 2019 -0600
added instruction to translate examples
---
examples/README.adoc | 16 ++++++++++++++++
1 file changed, 16 insertions(+)
diff --git a/examples/README.adoc b/examples/README.adoc
index 62b0ee7..f3d6338 100644
--- a/examples/README.adoc
+++ b/examples/README.adoc
@@ -19,3 +19,19 @@ making the required dependencies clear.
* Document the bahaviour of each method with javadoc.
* Include a README file explining the purpose and what's doing on.
* Make sure you add the new project to the parent project _pom.xml_ modules
section.
+
+== Translation
+
+If you want to translate an existing example into another language you just
need to:
+
+1. Find two letter code for the language you want to translate to:
https://www.loc.gov/standards/iso639-2/php/code_list.php
+
+2. Create the translated version of the readme file with the suffix:
+
+ README_<TwoDigitLanguageCode>.adoc
+
+Check https://github.com/apache/tomee/tree/master/examples/access-timeout for
an example on how the translation into Spanish looks like.
+
+That's it!, Tomitribe website generator will pickup the language and update
the examples index automatically without any further configuration.
+
+
