github.com/loggregator/cli@v6.33.1-0.20180224010324-82334f081791+incompatible/cf/i18n/README-i18n.md (about)

     1  # CLI i18n Support
     2  
     3  The CLI currently supports a variety of languages. These translations can be accessed by setting either LC_ALL or LANG in your environment, or by setting your locale within the cli via `cf config --locale your_LOCALE # (e.g. fr_FR)`.
     4  
     5  Translations only affect messages generated by the CLI. Responses from server side components (Cloud Controller, etc.) will be internationalized separately and are likely to be English.
     6  
     7  If you are interested in submitting translations for a currently unsupported language/locale, please communicate with us via the  [cf-dev](https://lists.cloudfoundry.org/archives/list/cf-dev@lists.cloudfoundry.org/) mailing list.
     8  
     9  ## How can you contribute?
    10  
    11  If you see typos, errors in grammar, ambiguous strings or English after setting your locale, please find the appropriate entry in the corresponding `i18n/resources/<language>_<locale>.all.json` file and submit a [pull request](https://help.github.com/articles/creating-a-pull-request/) with the fix(es). It is much better to submit small pull requests as you complete translations, rather than submitting a large one. This makes it much easier to rapidly merge your changes in. You can also report translations needing fixes as an issue in Github.
    12  
    13  Pull requests should only contain changes to "translation" values; the "id" value should not change as it is the key which is used to find the translations, and will always be English. For example:
    14  
    15  Given a missing translation for "Create an org":
    16  ```
    17  [
    18    {
    19      "id":"Create an org",
    20      "translation":""
    21    },
    22    ...
    23  ]
    24  ```
    25  
    26  Adding the translation would look like:
    27  ```
    28  [
    29    {
    30      "id":"Create an org",
    31      "translation":"Créez un org"
    32    },
    33    ...
    34  ]
    35  ```
    36  
    37  Finally, it is also important not to translate the argument names in templated strings. Templated strings are the ones which contain arguments, e.g., `{{.Name}}` or `{{.Username}}` and so on. The arguments can move to a different location on the translated string, however, the arguments cannot change, should not be translated, and should not be removed or new ones added. So for instance, the following string is translated in French as follows:
    38  
    39  ```
    40  [
    41    ...,
    42    {
    43      "id": "Creating quota {{.QuotaName}} as {{.Username}}...",
    44      "translation": "Créez quota {{.QuotaName}} étant {{.Username}}..."
    45    },
    46    ...
    47  ]
    48  ```