| Учасники: 1471 |
| Мова: Російська |
| Категорії групи:
|
| Додаткова інформація про групу » |
Шаг номер нольПоскольку вопрос этот возникает часто, и ответ на него - самый что ни на есть "консервированный" - список шагов которые следует предпринять для комфортабельного доступа к документации:
1) Каждый ruby gem поставляется с документацией в комплекте - это как документация по отдельным методам и классам, так и общие файлы типа README, TUTORIAL и так далее. При установке каждого gem'a эта документация превращается в HTML и складируется на вашей машине. Восемь из десяти гемов которые вы ставите имеют подробнейшую, или как минимум достаточную для полноценной работы документацию (если только структура гема не превращает это в ночной кошмар - например когда библиотеку надо писать на C++)
2) Чтобы читать документацию по всем установленным gems (да да, без всякого интернета!), следует запустить gem server - это простейший веб-сервер на базе webrick, который выводит страницу со всеми установленными gems и позволяет прочитать документацию каждого из них. И для каждой версии каждого из них, и найти веб-страницу каждой версии каждого из них.
3) Как запустить gem server на unix-системе? после установки rubygems просто запустить gem_server и зайти браузером на http://localhost:8808 А лучше поместить эту ссылку прямо на самый главный и большой тулбар своего самого главного браузера и лезть туда при первой же возможности.
4) Как всегда держать gem server запущенным? установить скрипт его запуска автоматом при старте системы. * Для linux: скрипт для init.d взять здесь - код там на ангглийском, бояться нечего. * MacOS X - скачайте и установите Startup Item для запуска гем-сервера. Cделайте папку /Library/StartupItems (если ее еще нет) и положите распакованный архив туда. * Winblows - здесь
Тот кто не прошерстил документацию в своем gem_server и все равно спросил в группе про очередную документированную опцию validates_presence_of будет нелюбим.
Следует ли обьяснять, что невозможность чтения англоязычной документации - исключительно вина (именно не проблема а вина) самого читателя? Следующие шаги:Если вам хочется иметь доки по rails прямо в папке проекта - rake doc:rails и заглянуть в doc/api. Особенно актуально для edge rails.
http://www.prototypejs.org/api - все что касается Scriptaculous и Prototype.js http://www.noobkit.com/rails - полезная подборка документации (не только по Rails) http://caboo.se/doc.html - документация по Edge Rails http://www.quarkruby.com/2007/9/20/ruby-on-rails-security-guide
После того, как вся вышеупомянутая документация выкурена до фильтра, следует задавать вопрос (и ответить на него будет гораздо проще). Тот, кто вышеупомянутым конвенциям последовал, будет любим.
|
| ||||||||||||||||||||||||||||