Upgrade to Pro — share decks privately, control downloads, hide ads and more …

Make Rails Documents SEO(Search Engine Optimized)

toshimaru
February 22, 2019

Make Rails Documents SEO(Search Engine Optimized)

Roppongi.rb #8 での発表資料です。
https://roppongirb.connpass.com/event/118218/

Blog: https://blog.toshimaru.net/make-rails-documents-seo-search-engine-optimized/

現在αバージョンとして公開している railsdoc.github.io を紹介しています。
https://railsdoc.github.io/

toshimaru

February 22, 2019
Tweet

More Decks by toshimaru

Other Decks in Technology

Transcript

  1. Make Rails Documents
    SEO(Search Engine Op9mized)
    2019/02/22 Roppongi.rb #8
    Roppongi.rb #8 1

    View Slide

  2. self-introduc.on
    • toshimaru
    • Roppongi.rb چ? Organizer
    • Rails Engineer / Engineer Manager
    Roppongi.rb #8 2

    View Slide

  3. ࿩͢͜ͱ
    • ެ͕ࣜఏڙ͍ͯ͠ΔRailsυΩϡϝϯτͷSEOʹ͍ͭͯ
    ࿩͞ͳ͍͜ͱ
    • ҰൠతͳRailsΞϓϦέʔγϣϯͷSEOʹ͍ͭͯ
    • SEOͷͨΊͷࡉ͔͍ςΫχΧϧͳ࿩
    Roppongi.rb #8 3

    View Slide

  4. ಥવͰ͕͢
    ͜Μͳܦݧ͸͋Γ·ͤΜ͔ʁ
    Roppongi.rb #8 4

    View Slide

  5. ʮAc#veRecordͷupdateϝιου
    Ͳ͏࢖͏Μ͚ͩͬʯ
    Roppongi.rb #8 5

    View Slide

  6. ʮάάΔ͔ʯ
    Roppongi.rb #8 6

    View Slide

  7. Roppongi.rb #8 7

    View Slide

  8. Roppongi.rb #8 8

    View Slide

  9. Roppongi.rb #8 9

    View Slide

  10. Roppongi.rb #8 10

    View Slide

  11. Roppongi.rb #8 11

    View Slide

  12. !
    Roppongi.rb #8 12

    View Slide

  13. SEOŧŔŕŪũƄŝſ WEBŚƃŢƄŬźͱͯ͠ɺ
    Rails ؔ࿈ͷݕࡧΫΤϦͰ
    ࠷దͳ݁Ռ͕ฦΔੈքʹ͍ͨ͠ɻ
    Roppongi.rb #8 13

    View Slide

  14. ࠷దͳ݁Ռ
    • OfficialʢެࣜͰ͋Δʣ
    • Accurateʢਖ਼֬Ͱ͋Δʣ
    • Latestʢ࠷৽Ͱ͋Δʣ
    Roppongi.rb #8 14

    View Slide

  15. Rails Official Documents?
    Roppongi.rb #8 15

    View Slide

  16. Let's see rubyonrails.org
    Roppongi.rb #8 16

    View Slide

  17. Roppongi.rb #8 17

    View Slide

  18. Roppongi.rb #8 18

    View Slide

  19. Rails Documents
    1. rubyonrails.org
    2. weblog.rubyonrails.org
    3. guides.rubyonrails.org
    4. api.rubyonrails.org
    Roppongi.rb #8 19

    View Slide

  20. weblog.rubyonrails.org
    Roppongi.rb #8 20

    View Slide

  21. Roppongi.rb #8 21

    View Slide

  22. weblog.rubyonrails.org
    • Jekyllʹͯߏங
    • ྑ͍ײ͡ʹSEO͢Δjekyll-seo-tagΛಋೖ
    • ͦͷଞjekyll-feed, jekyll-sitemapΛαΠτʹ௥Ճ
    Roppongi.rb #8 22

    View Slide

  23. rubyonrails.org
    Roppongi.rb #8 23

    View Slide

  24. Roppongi.rb #8 24

    View Slide

  25. rubyonrails.org
    • Jekyllʹͯߏங
    • ྑ͍ײ͡ʹSEO͢Δjekyll-seo-tagΛಋೖ (thanks to @benbalter)
    Roppongi.rb #8 25

    View Slide

  26. guides.rubyonrails.org
    Roppongi.rb #8 26

    View Slide

  27. Roppongi.rb #8 27

    View Slide

  28. guides.rubyonrails.org
    • SNSදࣔରࡦͱͯ͠ϕʔγοΫͳOGPΛઃఆ
    • ಠࣗʹRailsΨΠυΛੜ੒͍ͯ͠Δʢnot JekyllʣͨΊࡉ͔ͳSEO
    νϡʔχϯά·Ͱ͸΍͍ͬͯͳ͍...
    Roppongi.rb #8 28

    View Slide

  29. api.rubyonrails.org
    Roppongi.rb #8 29

    View Slide

  30. ಥવͷϝϯγϣϯ!!!1
    1 h$ps:/
    /github.com/rails/rails/issues/27633
    Roppongi.rb #8 30

    View Slide

  31. !
    Roppongi.rb #8 31

    View Slide

  32. How to Generate Site
    • rake rdoc ίϚϯυͰυΩϡϝϯτ
    ੜ੒
    • ੒Ռ෺͸ doc/rdoc ʹు͔ΕΔ
    • υΩϡϝϯτੜ੒ʹ͸ sdoc gem͕࢖
    ΘΕ͍ͯΔ
    $ cd rails
    $ rake rdoc
    Roppongi.rb #8 32

    View Slide

  33. sdoc͕ు͘HTMLΛ
    ΠδΕ͹ྑͦ͞͏
    Roppongi.rb #8 33

    View Slide

  34. ΠδͬͯΈͨ
    ! "#
    Roppongi.rb #8 34

    View Slide

  35. அ೦...
    Roppongi.rb #8 35

    View Slide

  36. sdocਏ͍ͱ͜Ζ
    • ΞΫςΟϒʹϝϯς͞Εͯͳ͍
    • iframeʹΑΔϨΠΞ΢τ: URLͰγΣΞ͠΍͘͢͢ΔͨΊʹϨΠ
    Ξ΢τΛ౷߹͍͕ͤͨ͞େ͖ͳมߋ͕ඞཁ
    • ݹΊ͔͍͠Rubyίʔυϕʔε: travis.ymlʹRuby1.9.3ͷจࣈ
    • RailsҎ֎ͷීวతͳϢʔεέʔεΛ૝ఆ͍ͯ͠ΔͷͰഁյతม
    ߋ͕Ճ͑ʹ͍͘
    Roppongi.rb #8 36

    View Slide

  37. ιϦϡʔγϣϯ
    sdocΛfolkͯ͠৽͍͠αΠτΛߏங
    Roppongi.rb #8 37

    View Slide

  38. ࡞ͬͯΈͨ
    Roppongi.rb #8 38

    View Slide

  39. Roppongi.rb #8 39

    View Slide

  40. railsdoc.github.io
    Roppongi.rb #8 40

    View Slide

  41. railsdoc.github.io
    • α(Alpha)όʔδϣϯͱ࣮ͯ͠ݧతʹެ։த
    • jekyllͰߏஙͯ͠GitHub PagesͰެ։
    • folk൛sdoc͕jekyllͷsourceͱͳΔHTMLΛు͘ߏ଄
    Roppongi.rb #8 41

    View Slide

  42. ݱঢ়
    • ·ͩίʔυϕʔε੔උத
    !
    ʢະ࣮૷෦෼͕ଟ͋͘Γ·͢ʣ
    • Pull Request is not very welcomed
    • Feature Request is welcomed
    #
    • Կ͔ϦΫΤετ͋Ε͹ΠγϡʔʹͲ͏ͧ
    • URL: github.com/railsdoc/railsdoc.github.io
    Roppongi.rb #8 42

    View Slide

  43. ࠓޙʢߏ૝ʣ
    • folk൛sdoc͡Όͳ͍ಠࣗͷυΩϡϝϯτੜ੒gemΛ࡞Γ͍ͨ
    • Ͳ͏͏·͘railsͱΠϯςάϨʔγϣϯͤ͞Δ͔͕՝୊
    • railsଆͰ࣋ͬͯΔAPIυΩϡϝϯτੜ੒ͷϏδωεϩδοΫΛണ
    ͕͍ͨ͠
    Roppongi.rb #8 43

    View Slide

  44. ·ͱΊ
    document SEO build
    rubyonrails.org ̋ jekyll
    weblog.rubyonrails.org ̋ jekyll
    guides.rubyonrails.org ˚ Railsಠࣗ
    api.rubyonrails.org ✕ Railsಠࣗ
    railsdoc.github.io ?ʢ͕Μ͹Γ·͢!ʣ jekyll
    Roppongi.rb #8 44

    View Slide

  45. Thank You!
    Roppongi.rb #8 45

    View Slide