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.6k
Breaking the Flaky Test Cycle
willnet
2
2.2k
mrskで広がるインフラの選択肢
willnet
1
1.1k
アプリケーションを長期にわたって無理なく運用するためのたったひとつの方法
willnet
2
2.2k
HotwireからDHHが考えるこれからのRailsとJSの付き合い方を知る
willnet
14
13k
Rails6.1で新しく入る機能について
willnet
12
16k
Concerns about Concerns
willnet
11
35k
Other Decks in Technology
See All in Technology
私とAWSとの関わりの歩み~意志あるところに道は開けるかも?~
nagisa53
1
130
AWS表彰プログラムとキャリアについて
naoki_0531
1
140
増え続ける脆弱性に立ち向かう: 事前対策と優先度づけによる 持続可能な脆弱性管理 / Confronting the Rise of Vulnerabilities: Sustainable Management Through Proactive Measures and Prioritization
nttcom
1
210
「手を動かした者だけが世界を変える」ソフトウェア開発だけではない開発者人生
onishi
15
7.6k
地域コミュニティへの「感謝」と「恩返し」 / 20250726jawsug-tochigi
kasacchiful
0
100
ファインディにおける Dataform ブランチ戦略
hiracky16
0
210
Vision Language Modelと自動運転AIの最前線_20250730
yuyamaguchi
1
600
生成AIを活用した野球データ分析 - メジャーリーグ編 / Baseball Analytics for Gen AI
shinyorke
PRO
1
230
M365アカウント侵害時の初動対応
lhazy
7
5.1k
KCD Lima: eBee in Peru!
lizrice
0
110
alecthomas/kong はいいぞ
fujiwara3
6
1.1k
P2P ではじめる WebRTC のつまづきどころ
tnoho
1
270
Featured
See All Featured
A better future with KSS
kneath
238
17k
実際に使うSQLの書き方 徹底解説 / pgcon21j-tutorial
soudai
PRO
181
54k
Navigating Team Friction
lara
187
15k
"I'm Feeling Lucky" - Building Great Search Experiences for Today's Users (#IAC19)
danielanewman
229
22k
Templates, Plugins, & Blocks: Oh My! Creating the theme that thinks of everything
marktimemedia
31
2.4k
Helping Users Find Their Own Way: Creating Modern Search Experiences
danielanewman
29
2.8k
Typedesign – Prime Four
hannesfritz
42
2.7k
ReactJS: Keep Simple. Everything can be a component!
pedronauck
667
120k
Scaling GitHub
holman
461
140k
Six Lessons from altMBA
skipperchong
28
3.9k
Unsuck your backbone
ammeep
671
58k
CSS Pre-Processors: Stylus, Less & Sass
bermonpainter
357
30k
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 !