This is an automated email from the ASF dual-hosted git repository.
dblevins pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/tomee.git
The following commit(s) were added to refs/heads/master by this push:
new bf3eb20 TOMEE-2475 Added feeback for translation best practices.
new 6e3f81f Merge pull request #417 from cesarhernandezgt/TOMEE-2475
bf3eb20 is described below
commit bf3eb20f2c7a25d549f40e96a9baea1a9f0c104d
Author: CesarHernandezGt <[email protected]>
AuthorDate: Mon Feb 25 20:50:47 2019 -0600
TOMEE-2475 Added feeback for translation best practices.
---
examples/README.adoc | 10 ++++++++++
1 file changed, 10 insertions(+)
diff --git a/examples/README.adoc b/examples/README.adoc
index 1da85a5..58eab2c 100644
--- a/examples/README.adoc
+++ b/examples/README.adoc
@@ -40,4 +40,14 @@ Check
https://github.com/apache/tomee/tree/master/examples/access-timeout for an
That's it!, TomEE website generator will pickup the language and update the
examples index automatically without any further configuration.
+=== Translation best practices
+- The preferred format for the README files is Asciidoc(.adoc), if you found
a file originally written in Markdown (.md) please proceed with the translation
in Asciidoc. Keep in mind that apart from changing the file extension,
Asciidoc has it's own syntax. You can check for instance this
link:https://asciidoctor.org/docs/asciidoc-vs-markdown/[comparison matrix]
between both formats.
+- IF you use some translation software, make sure to review the code and
narrative from the original example.
+- If the example README file contains inner links for website navigation, it's
recommended to also deploy the website locally to double check navigation. You
will need to checkout https://github.com/apache/tomee-site-generator and follow
it's README file to deploy locally your changes.
+- At the beginning of each .adoc file is used for configuration purposes, the
properties should remain in English and it's advised to translate only the
values of `index-group` and `title`. Check the following example for an
translation into Spanis :
+
+ index-group=Testing Techniques
+ type=page
+ status=published
+ title=Descriptores alternos
