Translating
How the English and Amharic versions relate, how to add a translation, and how to find what is missing.
Each page can exist in English and Amharic. English is the source; a page with no Amharic version still works.
What the reader sees#
- The language switch at the top right changes the page's language and keeps the reader on the same page.
- The address carries the language:
/docs/en/...and/docs/am/.... - A visitor who opens
/docsis sent to Amharic if their browser prefers it, otherwise to English. - If a page has no Amharic text, the Amharic site shows the English text with a notice saying it has not been translated yet. The sidebar and section index mark such pages EN.
- Titles and summaries fall back to English separately, so a translated title over an untranslated body is fine.
- The site's own words (search box, buttons, "On this page") are translated for both languages.
Adding a translation#
- Find the English file, for example
documentation/en/20-getting-started/10-install-with-docker.md. - Create the file with the same path under
am/:documentation/am/20-getting-started/10-install-with-docker.md. - Translate
titleandsummaryin the front matter. Keepsequence,publishedand the file name. - Translate the text. Then update the module, or use Documentation → Sync from Files.
Do the same for the section: _section.md with a translated title and summary.
Important
Keep these exactly as in English: code in code blocks, commands, file names, model and field names in code font, URLs, and the doc: link targets. Translate the visible text of a link, never its address.
What to translate and what not to#
| Translate | Keep in English |
|---|---|
| Headings, paragraphs, list items, table text | Command lines and code |
| Button and menu names when you also show the English in brackets | Technical names: social.media.post, X-Api-Key |
| Callout titles | The callout marker itself: [!NOTE] |
Front matter title and summary | Front matter keys and sequence |
The interface is in English, so when you mention a button, show the label people will actually see, for example: Submit for Approval.
Finding what is missing#
In Documentation → Pages, use the Missing Amharic filter. The list also has a Translated column.
Editing translations in Odoo#
Open a page and use the አማርኛ (Amharic) tab, which has its own title, summary and text. It is the same page, so it shares the address and the section.
Review by a fluent reader#
Warning
Machine-assisted or first-draft translations must be reviewed by a fluent Amharic reader before you rely on them, especially for steps that change data, such as the backup and restore instructions.
A third language#
The site is built for two languages. Adding another means new fields on the page and section models, new folders under documentation/, and an entry in the site's language list. Ask a developer.