rabbit-slide-znz-rurema-2024-10 2024.10.5.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: e12e672c100c53d574998b899fc1610121c3a96f306f371afd5a63c776c4da7b
+  data.tar.gz: 98f03991e0ceca6703442f83587c9cd7df8ca515cf36a26eff0c2b90821c8037
+SHA512:
+  metadata.gz: 5215573507a4a0714df44d0e316cc3ebd6a78dfa529bc453af2dc552e8ead7a77eb974caa2f578487c6c33018dfe913b82f34816da7a4fd9e20e3d48f243cae5
+  data.tar.gz: 6dab22b229c0f23fe892d52a25eaa608cb4225bc0cfb611c7d62278402de58f74bf1ea47e8c3bba0dfeb8b866c4ece9c435d8c191d00b0d2967d2ed403475073

data/.rabbit

@@ -0,0 +1,2 @@
+--size 1920,1200
+rurema-2024-10.md

data/README.md

@@ -0,0 +1,23 @@
+# Rubyの日本語リファレンスマニュアルの現在と未来
+
+[松江Ruby会議11](https://matsue.rubyist.net/matrk11/)での発表資料です。
+
+## 作者向け
+
+### 表示
+
+    rake
+
+### 公開
+
+    rake publish
+
+## 閲覧者向け
+
+### インストール
+
+    gem install rabbit-slide-znz-rurema-2024-10
+
+### 表示
+
+    rabbit rabbit-slide-znz-rurema-2024-10.gem

data/Rakefile

@@ -0,0 +1,17 @@
+require "rabbit/task/slide"
+
+# Edit ./config.yaml to customize meta data
+
+spec = nil
+Rabbit::Task::Slide.new do |task|
+  spec = task.spec
+  # spec.files += Dir.glob("doc/**/*.*")
+  # spec.files -= Dir.glob("private/**/*.*")
+  # spec.add_runtime_dependency("rabbit-theme-YOUR-THEME")
+end
+
+desc "Tag #{spec.version}"
+task :tag do
+  sh("git", "tag", "-a", spec.version.to_s, "-m", "Publish #{spec.version}")
+  sh("git", "push", "--tags")
+end

data/config.yaml

@@ -0,0 +1,24 @@
+---
+id: rurema-2024-10
+base_name: rurema-2024-10
+tags:
+- ruby
+presentation_date: '2024-10-05'
+presentation_start_time:
+presentation_end_time:
+version: 2024.10.5.0
+licenses: []
+slideshare_id: ruby-ruby-11-2024-10-05
+speaker_deck_id: rubynori-ben-yu-rihuarensumaniyuarunoxian-zai-towei-lai
+vimeo_id:
+youtube_id:
+width: 1920
+height: 1200
+source_code_uri:
+author:
+  markup_language: :markdown
+  name: Kazuhiro NISHIYAMA
+  email: zn@mbf.nifty.com
+  rubygems_user: znz
+  slideshare_user: znzjp
+  speaker_deck_user: znz

data/rurema-2024-10.md

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

metadata

@@ -0,0 +1,62 @@
+--- !ruby/object:Gem::Specification
+name: rabbit-slide-znz-rurema-2024-10
+version: !ruby/object:Gem::Version
+  version: 2024.10.5.0
+platform: ruby
+authors:
+- Kazuhiro NISHIYAMA
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2024-10-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rabbit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.2
+description: "[松江Ruby会議11](https://matsue.rubyist.net/matrk11/)での発表資料です。"
+email:
+- zn@mbf.nifty.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rabbit"
+- README.md
+- Rakefile
+- config.yaml
+- pdf/rurema-2024-10-rurema-2024-10.pdf
+- rurema-2024-10.md
+homepage: https://slide.rabbit-shocker.org/authors/znz/rurema-2024-10/
+licenses: []
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.16
+signing_key:
+specification_version: 4
+summary: Rubyの日本語リファレンスマニュアルの現在と未来
+test_files: []