Upgrade to Pro
— share decks privately, control downloads, hide ads and more …
Speaker Deck
Sign up for free
Menu
Search
Features
All features
Private URLs
Password Protection
Custom URLS
Scheduled publishing
Remove Branding
Restrict embedding
Deck Collections
Notes
Features
All features
Private URLs
Password Protection
Custom URLS
Scheduled publishing
Remove Branding
Restrict embedding
Deck Collections
Notes
Explore
Featured decks
Featured speakers
Programming
Technology
Storyboards
Explore
Featured decks
Featured speakers
Programming
Technology
Storyboards
Pricing
Search
Sign in
Sign up for free
Rubyリファレンスマニュアルをよりよくしよう!/lets-make-rurema-better
Search
ima1zumi
September 29, 2020
290
2
Share
Embed
Copy iframe code
Copy JS code
Copy link
Start on current slide
Rubyリファレンスマニュアルをよりよくしよう!/lets-make-rurema-better
https://uniquevision.connpass.com/event/187447/
ima1zumi
September 29, 2020
Transcript
13 slides
Rubyリファレンスマニュアルを よりよくしよう! 2020-09-29 @ima1zumi 1
⾃⼰紹介 @ima1zumi (いまいずみ) FJORD BOOT CAMP というスクールで Ruby や Ruby
on Rails 学習中 2
話すきっかけ Rubyリファレンスマニュアルで Ruby 2.7.0 対応されていないと ころを⾒つけた PRを送ってマージされた PRを送る⼈が増えたらいいな 3
Ruby リファレンスマニュアル Ruby リファレンスマニュアル 略して「るりま」 ちなみに「るびま」は Rubyist Magazine の略で使われることが多 い
4
どうやって管理されているの? GitHub で管理されている ドキュメントは 簡単に記述できる rd ファイルで出来ている rd ファイルを BitClust
で HTML に変換している 直感的に書ける 5
誰が更新しているの? コミッター ⾃⼰申告制 ボランティアでメンテナンスしてくれている コントリビューター るりまにPRやissueを⽴てる⼈ 誰でもコントリビューターになれる! Slack ruby-jp に
#rurema チャンネルがある 6
るりまで気になるところを⾒つけたら 1. issue を⽴てる 2. PR を送る 7
issueを⽴てる 例: ドキュメントの単純な誤り指摘 (バージョン間違いなど) ドキュメントをよりよくするための提案 (説明⽂追加など) あるメソッドのサンプルコード提供 既に上がっているIssueに対するコメント 8
PRを送る rd ファイル⽤の記法を使わない => GitHub 上で直接修正する rd ファイル⽤の記法を使う => fork
して修正して HTML を確認して push する 9
GitHub上で直接修正する 右上の [edit] リンクからGitHub上で直接修正ができる 10
forkしてローカルで修正してPRを送る 1. fork する 2. clone して .rd ファイルを修正する 3.
bitclust を⼊れて修正したファイルをプレビューする $ gem install bitclust-core bitclust-dev refe2 $ bitclust setup $ bitclust htmlfile ./refm/api/src/_builtin/Array -- target=Array#pop --ruby=2.5.0 > /tmp/Array_pop.html 4. commit して PR を送る 11
参考 Tutorial · rurema/doctree Wiki ReferenceManualFormatDigest · rurema/doctree Wiki BitClust
· rurema/doctree Wiki 12
るりまに気軽にPRを送ろう 13
More Decks by ima1zumi
See All by ima1zumi
Is Ruby's Multi-Encoding Overhead Heavy?
ima1zumi
1
3.2k
OSSと私たち: Rubyの開発を支える STORES
ima1zumi
2
210
Ruby Taught Me About Under the Hood
ima1zumi
6
25k
Exploring Reline: Enhancing Command Line Usability
ima1zumi
1
220
10年物のRailsアプリにキャッチアップ!〜コードを読まずに理解したかった〜
ima1zumi
0
190
RubyKaigiの登壇者一覧ページを作った
ima1zumi
0
740
Relineのその後の生活
ima1zumi
0
310
IRB and Reline Kaigi 2024
ima1zumi
0
71
Exploring Reline: Enhancing Command Line Usability
ima1zumi
3
16k
Featured
See All Featured
RailsConf 2023
tenderlove
30
1.6k
Navigating Weather and Climate Data
rabernat
0
590
Refactoring Trust on Your Teams (GOTO; Chicago 2020)
rmw
35
3.9k
The Mindset for Success: Future Career Progression
greggifford
PRO
0
560
The SEO identity crisis: Don't let AI make you average
varn
0
630
Pawsitive SEO: Lessons from My Dog (and Many Mistakes) on Thriving as a Consultant in the Age of AI
davidcarrasco
1
300
WCS-LA-2024
lcolladotor
0
1k
How to Build an AI Search Optimization Roadmap - Criteria and Steps to Take #SEOIRL
aleyda
1
2.3k
The Cost Of JavaScript in 2023
addyosmani
56
10k
Designing Powerful Visuals for Engaging Learning
tmiket
1
660
Rails Girls Zürich Keynote
gr2m
96
14k
Paper Plane
katiecoart
PRO
6
55k