OSS Gate Workshop: online: 2023-12-09: niikz: rurema: Work log

[niikz]

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の開発に参加しましょう！
• シナリオ：ワークショップの目的・内容・進め方の詳細が書いています。
• 過去のビギナーの作業ログ：他の人の作業ログから学べることがいろいろあるはずです。

[niikz]

るりまのリンク切れを修正したい

• https://docs.ruby-lang.org/ja/latest/method/Gem=3a=3aGemPathSearcher/i/find_all.html

[niikz]

りんく切れを確認しました

• https://docs.ruby-lang.org/ja/latest/method/Array/i/find_all.html

[niikz]

OSSか確認する

• https://github.com/rurema/doctree

[niikz]

ライセンスがぱっと見わからなかったので以下を確認する

• https://github.com/rurema/doctree/wiki

[niikz]

ライセンスのページ

• https://github.com/rurema/doctree/wiki/License

[niikz]

ライセンスを確認しました

Creative Commons — Attribution 3.0 Unported

• https://github.com/rurema/doctree/blob/master/refm/doc/license.rd

[niikz]

GitHub上のdoctreeのリポジトリで確認できるとうれしい

• https://github.com/rurema/doctree

[niikz]

OSSか確認する

• https://opensource.org/licenses/

[niikz]

Creative Commons — Attribution 3.0 Unported で検索するとヒットしない

• https://opensource.org/licenses/?ls=Creative+Commons+%E2%80%94+Attribution+3.0+Unported

[niikz]

Creative Commons で検索してもヒットしなかった

• https://opensource.org/?s=Creative+Commons

[niikz]

bitclust のライセンスを確認しました

License
-------

  Ruby License.

• https://github.com/rurema/bitclust/blob/master/README

[niikz]

Creative Commons なのでオープンソースの文書に該当すると思われる
あとで確認！

• https://creativecommons.org/licenses/by/3.0/

[otegami]

A Creative Commons (CC) license is one of several public copyright licenses that enable the free distribution of an otherwise copyrighted "work".

https://en.wikipedia.org/wiki/Creative_Commons_license

[niikz]

Ruby License を検索してみる

[niikz]

オープンソースと判断してもよさそう

Rubyライセンス（Ruby’s License[3]、License of Ruby[2][注釈 1]）とは、プログラミング言語Rubyがその頒布物に適用するソフトウェアライセンスであり、オープンソースライセンスの一つである。その他関連するプロジェクトをはじめ、採用されているケースもある。

• https://www.ruby-lang.org/en/about/license.txt
• https://ja.wikipedia.org/wiki/Ruby%E3%83%A9%E3%82%A4%E3%82%BB%E3%83%B3%E3%82%B9

[niikz]

どっちの対応をするか

1. 手元でリンクを修正する
2. 間違っていることをお知らせする

[niikz]

1. 手元でリンクを修正する にチャレンジしてみます

[niikz]

コントリビュートの方法を確認する

• https://github.com/rurema/doctree/wiki/HowToContribute

[niikz]

プロジェクトに参加する必要がありそう

[niikz]

参加資格は、日本語が話せたらたぶんOK

• https://github.com/rurema/doctree/wiki/HowToJoin

[niikz]

ruby-reference-manual メーリングリストに参加する必要がありそう

• https://github.com/rurema/doctree/wiki/MailingList

[niikz]

メーリングリストは消滅したそうです

QuickML の仕様により、長期間が投稿がなかったため消滅しました。

メーリングリストに参加しなくてもいいかも

• https://maimux2x.hatenablog.com/entry/2023/03/07/004429
• https://imaizumimr.hatenablog.com/entry/2020/12/02/235121

[niikz]

Issueを登録してみよう

[niikz]

Issueを登録する際は、最新版で修正済かどうか確認する

[niikz]

doctreeのリポジトリ上でGemPathSearcherを検索

• https://github.com/search?q=repo%3Arurema%2Fdoctree+GemPathSearcher&type=code

[niikz]

📝 ふりかえりメモ

ドキュメントのコード自体はMITのことが多いのでたぶん大丈夫と思われます！

[niikz]

以下ファイルに記載がありそう

• https://github.com/rurema/doctree/blob/91fa497b3fdaefc76db15c5d51741de99008d359/refm/api/src/rubygems/gem_path_searcher.rd

[niikz]

最終更新日が11年前なので現在のファイルが最新であってそう

Commits on Sep 29, 2012

• https://github.com/rurema/doctree/commits/91fa497b3fdaefc76db15c5d51741de99008d359/refm/api/src/rubygems/gem_path_searcher.rd

[otegami]

実際にリンク切れを Issue で報告している人がいそう

• 外部リンクへのリンク切れ rurema/doctree#2849

[niikz]

https://docs.ruby-lang.org/ja/latest/class/Gem=3a=3aGemPathSearcher.html#I_FIND の Array#find もリンクが切れてしまっている

• https://docs.ruby-lang.org/ja/latest/method/Array/i/find.html

[niikz]

できそうだったら動画ものせてあげると親切

[niikz]

#1746 (comment) の文章を修正しました。
動画はサイズが大きかったのでスクリーンショットの画像を添付しています。

---

概要

Gem::GemPathSearcherクラスのページにリンク切れがありました。
https://docs.ruby-lang.org/ja/latest/class/Gem=3a=3aGemPathSearcher.html

• https://docs.ruby-lang.org/ja/latest/class/Gem=3a=3aGemPathSearcher.html#I_FIND
  • [SEE_ALSO] Array#findのリンク
• https://docs.ruby-lang.org/ja/latest/class/Gem=3a=3aGemPathSearcher.html#I_FIND_ALL
  • [SEE_ALSO] Array#find_all のリンク

期待される振る舞い

• https://docs.ruby-lang.org/ja/latest/class/Gem=3a=3aGemPathSearcher.html#I_FIND

  • Array#findのリンクは以下に修正するとよさそうです。
    https://docs.ruby-lang.org/ja/latest/method/Enumerable/i/detect.html

• https://docs.ruby-lang.org/ja/latest/class/Gem=3a=3aGemPathSearcher.html#I_FIND_ALL

  • Array#find_allのリンクは以下に修正するとよさそうです。
    https://docs.ruby-lang.org/ja/latest/method/Enumerable/i/filter.html

スクリーンショット

[niikz]

Issueを登録しました

• GemPathSearcherクラスのSEE_ALSOのリンク切れがありました。 rurema/doctree#2852

[niikz]

まずはForkする

• https://github.com/rurema/doctree

[niikz]

Forkできました

• https://github.com/niikz/doctree

[niikz]

Tutorialにそってcloneする

• https://github.com/rurema/doctree/wiki/Tutorial

[niikz]

refm/api/src/rubygems/gem_path_searcher.rd を修正する

• https://github.com/rurema/doctree/blob/91fa497b3fdaefc76db15c5d51741de99008d359/refm/api/src/rubygems/gem_path_searcher.rd#L15
• https://github.com/rurema/doctree/blob/91fa497b3fdaefc76db15c5d51741de99008d359/refm/api/src/rubygems/gem_path_searcher.rd#L21

[otegami]

下記に全体をプレビューできる方法がありそうです。
https://github.com/rurema/doctree/wiki/Tutorial

[niikz]

修正できました！

[niikz]

バージョンはなにを指定したらいいのだろう🤔

データベースのディレクトリ名は、ここではdb-2.5.0/としましたが、好きな名前を付けて構いません。
2.3.0や2.4.0など、Rubyの他のバージョンのリファレンスをプレビューしたい場合は、versionを変えて上記の手順を繰り返して下さい。

[otegami]

データベースのディレクトリ名は、ここではdb-2.5.0/としましたが、好きな名前を付けて構いません。

ここから見るに本当になんでも大丈夫そうな気がします🙌
あえて決めるならば現状だと、db-3.2 にしてあげると良さそうかなと思いました。

• Ruby 3.2 のリファレンスなため

[github-actions]

おつかれさまでした！

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

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

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

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

[niikz]

3.2.0 を指定してみる

$ bitclust -d ./db-3.2.0 init version=3.2.0 encoding=UTF-8
$ bitclust -d ./db-3.2.0 update --stdlibtree=refm/api/src
$ bitclust server --database=db-3.2.0 --debug

[niikz]

もしかしたら動作していないかも…

$ bitclust server --database=db-2.5.0 --debug ※状況確認中。動作しません。

[niikz]

全体プレビューではなくて、htmlファイルとして出力してみる

$ bitclust htmlfile ./refm/api/src/_builtin/Array --target=Array#pop --ruby=2.5.0 > /tmp/Array_pop.html

[niikz]

Gem::GemPathSearcher#find_all を出力する
バージョンは3.2.0を指定

$ bitclust htmlfile ./refm/api/src/rubygems/gem_path_searcher.rd --target=Gem::GemPathSearcher#find_all --ruby=3.2.0 > /tmp/GemPathSearcher_find_all.html

[niikz]

[SEE_ALSO]をEnumerable#filter へ変更できました

[niikz]

Gem::GemPathSearcher#find を出力する
バージョンは3.2.0を指定

$ bitclust htmlfile ./refm/api/src/rubygems/gem_path_searcher.rd --target=Gem::GemPathSearcher#find --ruby=3.2.0 > /tmp/GemPathSearcher_find.html

[niikz]

[SEE_ALSO]をEnumerable#detect へ変更できました

[niikz]

変更を確認できたのでPRをつくってみます
※リンク先は未確認

[niikz]

ブランチを作成

$ git switch -c fix-gempathsearcher-link

[niikz]

commitする

[niikz]

PRの文章を作成する

---

https://docs.ruby-lang.org/ja/latest/class/Gem=3a=3aGemPathSearcher.html#I_FIND
https://docs.ruby-lang.org/ja/latest/class/Gem=3a=3aGemPathSearcher.html#I_FIND_ALL

[SEE_ALSO]のリンクが切れていたため修正しました。

[niikz]

pushする

[niikz]

Compare & pull request でPRを作成する

[niikz]

PR送りました！！！

[otegami]

お疲れ様です！ 👏
rurema/doctree#2853