Skip to content

Commit

Permalink
Explain why only translated files should be committed
Browse files Browse the repository at this point in the history
  • Loading branch information
jimwins committed Oct 7, 2024
1 parent 8917e61 commit 18c8d2f
Showing 1 changed file with 7 additions and 0 deletions.
7 changes: 7 additions & 0 deletions docs/translating.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,13 @@ You will also have to follow other steps from the [editing manual sources](editi
Translating documentation into other languages might look like a complicated
process, but in fact, it's rather simple.

Because any files that are not yet translated are automatically included
from the English version of the manual when the HTML and other versions
of the translated manual are built, only files that are translated should
be added to the repository for a translation. Untranslated files that
are added to the repository could otherwise become out-of-date and cause
problems with building the translated manual.

Every file in Git has a *commit hash*. It is basically the current version of
the specified file. We use commit hashes to check if a file is synchronized with its
English counterpart: to find out if the translation is up-to-date. That's why every
Expand Down

0 comments on commit 18c8d2f

Please sign in to comment.