3
0

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.

Rails Girls JapanAdvent Calendar 2018

Day 14

Rails Girlsのドキュメントについて

Last updated at Posted at 2018-12-14

導入

あなたはRails Girlsのガイドを見たことがあるでしょうか。これ、実によくできているんですが、ドキュメントの保守はどこでも大変です。では、Rails Girlsではどうやってドキュメントを保守しているのでしょうか。また、ドキュメントの中身はどうなっているのでしょうか。

本題

管理

ドキュメントはGitHub上のレポジトリで管理されています。
コントリビューターの数を見ると、本稿執筆時点(2018/12/14)で67名がコントリビュートしており、チュートリアルのみのドキュメントとしてはかなり多くの人が関わっているプロジェクトだと思います。

内容

Rails Girls本編でカバーしている内容以外にも、かなり豊富な内容が盛り込まれています。例えば、Deviseに関する章があったり、RSpecに関する章もあったりします。
これらがどういうときに使われるかというと、イベント後の自習やフォローアップ(More)の題材に使われたりします。
なお、日本語版独自の内容というのはなく、すべて本家の翻訳版となっています。

実装

ドキュメントサイトはJekyllという静的サイトジェネレーターを使って構築されています。
環境構築は通常のRubyプロジェクトと同様にcloneした後bundle installすれば終了です。

更新

更新は通常のOSSと同様にプルリクエストを通じて行われます。
修正したい箇所に該当するmarkdownファイルを見つけ、編集してコミットし、プルリクエストを送ってマージされれば変更が反映されます。バージョンなどはなく、マージされれば即座にデプロイされます。いいですね!
コミットの頻度は極端に多いときと少ないときがあります、これはRails Girlsの本編が開かれるタイミングで打ち合わせをし、その中で見つけた修正点をその場か翌日程度のタイミングで直すことが多いためです。

問題点

このように、基本的にはイベント本編と歩調をあわせて更新されるドキュメントですが、内容の節で紹介したRSpecの章が訳されていないことからもわかるとおり、決して完璧にメンテナンスされているわけではありません。
記述されているRubyやライブラリのバージョンを最新に保つことはできていますが、大掛かりな修正まではなかなか手が回らないのが現状です。
特に現在悩みのタネとなっているのがWindowsへの対応です。

WindowsかCloud9か

そもそも、Ruby開発者の圧倒的多数はMacかLinuxを使っているため、Windowsマシンを持参する参加者に対しては、Windowsの使用経験がある少数のコーチがつく必要がありました。また、RubyInstallerが古いなどの問題で他の環境と条件を揃えることも困難な場合がありました。
そのため、最近はCloud9というクラウド上で動くIDEを使ってもらうケースが増えました。クラウドではLinuxが動くため、WindowsにRubyをインストールする必要もなく、最新のRubyを使うことも容易であるというのが利点でした。

Cloud9のアカウント問題

そこで、最近のRails GirlsではCloud9を利用してもらうことを推奨していました。しかし、全国のRails Girlsでオーガニゼーションを統一した結果、アカウント数が上限に達してしまっていました。

WSL

そこで、最新のWindows上で動作するWSL (Windows Subsystem for Linux)を利用してもらう方向に切り替えようとしているのが現時点の状況となります。
WSLについての説明は省きますが、要はWindows上でLinuxが直接動くし、エディタはWindowsネイティブなものを使えるし、もうこれでいいのではという感じです。

WSLに対応したドキュメントの作成

WSLに関しては、常用しているコーチがあまりおらず、ドキュメントも手付かずのままとなっています。
次回のRails Girlsの開催が迫る中、限られた時間でドキュメントの作成を行わなくてはなりません。

Want help!

この記事をここまで読んでくれたそこのあなた!私達と一緒にドキュメント作成に参加しませんか?
@okuramasafumi までご連絡ください!(Twitterでも同じIDです)

3
0
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
3
0

Delete article

Deleted articles cannot be recovered.

Draft of this article would be also deleted.

Are you sure you want to delete this article?