株式会社リンカーズさんの社内勉強会で発表したLTのスライドです
υΩϡϝϯτΛमਖ਼͢Δ@willnet
View Slide
ීஈͷ։ൃɺͳΜΒ͔ͷυΩϡϝϯτΛݟͳ͕Β։ൃ͠·͢ΑͶ
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
ΔΓ·ຊޠͰPullRequestIssueͩͯ͠େৎͦ͏
ฤू༰Λ֬ೝ͢Δํ๏• 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 !