Upgrade to Pro
— share decks privately, control downloads, hide ads and more …
Speaker Deck
Features
Speaker Deck
PRO
Sign in
Sign up for free
Search
Search
Rubyの日本語リファレンスマニュアルの現在と未来
Search
Kazuhiro NISHIYAMA
October 05, 2024
Programming
0
21
Rubyの日本語リファレンスマニュアルの現在と未来
[松江Ruby会議11](
https://matsue.rubyist.net/matrk11/)での発表資料です
。
Kazuhiro NISHIYAMA
October 05, 2024
Tweet
Share
More Decks by Kazuhiro NISHIYAMA
See All by Kazuhiro NISHIYAMA
devise-two-factorを4.xから5.xに上げた話
znz
0
83
docs.ruby-lang.org/ja/ の生成方法を変えた
znz
0
42
Ubuntuのriscv64版をqemuで動かした
znz
0
46
lilo.linux.or.jpをbusterからbullseyeに上げた
znz
0
57
小規模個人アプリをRails 7.xにバージョンアップした話
znz
0
41
Ruby リファレンスマニュアル改善計画 2022 進捗報告
znz
0
100
Rubyist Magazine Reboot
znz
0
140
History of Japanese Ruby reference manual, and future
znz
0
1.6k
qemuのriscv64にDebianを入れてみた
znz
0
110
Other Decks in Programming
See All in Programming
StarlingMonkeyを触ってみた話 - 2024冬
syumai
3
260
Zoneless Testing
rainerhahnekamp
0
120
Testing Assembly: Code or Low Code - Navigating the Test Automation Options
maaretp
0
110
TypeScript でバックもやるって実際どう? 実運用で困ったこと3選
yuichiro_serita
17
7.7k
HTTP compression in PHP and Symfony apps
dunglas
2
1.6k
社内活動の取り組み紹介 ~ スリーシェイクでこんな取り組みしてます ~
bells17
0
400
「Chatwork」Android版アプリを 支える単体テストの現在
okuzawats
0
160
nekko cloudにおけるProxmox VE利用事例
irumaru
3
350
layerx_20241129.pdf
kyoheig3
2
270
Refactor your code - refactor yourself
xosofox
1
230
Jakarta EE meets AI
ivargrimstad
0
1.3k
事業成長を爆速で進めてきたプロダクトエンジニアたちの成功談・失敗談
nealle
3
1.4k
Featured
See All Featured
Art, The Web, and Tiny UX
lynnandtonic
298
20k
Building Applications with DynamoDB
mza
91
6.1k
How STYLIGHT went responsive
nonsquared
95
5.2k
Unsuck your backbone
ammeep
669
57k
Keith and Marios Guide to Fast Websites
keithpitt
410
22k
Optimising Largest Contentful Paint
csswizardry
33
3k
How to train your dragon (web standard)
notwaldorf
88
5.7k
Building a Scalable Design System with Sketch
lauravandoore
460
33k
XXLCSS - How to scale CSS and keep your sanity
sugarenia
247
1.3M
StorybookのUI Testing Handbookを読んだ
zakiyama
27
5.3k
BBQ
matthewcrist
85
9.4k
Side Projects
sachag
452
42k
Transcript
Rubyの日本語リファレンスマニュ アルの現在と未来 Kazuhiro NISHIYAMA 株式会社Ruby開発 松江Ruby会議11 2024-10-05 Powered by Rabbit
3.0.3
self.introduction 西山 和広 株式会社Ruby開発 www.ruby-dev.jp github など: @znz Ruby のコミッター
https://github.com/rurema の管理者 1/17
アジェンダ るりまの説明 現状 やりたいこと 手伝ってほしいこと 2/17
るりまとは? Japanese Ruby reference manual Rubyリファレンスマニュアル刷新計画 https://github.com/rurema rurema/doctree - ドキュメントのソース
rurema/bitclust - るりま用の独自システム rurema/generated-documents - 生成したHTML 3/17
閲覧用サイト 公式サイト https://docs.ruby-lang.org/ja/ https://docs.ruby-lang.org/ja/latest/ 常に最新安定版 https://docs.ruby-lang.org/ja/3.3/ バージョンごと https://docs.ruby-lang.org/ja/3.2/ バージョンごと https://docs.ruby-lang.org/ja/master/
常に開発版 るりまサーチ https://docs.ruby-lang.org/ja/search/ Groonga, Rroonga を使った専用検索システム 4/17
ドキュメント更新の流れ rurema/doctree のドキュメントを更新 RD という「Rubyリファレンスマニュアル刷新計画」以前のドキュ メントで使われていた記法ベースにした bitclust 独自記法 bitclust で変換
バージョンごとの独自データベースに変換 るりまサーチ もこのデータベースを参照している rurema/generated-documents の GitHub Actions で HTML 生成して rurema/generated-documents に反映 docs.ruby-lang.org に反映 git pull して反映、るりまサーチのインデックス更新 5/17
ドキュメントの内容の現状 最近のバージョンにおいついていないところがある 何がおいついていないのかもまとまっていない メソッドごとの対応はしやすいので、かなりおいついている? 文法の変更などの対応状況は未確認 NEWS の翻訳もおいついていない 6/17
今後の予定 bitclust の Markdown 対応 貢献してもらいやすくするため bitclust の使い方のドキュメントをまとめなおし `docs.ruby-lang.org/ja/ の改善
7/17
Markdown 対応の残作業 bitclust への型付けをしつつコードリーディングの続き 現在作業中 kramdown への型付け (まだなければ) 開発環境の devcontainer
化 (bitclust 開発者向けと doctree 執筆者向け) devcontainer の設定は入れた bitclust の markdown 対応 8/17
rurema の markdown 対応 bitclust に markdown 対応機能追加 markdown 移行前に
doctree の pull request 一掃 doctree で markdown に一部書き換え doctree の書き換えでわかった bitclust で markdown 対応の問題点修正 rurema-search の markdown 対応 9/17
rurema の markdown 対応 doctree で全面的に markdown 対応 doctree の
RDベース記法のドキュメント削除 bitclust から RD 対応を削除 10/17
同時やること bitclust の使い方のドキュメントをまとめなおし コントリビュートしてもらうときの手順など 現在は使えなくなっているツールなども残っているかも ドキュメント執筆補助ツール (bitclust の tools) 再整備
使えないものを削除するなどの整理 11/17
その他のやりたいこと irb でのドキュメント表示対応 サンプルコードの ruby.wasm での実行対応 rurema/generated-documents の生成済ファイル汎用化 埋め込まれているタグなどの関係で docs.ruby-lang.org
専用 → うまく分離したい 12/17
docs.ruby-lang.org関連 docs.ruby-lang.org の環境軽量化 HTML 生成部分は GitHub Actions 化完了 https://github.com/ruby/docs.ruby-lang.org にある
ansible の playbook も現状と合わないので EC2 インスタンス作り直し? 別環境へ移行? 脆弱性のある古い js の対処 (あれば) 古い jquery などが残っているかどうかなどの確認から 13/17
docs.ruby-lang.org関連(できれば) 古いバージョンの db-* の再生成 るりまサーチで古いバージョンの検索ができない HTML 配信元を EC2 から S3
バックエンドか 何かに移行(?) rurema-search は生成されるインデックスだけで 600M 越え (heroku の slug の 500M 制限超過) で 静的ファイルのホスティング + Heroku への移行は無理そう 14/17
今でも手伝ってほしいこと ドキュメントの更新 メソッドの追加・変更・削除あたりは手をつけやすい 「Ruby x.y 対応」の issue の作成やメンテナンス 未翻訳の NEWS
などの翻訳 文法などのクラスやメソッド以外のドキュメントの構成 開発ドキュメントの更新 bitclust の使い方のまとめなおし pull request 作成までの動作確認方法など よく使うコマンド一覧の作成など 現在は使えない機能や制限があれば追記 15/17
MD 対応で手伝ってほしいこと Markdown 対応前 型に詳しい人は ruby-jp Slack の #types で相談にのってほしい
Markdown 対応時 RD から Markdown への書き換え 書き換え時にあった問題点の報告 Markdown 対応後 Markdown でのドキュメント更新 16/17
最後に ドキュメントの誤字脱字なども含めて https://github.com/rurema/doctree/issues でいつでも受け付け中 issues に対応してくれる人も増えてほしい 人が少ないので放置されがちかも pull request のレビューをしてくれる人も増えてほしい
pull request 作成までの手順とかもまとまっていると良さそう 何かあれば ruby-jp Slack の #rurema もどうぞ 17/17 Powered by Rabbit 3.0.3