documentation/content/applications/websites/website/publish/translate.rst
Antoine Vandevenne (anv) 6f125de01b [MOV] content/*: move resource files into their related page's directory
Since odoo/documentation#903, the guideline for the location of new
resource (images, downloadable files, RST includes...) files is to place
those inside the directory of the RST page that references them.

For example, if `doc1.rst` has a reference to `image.png` and to
`download.zip`, the file structure should look like this:

├── parent_doc/
│     └── doc1/
│     │     └── image.png
│     │     └── download.zip
│     └── doc1.rst
│     └── doc2.rst
├── parent_doc.rst

Before this commit, most of the resource files were still located inside
'media' directories holding all the resource files referenced by RST
pages located at the same level as these directories. In the example
above, a single 'media' directory would hold all the resource files
referenced by both `doc1.rst` and `doc2.rst`. Doing so prevented us from
figuring out easily which resource file was referenced by which RST page
and, thus, lead to unused resource files piling up in the repository. It
also made it more complicated to define codeowners regex rules because a
team could not simply be assigned to `/some_page.*` but needed to be
assigned to both `/some_page\.rst` and to the location of 'media'.

In order to help new content writers figure out the guideline when
taking examples from other RST pages, this commit retroactively applies
the guideline to existing resource files and 'media' directories. The
left-over resource files that are not referenced by any RST page are
removed.

task-2497965

closes odoo/documentation#2006

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-05-19 11:33:49 +02:00

71 lines
2.5 KiB
ReStructuredText

===============================
How to translate my website
===============================
Overview
========
In addition to creating great modern websites, Odoo gives you the
possibility to translate it in different languages.
Process
=======
Once your website is created, you have the opportunity to translate it
in as many different languages as you want.
There are two ways to translate your website, you can do it manually or
automatically with the Gengo App. If you want to do it automatically, go
to the **App** module and Install **Automated translations through Gengo
Api** and **Website Gengo Translator**. If you want to do it manually,
don't install anything, and follow the next step.
.. warning::
Gengo won't work on Odoo Online and not by default on Odoo.sh. The required
Python library `gengo` isn't installed on those platforms. It can be used
either on-premise or by adding `gengo` to `requirements.txt` in your
Odoo.sh git project.
Now go to your website. On the bottom right corner of the page, click on
**Add a language**.
.. image:: translate/translate_website01.png
:align: center
Choose the language in which you want to translate your website and then
click on **Load.**
.. image:: translate/translate_website02.png
:align: center
You will see that Now, next to English there is also French, which means
that the page for the translation has been created. You can also see
that some of the text has been translated automatically.
.. image:: translate/translate_website03.png
:align: center
To translate the content of the website, click on **Translate** (here
**Traduire** since we want to translate the website in French).
There, if you have installed the Gengo Translator, You will see that
next to the **Translate** button you also have a button **Translate
automatically**. Once you click on that button, you will be asked some
information on your account. If you don't have an account yet, follow
`this link <https://gengo.com/auth/form/login/>`_
in order to create one. You need to ask for a public key and a private
key.
The content you wish to translate will then be translated automatically.
.. image:: translate/translate_website04.png
:align: center
Now you can see that most of the content is highlighted in yellow or
in green. The yellow represents the content that you have to translate by
yourself. The green represents the content that has already been translated
automatically.
.. image:: translate/translate_website05.png
:align: center