Text
Page: 1
Rubyの日本語リファレンスマニュ アルの現在と未来 Kazuhiro NISHIYAMA 株式会社 Ruby 開発 松江 Ruby 会議 11 2024-10-05 Powered by Rabbit 3.0.3
Page: 2
self.introduction 西山 和広 株式会社 Ruby 開発 www.ruby-dev.jp github など: @znz Ruby のコミッター https://github.com/rurema の管理者 1/17
Page: 3
アジェンダ るりまの説明 現状 やりたいこと 手伝ってほしいこと 2/17
Page: 4
るりまとは ? Japanese Ruby reference manual Rubyリファレンスマニュアル刷新計画 https://github.com/rurema rurema/doctree - ドキュメントのソース rurema/bitclust - るりま用の独自システム rurema/generated-documents - 生成したHTML 3/17
Page: 5
閲覧用サイト 公式サイト 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
Page: 6
ドキュメント更新の流れ rurema/doctree のドキュメントを更新 RD という「Rubyリファレンスマニュアル刷新計画」以前のドキュ メントで使われていた記法ベースにした bitclust 独自記法 bitclust で変換 バージョンごとの独自データベースに変換 るりまサーチ もこのデータベースを参照している rurema/generated-documents の GitHub Actions で HTML 生成して rurema/generated-documents に反映 docs.ruby-lang.org に反映 git pull して反映、るりまサーチのインデックス更新 5/17
Page: 7
ドキュメントの内容の現状 最近のバージョンにおいついていないところがある 何がおいついていないのかもまとまっていない メソッドごとの対応はしやすいので、かなりおいついている ? 文法の変更などの対応状況は未確認 NEWS の翻訳もおいついていない 6/17
Page: 8
今後の予定 bitclust の Markdown 対応 貢献してもらいやすくするため bitclust の使い方のドキュメントをまとめなおし `docs.ruby-lang.org/ja/ の改善 7/17
Page: 9
Markdown 対応の残作業 bitclust への型付けをしつつコードリーディングの続き 現在作業中 kramdown への型付け (まだなければ) 開発環境の devcontainer 化 (bitclust 開発者向けと doctree 執筆者向け) devcontainer の設定は入れた bitclust の markdown 対応 8/17
Page: 10
rurema の markdown 対応 bitclust に markdown 対応機能追加 markdown 移行前に doctree の pull request 一掃 doctree で markdown に一部書き換え doctree の書き換えでわかった bitclust で markdown 対応の問題点修正 rurema-search の markdown 対応 9/17
Page: 11
rurema の markdown 対応 doctree で全面的に markdown 対応 doctree の RDベース記法のドキュメント削除 bitclust から RD 対応を削除 10/17
Page: 12
同時やること bitclust の使い方のドキュメントをまとめなおし コントリビュートしてもらうときの手順など 現在は使えなくなっているツールなども残っているかも ドキュメント執筆補助ツール (bitclust の tools) 再整備 使えないものを削除するなどの整理 11/17
Page: 13
その他のやりたいこと irb でのドキュメント表示対応 サンプルコードの ruby.wasm での実行対応 rurema/generated-documents の生成済ファイル汎用化 埋め込まれているタグなどの関係で docs.ruby-lang.org 専用 → うまく分離したい 12/17
Page: 14
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
Page: 15
docs.ruby-lang.org関連(できれば) 古いバージョンの db-* の再生成 るりまサーチで古いバージョンの検索ができない HTML 配信元を EC2 から S3 バックエンドか 何かに移行 (?) rurema-search は生成されるインデックスだけで 600M 越え (heroku の slug の 500M 制限超過) で 静的ファイルのホスティング + Heroku への移行は無理そう 14/17
Page: 16
今でも手伝ってほしいこと ドキュメントの更新 メソッドの追加・変更・削除あたりは手をつけやすい 「Ruby x.y 対応」の issue の作成やメンテナンス 未翻訳の NEWS などの翻訳 文法などのクラスやメソッド以外のドキュメントの構成 開発ドキュメントの更新 bitclust の使い方のまとめなおし pull request 作成までの動作確認方法など よく使うコマンド一覧の作成など 現在は使えない機能や制限があれば追記 15/17
Page: 17
MD 対応で手伝ってほしいこと Markdown 対応前 型に詳しい人は ruby-jp Slack の #types で相談にのってほしい Markdown 対応時 RD から Markdown への書き換え 書き換え時にあった問題点の報告 Markdown 対応後 Markdown でのドキュメント更新 16/17
Page: 18
最後に ドキュメントの誤字脱字なども含めて https://github.com/rurema/doctree/issues でいつでも受け付け中 issues に対応してくれる人も増えてほしい 人が少ないので放置されがちかも pull request のレビューをしてくれる人も増えてほしい pull request 作成までの手順とかもまとまっていると良さそう 何かあれば ruby-jp Slack の #rurema もどうぞ Powered by Rabbit 3.0.3 17/17
