Add feedback link to footer

[pocke]

https://github.com/rurema/doctree へのリンクをフッターに追加します。

目的

「るりまの間違いを見つけたけどどこにPull Requestをしたらいいかわからない…」という人を減らすために、各ページのフッタにGitHubリポジトリへのリンクを追加します。
これによってるりまのドキュメントを書いてくれる人が増えたら嬉しいなと思っています。

実際にフィードバック先がわからないという例もあるようでした。

そういえば、フィードバック先がわからないという声を聞いたことがあり、とても良いアイデアに思えました！
https://mobile.twitter.com/koic/status/1120974955238137856

表示方法

現在はシンプルに、「フィードバックはこちら」とだけ表示しています。

最初はRails Guideを参考に少し長い文を書いていたのですが、ちょっと違和感があったので短くしました。

文字は書かずにGitHubのアイコンだけをライセンス表示と並べるのもありかなと思ったのですが、画像をどう配置したらいいかがよくわからなかったので試していません。

どう表示するかは結構議論の余地があるところだと思うので、アドバイスをもらえたら嬉しいです。
あまりデザイン力がないのでいい感じのスタイルをあててもらえたりするととても助かります…！

[znz]

リンク先は https://github.com/rurema/doctree/issues/new にして issue template を充実させると良いかもしれないと思いました。

デザインは他のフィードバック先リンクが付いているサイトを参考にすると良さそうです。

[sho-h]

確かにと思いましたので賛成です。1回取り込んでしまっちゃうのがいいですかねぇ。(他力本願ですが、ほかの方も手を出しやすくなりますし。

[pocke]

早速コメントありがとうございます！！🙏

リンク先は https://github.com/rurema/doctree/issues/new にして issue template を充実させると良いかもしれないと思いました。

Issue templateを充実させるのもありですね。。その場合Pull Requestを送りたい人への誘導もほしいかなと思っています。

デザインは他のフィードバック先リンクが付いているサイトを参考にすると良さそうです。

https://github.blog/2008-12-19-github-ribbons/ "Fork me on GitHub"リボンは時々他のリポジトリで見るのですが、ちょっと雰囲気が違うかなと思っています。。
他に良い例があったらコメントしますね

1回取り込んでしまっちゃうのがいいですかねぇ。(他力本願ですが、ほかの方も手を出しやすくなりますし。

現状でも最低限の案内にはなっていると思いますし、取り込むのもありだと思います。
取り込むのであれば、数日待って他に案がなかったら取り込む、とかがよいのかなと思っています。

[pocke]

ちなみに https://docs.ruby-lang.org/ja/latest/doc/help.html に「お問い合わせ」としてGitHubへのリンクはありますが、このページをうまく見つけるのも大変なので、やはりフッターにリンクがあったほうが嬉しいかなと思っています。

[znz]

思い浮かべたののは、

• https://jp.vuejs.org/v2/guide/ の フッターの「間違いを見つけた、またはドキュメントに貢献したいですか？ GitHub 上でこのページを編集する か、GitHub からこのサイトを Fork してプルリクエストしましょう ！」
• https://docs.docker.com/ の右上の「Edit this page」,「Request docs changes」

などのように個別ページのソースへのリンクがあるので、ページごとに違うリンクを埋め込めるとよりよくなりそうです。

他には以下のようなサイトも参考になりそうです。

• php.net の右上の「Edit」, 「Report a Bug」 (末尾の「add a note」はコメントを埋め込めるのでちょっと用途が違ってそう)
• MDN はフッターの「フィードバック」から https://developer.mozilla.org/ja/docs/MDN/Feedback にリンクがあって、右上の「編集」の使い方や他の報告の仕方が説明されています

MDN を参考にして、フッターには https://docs.ruby-lang.org/ja/latest/doc/help.html へのリンクをつけて、そこの説明を詳しくするのも良さそうです。

[sho-h]

実際の修正を含む具体案は特になさそうですので、一回取り込みましたー。

[pocke]

ありがとうございます。。どういう感じに置いたらきれいかなと考えて手が止まっていました。
水平線を引いて文字色を薄くするとかしたらフッター感がでて良さそうかなと思いつつ、特に今のところは手を付けられてないです。。

[znz]

その後みつけたのですが https://jsprimer.net/intro/feedback/ を真似できると良さそうです。
rurema/doctree は CC BY 3.0 で js-primer は CC BY-NC 4.0 で NC が付いている分向こうの方が制限が厳しいので、リンクして向こうをみてもらう、というのでも良いかもしれません。

[pocke]

その後みつけたのですが https://jsprimer.net/intro/feedback/ を真似できると良さそうです。

お、めっちゃしっかり書かれていて良いですね。今の https://docs.ruby-lang.org/ja/latest/doc/help.html をこれを参考に書き直せると良さそうです。Issue Templateの拡充もしたいですね。

ライセンスは、jsprimerのページを参考にした上でクレジットを表示すれば問題なさそうな気がします。るりまの商用展開をするとNCにブロックされる可能性もありますが。。

jsprimerのリポジトリにIssueを立てて問い合わせても良さそうですね。