Официальный репозиторий проекта RusRails.ru
Проект RusRails является неофициальным переводом официальных руководств по Ruby on Rails
-
Скопировать и установить
$ git clone git://github.com/morsbox/rusrails.git $ cd rusrails $ bundle install
-
Создать конфиг для своих настроек бд (
config/database.yml
) -
Заполнить базу
$ rake static_docs:import
-
Запустить сервер и открыть в браузере
Важно! Все пул-реквесты нужно делать в ту ветку, которая выставлена в данный момент текущей на гитхабе!
- Находите нужный файл в
source
(соответствие url на сайте rusrails и имени файла задается вsource/index.yml
) - В интерфейсе есть кнопка Edit
- Вносите изменение
- Commit Changes
- Я принимаю изменения
- Делаете форк. Инструкция по форкам
- У себя в репозитории правите все ошибки (желательно ошибки для каждого руководства править в отдельных ветках)
- Отправляете пул-реквест
- Я принимаю изменения
Для того, чтобы быстро и полно осуществлять переводы, каждое руководство привязано к определенной ревизии репозитория docrails.
Эта привязка осуществляется в файле https://github.com/morsbox/rusrails/blob/master/source/index.yml. Указывается заголовок на русском, имя файла в репозиториях docrails и rusrails, url на сайте rusrails, ревизия и дата коммита.
Таким образом, алгоритм работы:
- клонируете репозиторий docrails (а лучше сделать форк) Инструкция по форкам
- если уже есть репозиторий, обновляете его до актуального состояния (fetch/merge)
- Делаете форк этого репозитория. Инструкция по форкам
- Открываете issue, где говорите, какое руководство хотите обновить/перевести (чтобы этим руководством пока никто больше не занимался)
- берете дифф по отдельному файлу
git diff fa159d317611d1fe5b48 -- guides/source/getting_started.md >> gettin.diff
. Ревизия - из файлаsource/index.yml
- Смотрите номер последней ревизии по файлу
git log -- guides/source/getting_started.md
, изменяете эти данные вsource/index.yml
- Вносите в нужных местах исправления по диффу
- Отправляете пул-реквест
- Я принимаю изменения
Есть много всяких идей, до которых руки не доходят, например, редизайн, социализация, расширение на другие руководства, связанные с rails, и т.д.
Предлагайте свои идеи, которые в состоянии реализовать.