18
14

Delete article

Deleted articles cannot be recovered.

Draft of this article would be also deleted.

Are you sure you want to delete this article?

More than 5 years have passed since last update.

RubyAdvent Calendar 2017

Day 3

Ruby のドキュメントの改善に参加しよう

Last updated at Posted at 2017-12-02

Ruby の情報を調べていて、一次情報なのに情報が古かったり間違っていることに気づくことがあるかもしれません。
そういうときは是非 github の issue で報告したり、自分でも直せそうな些細な変更なら気軽に pull request したりしてみてください。

ここでは、そんな貢献を絶賛募集中の公式なドキュメントなどを紹介します。

リファレンスマニュアル

公式なリファレンスマニュアルの日本語版の プログラミング言語 Ruby リファレンスマニュアルリファレンスマニュアル刷新計画 (通称るりま) というプロジェクトで管理されています。

内容のソースは Repository of Japanese Ruby reference manual にあります。

書式は RD (Ruby Document) をベースとした独自記法で、HTML などを生成するツールは bitclust です。

docs.ruby-lang.org というサイト自体のソースは Source of the docs.ruby-lang.org site にあります。

るりまサーチ (全文検索) は、何かあれば upstream の A Web search interface for Ruby reference manual in Japanese に報告すると良いと思います。
docs 独自の問題をみつけたようなら ruby/rurema-search の方でも良いと思います。

英語の方 は ruby 本体の rdoc なので、 https://github.com/ruby/ruby に pull request を送ると良いと思います。単純な typo 修正などなら pull request のみでも取り込まれる可能性がありますが、正式には Ruby Issue Tracking System の方にチケットを作ることになっているので、議論が必要な場合には bugs.ruby-lang.org の方にチケットを作ってください。

www.ruby-lang.org

https://www.ruby-lang.org/このウェブサイトについてに書いてあるように ruby/www.ruby-lang.org にソースがあります。

News Post Translation Status に記事の翻訳状況があるので、翻訳を手伝うのもオススメです。(URL に admin と入っていますが、 Jekyll による静的サイトなので、管理者にしか見えてはいけないような情報はなく、公開情報です。)

Rubyist Magazine

『Rubyist Magazine』、略して『るびま』というウェブ雑誌があります。
日本 Ruby の会の有志によるプロジェクトで、地域Ruby会議レポートを書く場所になっているなど準公式的な場所になっていると思います。

FAQ に書いてあるように、サポート用リポジトリがあるので、何かあれば issue を書くか FAQ に書いてあるアドレス宛にメールを送ると良いと思います。
typo の指摘や間違いの指摘などから記事を書きたいとか編集に参加したいとかまで幅広く募集中です。

rubima/rubima の方は編集部用となっていますが、 support 向けの内容だったとしても気にせず対応してもらえるので、 issue を作成する場所を間違えたとしても気にしなくて良いと思います。

編集者は足りていないので、単にリリース前の記事をいち早く読みたい、というだけでも編集部に入ってもらって、ただ読むだけ (で、わかりにくいところや間違いなどに気づけば報告して、何も気づかなければ本当に読むだけ) でも助かると思います。

まとめ

自分の blog に記事を書いたり、 Qiita に書いたりするのも、情報が増えて良いことなのですが、一次情報が充実することも重要なので、貢献できそうなことがあれば、些細な typo の指摘からでも、よろしくお願いします。

よくわからなくて参加しにくいという人は OSS Gate というイベントに参加して見るところから初めてみるのもおすすめです。

18
14
0

Register as a new user and use Qiita more conveniently

  1. You get articles that match your needs
  2. You can efficiently read back useful information
  3. You can use dark theme
What you can do with signing up
18
14

Delete article

Deleted articles cannot be recovered.

Draft of this article would be also deleted.

Are you sure you want to delete this article?