Оригинал англоязычной документации находится по адресу https://github.com/laravel/docs.
Перевод документации на русский находится на гитхабе по адресу https://github.com/laravelsu/docs . Апдейт перевода осуществляется пулл-реквестами в этот репозиторий.
Редактирование репозитория с переводом может происходить в двух вариантах - внесение незначительных изменений и обновление перевода файла до актуального.
Внесение мелких изменений
Если вы заметили опечатку, некрасивый перевод, неподходящее употребление термина - не нужно уметь пользоваться git, вы можете просто отредактировать файл прямо на гитхабе, для этого:
- Найдите файл, который требует корректировки.
- Нажмите на иконку карандаша в правом верхнем углу блока файла, чтобы начать редактирование.
- Внесите нужные изменения и предложите Pull Request с вашими правками, следуя инструкциям GitHub.
Если же вы заметили, что в русской документации отсутствует фича, которая есть в англоязычной документации, вам нужно использовать другой вариант работы.
Обновление перевода до актуального
Формат файла перевода
Файлы русскоязычной документации имеют определенный формат. В начале каждого файла должна быть конструкция следующего вида:
---
git: c896b9b09d1cd96e5c93afcc967ed7b636250074
---
где c896b9b09d1cd96e5c93afcc967ed7b636250074 - полный номер коммита в англоязычной
документации, последнего актуального на момент редактирования для данного файла. Это нужно для
того, чтобы понимать, что именно переведено, а что еще нет - чтобы следующий переводчик не
просматривал глазами весь файл в поисках изменений, а просто внес то, что ему покажет git
diff
Итак, последовательность действий при переводе документации следующая.
- Перейдите на страницу Статус перевода.
- Выберите файл, который нуждается в переводе. Справа от названия файла находится надпись отображающая, на сколько коммитов файл отстаёт, кликните на неё. В открывшемся окне отображаются различия между коммитом до которого обновлена русскоязычная документация и последним коммитом в англоязычной документации.
- В этом окне найдите файл, который вы решили обновить. Справа будет старая версия файл, а слева - новая, цветом отмечены расхождения.
- Внесите необходимые изменения в файл перевода. Изменения нужно внести все ,чтобы переведенный файл полностью соответствовал оригинальному. Нельзя останавливаться на середине и пушить изменения - следующий человек может подумать, что файл уже переведён полностью.
- Обязательно измените в начале переводимого файла полный номер коммита. Этот номер можно взять на той же странице статуса перевода в строке "Последний коммит".
- Закоммитьте изменения и пошлите пулл-реквест из гитхаба. Старайтесь делать изменение только одного файла во время одного коммита.
Убедитесь, что делаете пулл-реквест в ветку с нужной версией.
