OSS Gate Workshop: online: 2023-12-09: Angy-h: Railsガイド: Work log

[Angy-h]

This is a work log of a "OSS Gate workshop".
"OSS Gate workshop" is an activity to increase OSS developers.
Here's been discussed in Japanese. Thanks.

作業ログ作成時の説明

以下のテンプレートを埋めてタイトルに設定します。埋め方例はスクロールすると見えてきます。

OSS Gate Workshop: ${LOCATION}: ${YEAR}-${MONTH}-${DAY}: ${ACCOUNT_NAME}: ${OSS_NAME}: Work log

タイトル例↓：

OSS Gate Workshop: Tokyo: 2017-01-16: kou: Rabbit: Work log

OSS Gateワークショップ関連情報

• スライド：ワークショップの進行に使っているスライドがあります。
• チャット：OSS開発に関することならなんでも相談できます。ワークショップが終わった後もオンラインで相談しながら継続的にOSSの開発に参加しましょう！
• シナリオ：ワークショップの目的・内容・進め方の詳細が書いています。
• 過去のビギナーの作業ログ：他の人の作業ログから学べることがいろいろあるはずです。

[Angy-h]

Railsのガイドで始めたいと思います。
https://railsguides.jp/getting_started.html#%E3%83%A2%E3%83%87%E3%83%AB%E3%82%92%E7%94%A8%E3%81%84%E3%81%A6%E3%83%87%E3%83%BC%E3%82%BF%E3%83%99%E3%83%BC%E3%82%B9%E3%81%A8%E3%82%84%E3%82%8A%E3%81%A8%E3%82%8A%E3%81%99%E3%82%8B

[Angy-h]

ライセンスについて確認すると、次の通りでした（GitHubのReadMeより）。
https://github.com/yasslab/railsguides.jp
コンテンツ部分は、クリエイティブ・コモンズ 表示-継承 4.0 国際 (CC BY-SA 4.0)でした。
ソースコードは、MIT ライセンスでした。

[Angy-h]

Railsガイドの「Rails をはじめよう」の3.1 Railsのインストールの項目のところで、（Macを使用）
Rubyのバージョンを確認し古いバージョンだったので、最新のRubyをインストールした（$ brew install ruby）。しかし、$ ruby -vで確認しても古いバージョンのままで、インストール済みの最新版が使用できるようにならず、ガイドの先に進めなかったので困りました。
使用できるようになるには、.zshrcを書き換える必要があったみたいで（ChatGPT等を参照）、
初心者には、そこまで考慮は及ばなかったのでRailsを開始するまでにハードルが高いと感じました。

[Angy-h]

8.4 「コントローラを生成する」のところで、
表示されている成果物の中に、解説がついていない箇所がありました。
成果物には、Edid | Backのリンクがついていますが、解説にはなく、Localhostを使用しているので、HTMLでどのようなリンクをつけて良いか、わかりませんでした。

[Angy-h]

Railsガイドのフィードバックで、Rubyのインストールでつまづきました。
「OS環境ごとのインストール方法について詳しくは、ruby-lang.orgを参照してください。」という記述はありましたが、初心者にとっては内容が難しく、パソコン環境によって必要な作業が異なってくるような説明があった方がいいと思いました。

[Angy-h]

Railsガイドのリポジトリに行きました。
https://github.com/yasslab/railsguides.jp

[Angy-h]

Railガイドの手順通りに進めても、8.4 「コントローラを生成する」の成果物と同じものができませんでした。違いは、Edid | Backのリンクが付けられませんでした。
この点を報告します。

[Angy-h]

8.4では、下記のような成果物が期待されている。

実際の成果物は次のようなものになりました。

[Angy-h]

issueを書きます。

[Angy-h]

タイトル

RailガイドのRails をはじめようの8.4「コントローラを生成する」について

やったこと

このパートの内容を手順通りに進めました。

期待する結果

8.4の終わりに次のような成果物が示されていました。

実際の結果

次のような結果となりました。

フィードバック

Edid | Backのリンクを付けるための手順の記載がないようでした。
示されている成果物と同じ結果にならないようでしたので、ご報告させていただきます。

[otegami]

rurema/doctree#2852

[otegami]

期待する結果	実際の結果

[Angy-h]

タイトル

RailガイドのRails をはじめようの8.4「コントローラを生成する」について

Railsガイドを利用して、学習させていただいています。いつもありがとうございます。

フィードバック

Edid | Backのリンクを付けるための手順の記載がないようでした。
示されている成果物と同じ結果にならないようでしたので、ご報告させていただきます。

再現方法

RailガイドのRails をはじめようの8.4 コントローラを生成する」のパートの内容を手順通りに進めました。

期待する結果	実際の結果

[daipom]

yasslab/railsguides.jp#1550

[otegami]

ふりかえり会であったコメント

• 原著側の修正にあたるのではないか？ その場合は、https://github.com/rails/rails 側に Issue を立ててあげると良さそう

気付いてあげられず申し訳ないです🙏

[github-actions]

おつかれさまでした！

ワークショップの終了にともないissueを閉じますが、このまま作業メモとして使っても構いません 👌

ワークショップの感想を集めています！

ブログなどに書かれた際は、このページへリンクの追加をお願いします 🙏

またの参加をお待ちしています！

[kou]

https://matrix.to/#/!gHIZhKRtDtemauVGiE:gitter.im/$9jXXJJ3M9Waui5GFnfKA6JGesTpOWchs_Czbj-op9Wg?via=gitter.im&via=matrix.org の続き。

こんにちは。先日OSS GATEのワークショップでお世話になりましたAngy-hです。Railsガイドに画像の相違についてフィードバックを送りました。
その後yasulabさんから該当部分の画像を差し替えるプルリクエストを送ってもらえるようにというお返事がありました。英語版にも送るとマージされる可能性にあるとのことでした。
Railsガイドの「3 Railsのドキュメントに貢献する」というページを見たりしましたが、私一人では、プルリクエストを送るのは難しそうです。

[kou]

Railsガイドの「3 Railsのドキュメントに貢献する」というページ

このページのURLを教えてもらえますか？どんな内容なのかを知りたいです！

[kou]

すでにやったこと：

https://matrix.to/#/!gHIZhKRtDtemauVGiE:gitter.im/$GZKcQtSPApkrzIwLIbHkKCYR4IY4AHTYIdjY-pBr4Yo?via=gitter.im&via=matrix.org

• 再度、RailガイドのRails をはじめようの8.4 コントローラを生成する」のパートの内容を手順通りに進めて、画像を撮り直す。
• 同時に、出来たblogの成果物（blogフォルダとコード）を残しておく。
• 現状のimageと撮り直した写真を照合し、ガイドの内容を再確認、相違点に赤色で印をつける。

[Angy-h]

返信が遅くなり大変申し訳ございません！
Railsガイドの「3 Railsのドキュメントに貢献する」というページのリンクは、下記でございます。
Railsガイド - Railsのドキュメントに貢献する
大変申し訳ございませんでした。これからまめにチェックするようにいたします。

[kou]

@Angy-h あざっす。

ということは、やることは↓ですね。

英語ドキュメントに貢献したい方は、Railsガイドの英語ソースファイルを変更してから、プルリクエストでmainブランチに変更の反映を依頼してください。 ドキュメント変更のプルリクエストでは、CIビルドの実行を避けるため、プルリクエストのタイトルに[ci skip]を含めてください。

タスクに分けるとこうですね。

1. Railsガイドの英語ソースファイルを変更する
2. プルリクエストでmainブランチに変更の反映を依頼する
3. ドキュメント変更のプルリクエストでは、CIビルドの実行を避けるため、プルリクエストのタイトルに[ci skip]を含める

いままでプルリクエストは作ったことはありますか？

あるなら、そのときと同じように1.をやってみてつまづいたところを教えてください。サポートします。

ないならどうやって1.をやるか説明します。

[kou]

@Angy-h 続きは yasslab/railsguides.jp#1550 で！

[Angy-h]

承知いたしました。yasslab/railsguides.jp#1550 の方を拝見させていただきます。

[kou]

最終的に rails/rails#50756 としてプルリクエストしてマージされた。