[RFC PATCH] doc: translation disclaimer

Federico Vaga
2019-03-05T22:06:39Z

This is only an example to propose a structure for translation's
disclaimers. The actual text needs some thoughs.

Signed-off-by: Federico Vaga <federico.vaga@vaga.pv.it>
---
Documentation/translations/index.rst | 18 ++++++++++++++++++
.../translations/it_IT/disclaimer-ita.rst | 13 +++----------
Documentation/translations/it_IT/index.rst | 6 ++++++
3 files changed, 27 insertions(+), 10 deletions(-)

diff --git a/Documentation/translations/index.rst b/Documentation/translations/index.rst
index 7f77c52d33aa..b46c8ce98d6e 100644
--- a/Documentation/translations/index.rst
+++ b/Documentation/translations/index.rst
@@ -4,6 +4,24 @@
Translations
============

+.. _translations_disclaimer:
+
+Disclaimer
+----------
+Write some text in English here to explain that:
+
+- its purpose is to ease reading and understanding in other languages
+- this is not a fork
+- the only official documentation is :ref:`linux_doc`
+- there are not guarantee about translations being in line with the
+ main documentation
+- translation's maintainer can help people who can't write in English
+- only comments and patches about translations are accepted, any other
+ discussion about Documentation does not belong here
+
+Translations
+------------
+
.. toctree::
:maxdepth: 1

diff --git a/Documentation/translations/it_IT/disclaimer-ita.rst b/Documentation/translations/it_IT/disclaimer-ita.rst
index d68e52de6a5d..aacc1a0346db 100644
--- a/Documentation/translations/it_IT/disclaimer-ita.rst
+++ b/Documentation/translations/it_IT/disclaimer-ita.rst
@@ -1,13 +1,6 @@
:orphan:

-.. note::
- This document is maintained by Federico Vaga <federico.vaga@vaga.pv.it>.
- If you find any difference between this document and the original file or a
- problem with the translation, please contact the maintainer of this file.
- Following people helped to translate or review:
- Alessia Mantegazza <amantegazza@vaga.pv.it>
-
.. warning::
- The purpose of this file is to be easier to read and understand for Italian
- speakers and is not intended as a fork. So, if you have any comments or
- updates for this file please try to update the original English file first.
+ Short (to not pollute the document) text in Italian to explain that for any
+ doubt about the documentation content people should refer to the English
+ documentation. Read the :ref:`it_disclaimer`.
diff --git a/Documentation/translations/it_IT/index.rst b/Documentation/translations/it_IT/index.rst
index ea9b2916b3e4..4b0b3da97c73 100644
--- a/Documentation/translations/it_IT/index.rst
+++ b/Documentation/translations/it_IT/index.rst
@@ -4,6 +4,12 @@
Traduzione italiana
===================

+.. _it_disclaimer:
+
+Disclaimer
+==========
+The following text should be the translation of :ref:`translations_disclaimer`
+
L'obiettivo di questa traduzione è di rendere più facile la lettura e
la comprensione per chi preferisce leggere in lingua italiana.
Tenete presente che la documentazione di riferimento rimane comunque
--
2.20.1