Skip to content

README.md

Latest commit

 

History

History
46 lines (26 loc) · 1.78 KB

README.md

File metadata and controls

46 lines (26 loc) · 1.78 KB

EMQX Config Documentation and Dashboard Internationalization

This repository contains multi-language translations for EMQX document generation and EMQX Dashboard.

How the files are used

  • During EMQX build, it downloads the desc.zh.hocon file to dump zh flafor schema doc (which is then used to generate markdown docs). EMQX does NOT download desc.en.hocon because en being the source of truth always resides in upstream repository.

  • EMQX dashboard current builds their own dictionary, but will consider taking this repo as the source of truth in the future.

Why named hocon while they are JSON

!!! DO NOT ATTEMPT to change naming convention of the files for below reasons:

  1. HOCON is a super-set of JSON, so JSON IS technically also HOCON.
  2. The en flavor files in upstream (emqx project) are HOCON format, and even after they are merged, it's just one HOCON file concatenated.
  3. The file suffix .hocon is used by emqx when it tries to build the dictionary cache.

Branches

  • main: EMQX before 5.3.2 downaloads from this branch
  • v53: EMQX since 5.3.2 (before 5.4) downloads from this branch

Workflow

Sync English descriptions

The primary language is English, which originates from emqx.git. Translations are stored in this repository.

To make changes, follow these steps:

  • Update English descriptions in the upstream repository.

  • Periodically sync the updated English description file to this repository.

    • In emqx proejct, build the file with make.

    • Copy the dumped file _build/docgen/desc.en.hocon to this repo.

    • Send a pull request for review.

Translate descriptions

Follow the steps in tr/README.md.