リポジトリはプロジェクトのWebサイトとしても機能する必要がありますか(少なくとも小さなプロジェクトの場合)?

Aug 17 2020

これはより哲学的な質問ですが、そのような質問はここで許可されています。

ご存知のように、さまざまな無料のプロジェクトホストがあります。おそらくそれらすべてに共通する機能は、外部のWebサイトにリンクしたり管理したりする機能です。

私の質問は、実際には外部のWebサイトが必要だと思いますか?

GitHubのような場所では、プロジェクトの所有者がスクリーンショットなどを使用してWikiを作成できます。それでも、Wikipediaのソフトウェア情報ボックスのような場所では、公式リンクが別の場所につながることを期待しながら、GitHubをリポジトリのように扱います。

どうして?大規模なプロジェクトはGitHubのようなサードパーティに依存したくないかもしれませんが、小規模なプロジェクトはどうでしょうか。

まったく同じ情報やマニュアルなどを備えた2つの同一のWebサイトがあるのはなぜですか(そのうちの1つはリポジトリと呼ばれます)。

マーケティングにとって何が良いのでしょうか?

また、前述の重複を避けるために、外部のWebサイトを選択する必要がありますか、リポジトリのwikiを使用しないでください。

回答

5 amon Aug 17 2020 at 01:58

多くのプロジェクトでは、Webサイトに関して必要なのはREADMEだけです。GitHubやGitlabなどのリポジトリホストは、READMEが適切にレンダリングされていることを表示するため、Webサイトはあまり追加しません。これは、おそらく大多数のオープンなソフトウェアに共通のアプローチです。

プロジェクトにソースホスティングサービスへの依存度が低いIDを持たせたい場合、またはREADMEに合理的に入れることができる以上のコンテンツを表示したい場合は、別のWebサイト(おそらく独自のドメイン上)の方が理にかなっています。 。つまり、本質的には、マーケティングまたはドキュメントです。 Webサイトのソースコードがソースコードリポジトリの一部である場合でも、それらは同じではありません。レンダリングされた形式であっても、これらのソースファイルは人間にとって使いやすいものではありません。たとえば、リンクが間違っていたり、GitHubが構文を完全に理解していない可能性があります。

ただし、GitHubのWiki機能には近づかないことをお勧めします。プラス面として、wikiページは簡単に編集できます。しかし、実際のWebサイトと比較すると、見つけるのが難しく、ナビゲーションやテーマのオプションが非常に限られています。GH wikiの最も良い使用法は、プロジェクトの知識ベースまたは一種のスクラッチパッドとしてのようです。このウィキはユーザーのランディングページとして機能することは決してないため、他の場所(READMEやWebサイト)からウィキをリンクする必要があります。