Skip to content
Last updated
Danger

Training exercise.

Experience review

It took a while, but at the end we think we know how to translate our project (and we already see some limitations).

What made you smile?

  • Fast deployment - once change was made, it was on prod/preview within minute.

What did you find confusing?

  • Initially we setup only 1 language in redocly.yaml and were confused, why we don't see language picker. After adding another one (english) picker was visible.
  • We missed some error/warning that some pages are not translated
  • We've used single word for label translation key (inside translations.yaml file). Apparently it wasn't working, we've had to change home to theme.navbar.home for example.
  • We didn't see a way how to translate only part of open api definition. We've had to copy & paste whole OAD file and translate it inside. It's inconvenient - any change to OAD will now require updating multiple places.
  • We couldn't translate products section. No way to define translation label:
  products:
    Museum API:
      name: Museum API
      folder: Museum API
    PetStore API:
      name: PetStore API
      folder: PetStore API
    Train-travel API:
      name: Train-travel API
      folder: Train-travel API
    Kitchen API:
      name: Kitchen API
      folder: Kitchen API
  • We wanted to translate some built-in components like Try It button or feedback widget. But we didn't find guideline in documentation. There is section https://beta-docs.redocly.com/author/how-to/config-i18n#change-labels-in-default-language, but there is no list of available keys that we can translate.
  • We've added svg file and it was working fine on wysiwyg, but when deploy to preview we didnt' see it.