Skip to content

Commit c984848

Browse files
committed
Update documentation page (ru)
1 parent aad9434 commit c984848

File tree

1 file changed

+183
-120
lines changed

1 file changed

+183
-120
lines changed

ru/documentation/index.md

Lines changed: 183 additions & 120 deletions
Original file line numberDiff line numberDiff line change
@@ -4,166 +4,229 @@ title: "Документация"
44
lang: ru
55
---
66

7-
Здесь вы найдете отсылки к руководствам, урокам и ссылкам, которые могут
8-
быть полезны, если вы почувствуете, что хотите программировать на Ruby.
7+
Руководства, учебные материалы и справочные ресурсы, которые помогут вам узнать больше о Ruby
98
{: .summary}
109

1110
### Установка Ruby
1211

13-
Если вы хотите попробовать Ruby не только в браузере (смотрите ссылки ниже),
14-
но и локально – вам нужно установить Ruby на ваш компьютер.
15-
Вы можете проверить, установлен ли Ruby на ваш компьютер, набрав в терминале
12+
Хотя вы можете легко [попробовать Ruby прямо в браузере][1], также можно прочитать
13+
[руководство по установке](installation/), чтобы узнать, как установить Ruby на свою систему.
1614

17-
{% highlight sh %}
18-
ruby -v
19-
{% endhighlight %}
15+
### Официальная документация Ruby
2016

21-
Это должно вывести некоторую информацию об установленной версии Ruby.
22-
Если нет, смотрите страницу [установки](installation/) с различными
23-
способами получить Ruby.
17+
[docs.ruby-lang.org/en][docs-rlo]: Список документации для всех версий Ruby, выпущенных после 2.1.
18+
19+
[docs.ruby-lang.org/en/3.4][docs-rlo-3.4]: Документация для Ruby 3.4.
20+
21+
[docs.ruby-lang.org/en/master][docs-rlo-master]: Документация для основной (master) ветки Ruby.
22+
23+
[Руководство по C-расширениям][docs-rlo-extension]: Подробное руководство по созданию C-расширений для Ruby.
2424

2525
### С чего начать
2626

27-
[Try Ruby!][1]
28-
: Интерактивное введение, которое даст вам возможность попробовать Ruby
29-
прямо в вашем браузере. 15-ти минутная вводная часть нацелена на
30-
начинающих, кто хочет почувствовать возможности языка.
27+
[Попробуйте Ruby][1]
28+
: Вы можете протестировать Ruby прямо в своём браузере.
3129

32-
[Ruby Koans][2]
33-
: Данный ресурс поведет вас по пути просвещения к знаниям о Ruby. Цель
34-
ресурса – изучить язык Ruby, его синтаксис, структуру и несколько
35-
стандартных функций и библиотек. Так же он обучит вас культуре.
30+
[Learn to Program][8]
31+
: Замечательное небольшое руководство от Chris Pine для новичков в программировании. Если вы не знаете как программировать — начните отсюда.
3632

37-
[Why’s (Poignant) Guide to Ruby][5]
38-
: Необычная, но интересная книга, которая научит вас Ruby посредством
39-
историй, шуток и комиксов. Созданное программистом *why the lucky stiff*,
40-
данное руководство является классикой для изучения Ruby.
33+
[Ruby за двадцать минут][rubyin20]
34+
: Короткое руководство по Ruby, который можно пройти за 20 минут.
4135

42-
[Ruby за двадцать минут](/ru/documentation/quickstart/)
43-
: Неплохое введение, покрывающее основы Ruby. Прохождение его от начала
44-
до конца не должно занять у вас более двадцати минут.
36+
[The Odin Project][odin]
37+
: Open source курс по full-stack веб-разработке.
4538

46-
[В Ruby из других языков](/ru/documentation/ruby-from-other-languages/)
47-
: Пришли в мир Ruby из другого языка? Будь это C, C++, Java, Perl, PHP
48-
или Python – этот раздел вам поможет!
39+
[Exercism][exercism]
40+
: 120 упражнений с автоматической проверкой и персональным наставником.
4941

50-
[Ruby Essentials][7]
51-
: Бесплатная онлайн-книга, предоставляющая краткое и легкое руководство
52-
для изучения Ruby.
42+
[Codecademy][codecademy]
43+
: Онлайн-платформа для изучения программирования с различными курсами, включая Ruby.
5344

54-
[Learn to Program][8]
55-
: Замечательное маленькое руководство от Chris Pine для новичков в
56-
программировании. Если вы не знаете как программировать - начните
57-
отсюда.
45+
### Руководства и книги
5846

59-
[Learn Ruby the Hard Way][38]
60-
: Отличный набор упражнений с объяснениями, который поможет вам пройти
61-
путь от абсолютно базовых понятий Ruby до ООП и веб-разработки.
47+
#### Для начинающих
6248

63-
### Руководства
49+
[Programming Ruby 3.3][pickaxe]
50+
: Основополагающая книга о Ruby на английском языке, недавно обновлённая до версии Ruby 3.3.
6451

65-
[Programming Ruby][9]
66-
: Основополагающая работа по Ruby на английском в первом издании,
67-
[книга от Pragmatic Programmers][10], доступна бесплатно онлайн.
52+
[The Well-Grounded Rubyist][grounded]
53+
: Пошаговое руководство, начиная с первой программы на Ruby и заканчивая сложными темами: рефлексией, потоками и рекурсией.
6854

69-
[The Ruby Programming Wikibook][12]
70-
: Бесплатное онлайн-руководство для начинающих и продвинутых, плюс
71-
полная документация языка.
55+
#### Средний уровень
7256

73-
### Документация языка
57+
[Practical OOD in Ruby (POODR)][poodr]
58+
: Практическая книга о том, как писать объектно-ориентированный код на Ruby.
7459

75-
[Ruby Core Reference][13]
76-
: Полученная прямиком из исходного кода при помощи [RDoc][14], эта
77-
документация охватывает все классы и модули ядра (такие как String,
78-
Array, Symbol и так далее).
60+
#### Продвинутый уровень
7961

80-
[Ruby Standard Library Reference][15]
81-
: Так же полученная прямо из исходного кода при помощи RDoc, эта
82-
документация охватывает стандартные библиотеки.
62+
[Metaprogramming][meta]
63+
: Понятное объяснение метапрограммирования в Ruby.
8364

84-
[RubyDoc.info][16]
85-
: Веб-сайт содержащий в себе документацию о гемах Ruby и Ruby проектах,
86-
расположенных на GitHub.
65+
[Ruby Under a Microscope (RUM)][microscope]
66+
: Иллюстрированное руководство по внутреннему устройству Ruby.
67+
68+
### Документация от сообщества
8769

88-
[Ruby & Rails Searchable API Docs][17]
89-
: Rails и Ruby документация с умным поиском.
70+
Эти ресурсы поддерживаются сообществом Ruby.
9071

91-
[APIdock][18]
92-
: Ruby, Rails и RSpec документация с комментариями и заметками
93-
пользователей.
72+
[RubyDoc.info][16]
73+
: Центральный ресурс справочной документации по Ruby-гемам и проектам с GitHub.
9474

9575
[RubyAPI.org][rubyapi-org]
96-
: Легко находите и просматривайте классы, модули и методы Ruby.
76+
: Удобный поиск и просмотр классов, модулей и методов Ruby.
77+
78+
[ruby-doc.org][39]
79+
: Онлайн-справочник по API Ruby.
80+
81+
[DevDocs.io][40]
82+
: Онлайн-справочник по API Ruby.
83+
84+
[Ruby QuickRef][42]
85+
: Краткий справочник по Ruby.
86+
87+
[rubyreferences][43]
88+
: Полное описание языка + детальный журнал изменений.
89+
90+
### Стиль кода
91+
92+
[rubystyle.guide][44]
93+
: Руководство по стилю Ruby от RuboCop.
94+
95+
[RuboCop][45]
96+
: Автоматическая проверка и соблюдение правил стиля.
97+
98+
[Shopify][46]
99+
: Руководство по стилю Ruby от Shopify.
97100

98-
### Редакторы и среды разработки
101+
[GitLab][47]
102+
: Руководство по стилю Ruby от GitLab.
99103

100-
Для программирования на Ruby вы можете использовать стандартный
101-
редактор вашей операционной системы. Кстати, для более эффективного
102-
написания кода, стоит использовать редактор с поддержкой Ruby (например,
103-
подсветка синтаксиса, просмотр файлов) или среду разработки с
104-
продвинутыми функциями (например, code completion, рефакторинг,
105-
поддержка тестирования).
104+
[Airbnb][48]
105+
: Руководство по стилю Ruby от Airbnb.
106106

107-
Далее следует список популярных инструментов, используемых рубистами:
107+
[w3resource][49]
108+
: Руководство по стилю Ruby от W3resource.
108109

109-
* Инструменты для Linux и кросс-платформенные инструменты:
110-
* [Aptana Studio][19]
111-
* [Emacs][20] с [Ruby режимом][21] и [Rsense][22]
112-
* [Geany][23]
113-
* [gedit][24]
114-
* [Vim][25] с [vim-ruby][26] плагином и [Rsense][22]
115-
* [RubyMine][27]
116-
* [SciTe][28]
117-
* [NetBeans][36]
118-
* [Sublime Text][37]
119-
* [Visual Studio Code][vscode] с [Ruby LSP][39] плагином
110+
### Инструменты
120111

121-
* На Windows:
122-
* [Notepad++][29]
112+
[IRB][50]
113+
: Интерактивная консоль Ruby Read-Eval-Print-Loop (REPL).
123114

124-
* На macOS:
125-
* [TextMate][32]
126-
* [BBEdit][33]
115+
[Pry][51]
116+
: Альтернативный Ruby REPL.
127117

128-
### Дальнейшее чтение
118+
[Rake][52]
119+
: Инструмент сборки, аналогичный `make`, но для Ruby.
129120

130-
[Ruby-Doc.org][34] поддерживает актуальный список англоязычных источников.
131-
Если у вас есть
132-
вопросы по Ruby, [почтовая рассылка](/ru/community/mailing-lists/) – отличное место их задать.
121+
[RI][53]
122+
: Командная утилита Ruby для быстрого доступа к документации прямо из терминала.
133123

124+
[RBS][54]
125+
: Система описания типов для Ruby.
134126

127+
[TypeProf][55]
128+
: Экспериментальный интерпретатор Ruby, работающий на уровне типов — полезен для анализа и понимания кода.
129+
130+
[Steep][56]
131+
: Статический анализатор типов для Ruby.
132+
133+
### Редакторы и среды разработки (IDE)
134+
135+
Для написания кода на Ruby вы можете использовать любой текстовый редактор.
136+
Однако для более эффективной работы рекомендуется выбрать редактор с поддержкой Ruby
137+
(подсветка синтаксиса, переход по файлам) или полноценную среду разработки
138+
(автодополнение, рефакторинг, тестирование).
139+
140+
Популярные редакторы среди Ruby-разработчиков:
141+
142+
* **Несколько дней освоения**
143+
* [Sublime Text][37] (платный)
144+
* [Visual Studio Code][vscode]
145+
* [Zed][zed]
146+
* **Несколько месяцев**
147+
* [RubyMine][27] (платный)
148+
* **«Годы» — то есть вы будете изучать их бесконечно**
149+
* [Emacs][20] с [Ruby mode][21] или [Enhanced Ruby mode][enh-ruby-mode]
150+
* [Vim][25] с плагином [vim-ruby][26]
151+
* [NeoVim][neovim]
152+
153+
Все эти редакторы поддерживают **Language Server Protocol (LSP)**
154+
(по умолчанию или через плагины). LSP-сервер [ruby-lsp][ruby-lsp] от Shopify — один из самых популярных
155+
и [поддерживает все вышеперечисленные редакторы][ruby-lsp-supported-editors].
156+
157+
### Старые материалы и ресурсы
158+
159+
Эти ссылки долгое время были популярны, но давно не обновлялись.
160+
161+
[Ruby Koans][2]
162+
: Пошаговое обучение Ruby через тесты — «путь к просветлению» в духе дзен. Цель — понять язык, синтаксис и культуру Ruby.
163+
164+
[Ruby Essentials][7]
165+
: Бесплатная онлайн-книга с кратким и понятным введением в Ruby.
166+
167+
[Why’s (Poignant) Guide to Ruby][5]
168+
: Необычная, но весёлая книга, обучающая Ruby через истории и комиксы.
169+
Классика от *why the lucky stiff*.
170+
171+
[Learn Ruby the Hard Way][38]
172+
: Сборник упражнений с объяснениями, проводящий вас от основ Ruby до ООП и веб-разработки.
173+
174+
[Programming Ruby][9]
175+
: Первая версия знаменитой книги [Pragmatic Programmers][10], доступна бесплатно онлайн.
176+
177+
[The Ruby Programming Wikibook][12]
178+
: Бесплатное онлайн-руководство с материалами для начинающих и подробным справочником по языку.
135179

136180
[1]: https://try.ruby-lang.org/
137181
[2]: https://rubykoans.com/
138182
[5]: https://poignant.guide
139-
[7]: http://www.techotopia.com/index.php/Ruby_Essentials
140-
[8]: http://pine.fm/LearnToProgram/
141-
[9]: http://www.ruby-doc.org/docs/ProgrammingRuby/
142-
[10]: http://pragmaticprogrammer.com/titles/ruby/index.html
143-
[12]: http://en.wikibooks.org/wiki/Ruby_programming_language
144-
[13]: http://www.ruby-doc.org/core
145-
[14]: https://ruby.github.io/rdoc/
146-
[15]: http://www.ruby-doc.org/stdlib
147-
[16]: http://www.rubydoc.info/
148-
[17]: http://rubydocs.org/
149-
[18]: http://apidock.com/
150-
[rubyapi-org]: https://rubyapi.org/
151-
[19]: http://www.aptana.com/
152-
[20]: http://www.gnu.org/software/emacs/
153-
[21]: http://www.emacswiki.org/emacs/RubyMode
154-
[22]: http://rsense.github.io/
155-
[23]: http://www.geany.org/
156-
[24]: http://projects.gnome.org/gedit/screenshots.html
157-
[25]: http://www.vim.org/
183+
[7]: https://www.techotopia.com/index.php/Ruby_Essentials
184+
[8]: https://pine.fm/LearnToProgram/
185+
[9]: https://ruby-doc.com/docs/ProgrammingRuby/
186+
[10]: https://pragprog.com/titles/ruby5/programming-ruby-3-3-5th-edition/
187+
[12]: https://en.wikibooks.org/wiki/Ruby_programming_language
188+
[16]: https://www.rubydoc.info/
189+
[20]: https://www.gnu.org/software/emacs/
190+
[21]: https://www.emacswiki.org/emacs/RubyMode
191+
[25]: https://www.vim.org/
158192
[26]: https://github.com/vim-ruby/vim-ruby
159-
[27]: http://www.jetbrains.com/ruby/
160-
[28]: http://www.scintilla.org/SciTE.html
161-
[29]: http://notepad-plus-plus.org/
162-
[32]: http://macromates.com/
163-
[33]: https://www.barebones.com/products/bbedit/
164-
[34]: http://ruby-doc.org
165-
[36]: https://netbeans.org/
166-
[37]: http://www.sublimetext.com/
193+
[27]: https://www.jetbrains.com/ruby/
194+
[37]: https://www.sublimetext.com/
167195
[38]: https://learncodethehardway.org/ruby/
168-
[vscode]: https://code.visualstudio.com/
169-
[39]: https://marketplace.visualstudio.com/items?itemName=Shopify.ruby-lsp
196+
[39]: https://ruby-doc.org/
197+
[40]: https://devdocs.io/ruby/
198+
[42]: https://www.zenspider.com/ruby/quickref.html
199+
[43]: https://rubyreferences.github.io/
200+
[44]: https://rubystyle.guide/
201+
[45]: https://github.com/rubocop/ruby-style-guide
202+
[46]: https://ruby-style-guide.shopify.dev/
203+
[47]: https://docs.gitlab.com/ee/development/backend/ruby_style_guide.html
204+
[48]: https://github.com/airbnb/ruby
205+
[49]: https://www.w3resource.com/ruby/ruby-style-guide.php
206+
[50]: https://github.com/ruby/irb
207+
[51]: https://github.com/pry/pry
208+
[52]: https://github.com/ruby/rake
209+
[53]: https://ruby.github.io/rdoc/RI_md.html
210+
[54]: https://github.com/ruby/rbs
211+
[55]: https://github.com/ruby/typeprof
212+
[56]: https://github.com/soutaro/steep
213+
[codecademy]: https://www.codecademy.com/learn/learn-ruby
214+
[docs-rlo]: https://docs.ruby-lang.org/en
215+
[docs-rlo-3.4]: https://docs.ruby-lang.org/en/3.4
216+
[docs-rlo-master]: https://docs.ruby-lang.org/en/master
217+
[docs-rlo-extension]: https://docs.ruby-lang.org/en/master/extension_rdoc.html
218+
[enh-ruby-mode]: https://github.com/zenspider/enhanced-ruby-mode/
219+
[exercism]: https://exercism.org/tracks/ruby
220+
[grounded]: https://www.manning.com/books/the-well-grounded-rubyist-third-edition
221+
[meta]: https://pragprog.com/titles/ppmetr2/metaprogramming-ruby-2/
222+
[microscope]: https://patshaughnessy.net/ruby-under-a-microscope
223+
[neovim]: https://neovim.io/
224+
[odin]: https://www.theodinproject.com/paths/full-stack-ruby-on-rails/courses/ruby
225+
[pickaxe]: https://pragprog.com/titles/ruby5/programming-ruby-3-3-5th-edition/
226+
[poodr]: https://www.poodr.com/
227+
[ruby-lsp]: https://github.com/Shopify/ruby-lsp
228+
[ruby-lsp-supported-editors]: https://shopify.github.io/ruby-lsp/editors.html
229+
[rubyapi-org]: https://rubyapi.org/
230+
[rubyin20]: /ru/documentation/quickstart/
231+
[vscode]: https://code.visualstudio.com/docs/languages/ruby
232+
[zed]: https://zed.dev/

0 commit comments

Comments
 (0)