Coder Social home page Coder Social logo

Официальный репозиторий проекта RusRails.ru

Проект RusRails является неофициальным переводом официальных руководств по Ruby on Rails

Установка и запуск

  • Скопировать и установить

    $ git clone git://github.com/rusrails/rusrails.git
    $ cd rusrails
    $ bundle install
    
  • Создать конфиг для своих настроек бд (config/database.yml)

  • Создать базу данных и загрузить схему базы данных

     rails db:setup
    
  • Заполнить базу

    $ rails static_docs:import
    
  • Запустить сервер и открыть в браузере

Пул-реквесты

Все пул-реквесты нужно делать в ту ветку, которая выставлена в данный момент текущей на гитхабе!

Нашли ошибку?

  • Находите нужный файл в source (соответствие url на сайте rusrails и имени файла задается в source/index.yml)
  • В интерфейсе есть кнопка Edit
  • Вносите изменение
  • Commit / Push

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

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

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

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

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

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

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

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

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

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

HTML версия развертывается на Github Pages.

Предполагается, что клон репозитория rusrails/rusrails.github.io находится в той же директории, что и клон rusrails/rusrails.

Тогда rails deploy:start сгенерирует свежую версию и отправит на Гитхаб.

rusrails's Projects

api icon api

Merged API docs for Ruby && Rails

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.