[Bug][Documentation] Translation: "main" is not default, but "release/ulmo.1"

Site Operators
5

To clarify the different ways to use ATLAS_REVISON:

  • release/ulmo.1
    • This is the default for someone running ulmo.1 in Tutor
    • It comes from {{ OPENEDX_COMMON_VERSION }}
    • It is frozen in time (a git tag as opposed to a git branch on the openedx-translations repo)
      • This is done to enable reproducible builds.
  • release/ulmo
    • This is a git branch on the openedx-translations repo
    • It will pull the latest translations for the source strings that exist in the ulmo named release.
  • main
    • This is also a git branch on the openedx-translations repo
    • This will pull the latest translations for the source strings that exist in the main/master branches of the repos to be included in the next named Open edX release

While it is quite likely that pulling from main will work for ulmo, it is also possible for strings that exist in ulmo to get removed in main, leading to gaps.

I recommend setting ATLAS_REVISION to release/ulmo instead.

Docs that could be updated:

The openedx-translations README still mentions the branch naming format we used before teak (open-release/<release-name>.master).

The Tutor documentation for “Getting and customizing Translations” could probably benefit from mentioning setting release/<release-name> (as opposed to release/<release-name>.x) as the recommended way to pull updated translations for any given named release.