Permalink
Switch branches/tags
Find file Copy path
Fetching contributors…
Cannot retrieve contributors at this time
84 lines (59 sloc) 4.24 KB

Gitter Официальный репозиторий проекта 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 / Push

Нашли много ошибок?

  • Делаете форк. Инструкция по форкам
  • У себя в репозитории правите ошибки (желательно для каждого руководства править ошибки в отдельных ветках)
  • Отправляете пул-реквест

Хотите помочь с переводами?

Для удобного перевода, каждое руководство привязано к определенной ревизии rails/rails, в файле source/index.yml. Таким образом, указывается заголовок на русском, url, имя файла, ревизия и дата коммита.

Алгоритм работы:

  • Делаете форк. Инструкция по форкам
  • Выбираете руководство (степень актуальности всех руководств можно оценить с помощью rake docrails:status)
  • Открываете issue в rusrails, с пометкой о руководстве которое хотите обновить/перевести (чтобы этим руководством никто параллельно не занимался)
  • Смотрите, что изменилось - rake 'docrails:diff[file_name]' > diff.diff - в файле diff.diff
  • В том же файле смотрите информацию по последней ревизии и ее дате, изменяете эти данные в source/index.yml
  • Вносите в нужных местах исправления по диффу
  • Отправляете пул-реквест

Хотите помочь с развитием сайта?

Есть много всяких идей, до которых руки не доходят, например, правки дизайна, социализация, расширение на другие руководства, связанные с Rails, версии в PDF/kindle и т.д.

Предлагайте свои идеи, которые в состоянии реализовать. @RusRails

Развертывание

# first, create admin user (follow deploy.rb instructions)
ssh-add
bundle exec cap deploy:install
bundle exec cap deploy:setup
bundle exec cap deploy:cold static_docs:import

After that, to release bundle exec cap deploy static_docs:import