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
ドキュメントを修正する
Search
Shinichi Maeshima
April 23, 2018
Technology
0
310
ドキュメントを修正する
株式会社リンカーズさんの社内勉強会で発表したLTのスライドです
Shinichi Maeshima
April 23, 2018
Tweet
Share
More Decks by Shinichi Maeshima
See All by Shinichi Maeshima
Sidekiq vs Solid Queue
willnet
14
12k
どうしてこうなった?から理解するActive Recordの関連の裏側
willnet
6
1.5k
Exceptional Rails
willnet
6
7.7k
Breaking the Flaky Test Cycle
willnet
2
2.2k
mrskで広がるインフラの選択肢
willnet
1
1.1k
アプリケーションを長期にわたって無理なく運用するためのたったひとつの方法
willnet
2
2.2k
HotwireからDHHが考えるこれからのRailsとJSの付き合い方を知る
willnet
14
14k
Rails6.1で新しく入る機能について
willnet
12
16k
Concerns about Concerns
willnet
11
35k
Other Decks in Technology
See All in Technology
RAID6 を楔形文字で組んで現代人を怖がらせましょう(実装編)
mimifuwa
1
320
『FailNet~やらかし共有SNS~』エレベーターピッチ
yokomachi
1
170
【 LLMエンジニアがヒューマノイド開発に挑んでみた 】 - 第104回 Machine Learning 15minutes! Hybrid
soneo1127
0
170
プロダクトの成長に合わせたアーキテクチャの段階的進化と成長痛、そして、ユニットエコノミクスの最適化
kakehashi
PRO
1
100
AIドリブンのソフトウェア開発 - うまいやり方とまずいやり方
okdt
PRO
9
730
Browser
recruitengineers
PRO
6
1.7k
TypeScript入門
recruitengineers
PRO
30
9.5k
ZOZOTOWNフロントエンドにおけるディレクトリの分割戦略
zozotech
PRO
18
5.8k
実践アプリケーション設計 ③ドメイン駆動設計
recruitengineers
PRO
12
3k
Figma + Storybook + PlaywrightのMCPを使ったフロントエンド開発
yug1224
10
3.3k
Kubernetes における cgroup v2 でのOut-Of-Memory 問題の解決
pfn
PRO
0
270
Yahoo!ニュースにおけるソフトウェア開発
lycorptech_jp
PRO
0
510
Featured
See All Featured
The Straight Up "How To Draw Better" Workshop
denniskardys
236
140k
We Have a Design System, Now What?
morganepeng
53
7.8k
The Illustrated Children's Guide to Kubernetes
chrisshort
48
50k
Raft: Consensus for Rubyists
vanstee
140
7.1k
Typedesign – Prime Four
hannesfritz
42
2.8k
Bootstrapping a Software Product
garrettdimon
PRO
307
110k
Rails Girls Zürich Keynote
gr2m
95
14k
jQuery: Nuts, Bolts and Bling
dougneiner
64
7.9k
Producing Creativity
orderedlist
PRO
347
40k
[Rails World 2023 - Day 1 Closing Keynote] - The Magic of Rails
eileencodes
36
2.5k
Distributed Sagas: A Protocol for Coordinating Microservices
caitiem20
333
22k
Scaling GitHub
holman
463
140k
Transcript
υΩϡϝϯτΛमਖ਼͢Δ @willnet
ීஈͷ։ൃɺͳΜΒ͔ͷυΩϡϝϯτ Λݟͳ͕Β։ൃ͠·͢ΑͶ
OSSͷυΩϡϝϯτͷؒҧ͍Λݟ͚ͭͨΒͲ͏͠ ·͔͢ʁ 1. εϧʔ 2. ؒҧ͍Λमਖ਼͢Δɺใࠂ͢Δ
OSSͷυΩϡϝϯτͷؒҧ͍Λݟ͚ͭͨΒͲ͏͠ ·͔͢ʁ 1. ! εϧʔ 2. " ؒҧ͍Λमਖ਼͢Δɺใࠂ͢Δ
OSSͷυΩϡϝϯτʮࣄͰ͏υ Ωϡϝϯτʯͱ͍͏͘͘ΓͰߟ͑Ε Ұॹ
ͨͱ͑ࣾͷυΩϡϝϯτͰؒҧ͍ݟ͚ͭͨΒ ؒ͜͜ҧ͑ͯ·͢Αʔɻ͔͚ͬͯͨΓɺαοͱमਖ਼ͨ͠Γ͠ ·͢ΑͶ
͠·͢ΑͶ…ʁ
ͦΕΛࣾ֎ͰΔ͚ͩ • ͕͍ࣗͨͪͬͯΔπʔϧʹࣾࣾ֎ͳ͍ • ؒҧ͍Λ์ஔ͍ͯ͠Δͱ୭͔͕ϋϚΔ͔
͔͠͠Γํ͕Θ͔Βͳ͍ͱϋʔυϧ ߴ͘ײͦ͡͏
આ໌͠·͢
(༨ஊ)࠷ۙͷ׆ಈใࠂͰ͋Δ ࠷ۙRubyॳ৺ऀ͚ͷຊΛࠪಡ͍ͯͯ͠ɺ֬ೝͷͨΊʹυΩϡ ϝϯτΛಡΈɺؒҧ͍Λݟ͚ͭͯPRIssueΛ࡞Δɺͱ͍͏͜ͱ ΛԿ͔ͬͯͨͷͰͦͷ׆ಈใࠂͰ͋Γ·͢
RubyͷυΩϡϝϯτ(ຊޠ) • ΦϒδΣΫτࢦεΫϦϓτݴޠ Ruby ϦϑΝϨϯεϚχϡ Ξϧ • https://docs.ruby-lang.org/ja/latest/doc/index.html • ௨শΔΓ·
• ࠷RubyϦϑΝϨϯεϚχϡΞϧݕࡧʂ | ΔΓ·αʔν • https://docs.ruby-lang.org/ja/search/
ຊޠυΩϡϝϯτGitHubͰཧ͞Ε͍ͯΔ • https://github.com/rurema/doctree
मਖ਼͚ͨ͠ΕPull Request
ΔΓ·ຊޠͰPull RequestIssueͩ͠ ͯେৎͦ͏
ฤू༰Λ֬ೝ͢Δํ๏ • PRલʹɺฤू༰ΛHTMLʹͯ֬͠ೝ͢Δඞཁ͕͋Δ • markdown ͳͲमਖ਼ͯ͠ݟͨͲ͏มΘΔͷ͔Θ͔Γ· ͤΜ • େͷ߹ɺͲ͔͜ʹΓํ͕ॻ͍ͯ͋Δ(READMEͱ͔wiki ͱ͔)
• ͳ͚ΕRakefileΛΈΔͱΑ͍
ΔΓ·ฤूͷҙ
ฤू༰Λ֬ೝ͢ΔͨΊͷใ͕ࢄΒ͍ͬͯͯ Θ͔Γʹ͍͘… • ͱΓ͋͑ͣ͜ͷ2͚͓͚֮ͭͩ͑ͯฤूɺ֬ೝͰ͖ͦ͏ • bundle exec rake statichtml:2.5.0 Έ͍ͨʹ͢Δͱ
/ private/tmp/html ʹϑΝΠϧ͕ग़ྗ͞ΕΔ • /tmp/db-2.5.0 ͳͲʹதؒੜͷDB͕࡞͞ΕΔΑ͏ ͳͷͰɺstatichtmlͰมߋ͕ͳ͍߹DBফͯ͠ϦτϥΠ ͢Δͱྑͦ͞͏
RubyͷυΩϡϝϯτ(ӳޠ) • Documentation for Ruby trunk • https://docs.ruby-lang.org/en/trunk/ • Rubyຊମͷιʔείʔυ͔ΒRDocΛར༻ͯ͠ੜ
ӳޠυΩϡϝϯτRDoc ͭ·ΓRubyຊମͷίϝϯτʹຒΊࠐ·Ε͍ͯΔ
मਖ਼͚ͨ͠ΕPull Request • https://github.com/ruby/ruby • جຊతʹredmineͷํ͕ྑ͍͚Ͳɺ؆୯ͳ༰ͳΒGitHub ͰΑ͍ͣ…ʁ • ྫ: https://github.com/ruby/ruby/pull/1857
ຊޠ൛ɺӳޠ൛υΩϡϝϯτΛϗεςΟϯά͠ ͍ͯΔαʔόͷઃఆGitHubͰཧ͞Ε͍ͯ· ͢ • https://github.com/ruby/docs.ruby-lang.org
ϦϯΫΕʹͳ͍ͬͯΔՕॴ Λݟ͚ͭͯɺαʔόཁҼͬΆ ͔ͬͨͷͰIssueΛ͛ͨਤ • https://github.com/ruby/docs.ruby- lang.org/issues/56
RailsͷެࣜυΩϡϝϯτ • http://api.rubyonrails.org/ • (ͨΓલ͚ͩͲ)ӳޠ൛ͷΈ • https://github.com/rails/rails/ • rdocͰੜ
RailsΨΠυ • http://guides.rubyonrails.org/ • ຊମίʔυͱಉ͡ϦϙδτϦͰཧ͞Ε͍ͯΔ • https://github.com/rails/rails/tree/master/guides • markdownܗࣜ
मਖ਼͚ͨ͠ΕPull Request • typoϨϕϧͳΒҰॠͰϚʔδ͞ΕΔ ͜ͱ͕ଟ͍ • [ci skip]ΛΕͣʹ
RailsΨΠυຊޠ൛ • ༗ࢤ(ओʹYassLabࣾ)͕ϝϯς͍ͯ͠Δ • ίϛολʔͰ͢ • ެࣜͱͷ͔ࠩͳΓ͋ΔͷͰPRνϟϯεͷๅݿ • https://github.com/yasslab/railsguides.jp
मਖ਼͚ͨ͠ΕPull Request • ຊޠͰPR࡞ΕΔͷͰෑډ͕͍ • मਖ਼༰ͷ֬ೝํ๏READMEಡΊ ͙͢Ͱ͖·͢
(༨ஊ)ӳޠͰPRIssueΛॻ ͘ͱ͖ͷίπ • google༁ʹӳޠΛॻ͍ͯɺҙຯ͕ ௨Δ͔֬ೝ • ͜Ε͚ͩͰ͍ͩͿ҆৺Ͱ͖Δ
·ͱΊ • OSSͷυΩϡϝϯτɺࣾͷυΩϡϝϯτͱಉ͡Α͏ʹϝ ϯςφϯε͍͖ͯ͠·͠ΐ͏ • ͍͍ͩͨGitHubͰPull RequestͰ͖·͢ • ͓࡞๏͑͑͞Εɺ͋ͱࣾͷυΩϡϝϯτͱಉ͡Α͏ ʹमਖ਼Ͱ͖·͢
(༨ஊ)mac͍ͳΒDashΦεεϝͰ͢
ϩʔΧϧʹඞཁͳυΩ ϡϝϯτΛμϯϩʔ υ͓͍ͯͯ͠ɺαοͱ ݕࡧͰ͖·͢
$26.99 ͷՁ͋ΔΑ
happy documantating !