Localizing the configuration reference

The configuration reference is generated automatically from the source code.

English descriptions of configuration options are taken directly from sources, for other languages we use a simple key-value translation system. Each object and each property has a unique key, which is a combination of the object path and the property name (add ?dev=1 to the URL to see the keys). To change the translated text, locate strings.ini in a _doc subdirectory of the corresponding module. For example, to change this key

gws.plugin.auth_method.basic.Config.realm

you need to edit this file:

gbd-websuite/app/gws/plugin/auth_method/_doc/strings.ini

In practice, it's often easier to find the key using global search in the project directory.

Once the text is changed, you need to rebuild the docs with make.sh doc. Doc development server will regenerate the docs automatically when you save the file.