Zennと連携するGitHubリポジトリ名は何がいいのか?

公開:2020/09/19
更新:2020/10/08
4 min読了の目安(約4100字IDEAアイデア記事
Likes12

Zenn.devはじめました

記念すべき、初投稿です。

Zenn.devの魅力は数多あると思いますが、私は特に
GitHubリポジトリでZennのコンテンツを管理する
魅力を感じ、早速使ってみようと思いました。

早速、GitHubリポジトリを作ろうと思ったのですが、ふと

リポジトリ名は、何にするのがいいのか🤔

と疑問に思いました。

なお、本記事の結論は、以下となります。

「zenn-contents」が多いけど、「ユーザ名-zenn-contents」がいいのではないか

他の人のを見てみよう

ということで、早速トレンドに載っているユーザの情報を参考にさせていただきました。

GitHub連携は公開リポジトリではなく、プライベートリポジトリでも実施できるため、

  • GitHub連携(公開リポジトリ)
  • GitHub連携(プライベートリポジトリ)
  • GitHub連携を使わない

という、3つの編集方法がありますが、

  • アカウントにGitHubユーザ名を登録している
    • ⇒GitHub連携を使っている
  • アカウントのGitHubに「articles」ディレクトリのあるリポジトリがある
    • ⇒GitHub連携(公開リポジトリ)を利用している

と、判断すると、9/19段階での体感では、それぞれ1/3ずつ位なのかなぁと思いました。

さて、本記事公開時は、トレンド -> ユーザページ -> GitHub -> Repositories
で確認していましたが、 Zenn CLIでは、 npx zenn init でREADME.mdを作成する
ことを考慮すると、GitHubの検索で対象が絞れるのではないかと考えました。

そこで、npx zenn initで作られるREADME内の、zenn-cli-guideのURLを用いて、
以下の検索テキストでGitHubを検索してみました。

https://zenn.dev/zenn/articles/zenn-cli-guide in:readme

9/20日時点で、22件のリポジトリがHITしました。
以下、リポジトリ名の多い順のリストです。

実は、Zenn公式の記事のリポジトリ名は zenn-docs(zenn-dev/zenn-docs)
なのですが、こちらのREADMEには、zenn-cli-guideへのリンクが貼られていなかったので、
上記検索方法ではHITしませんでした。

なお、 zenn-contentsGitHubリポジトリでZennのコンテンツを管理する 記事
の説明画像中で使われていました。

結局どうしたのか。

私は、zenn-contentsに決めようと思ったのですが、ふと、GitHubで記事を管理する利点の一つに、
GitHubの機能が使える つまり、 記事のプルリクができる ことに気づきました。

Qiitaでは、編集リクエストの機能があり、これが記事の質を高めるのにある程度貢献していると思っていますが、
今のところ、Zennには、編集リクエストの機能がありません。

しかし、GitHubで記事を管理するれば、プルリクによる編集リクエストが可能です。

その際に、zenn-contentsというリポジトリ名だと、、リポジトリ名がかぶってしまいます!!

つまり、Zennの記事用のGitHubのリポジトリ名は、ユーザが分かるものがよいのではないか?
と考え、私は「ユーザ名-zenn-contents」というリポジトリ名にしました。
(zenn-docsだと、zenn自体のドキュメントというニュアンスが出るので。)

↓ 筆者の作成したzenn投稿記事用GitHubリポジトリ

https://github.com/j5c8k6m8/j5c8k6m8-zenn-contents

公開リポジトリ管理のメリット/デメリット

公開リポジトリで記事を書くと、プルリクがもらえるかもしれない というメリットがあるため、
公開リポジトリを用いること自体は悪くはないのですが、現在の仕様では1点懸念を感じました。

それは、 Zenn CLIを使ってコンテンツを作成する
コメントに気づきがあったのですが、

yt4
有料で本を出す場合は、管理するリポジトリはプライベートにしておいたほうが良い感じですかね?

Zenn公式
そうですね。有料販売する場合はプライベートリポジトリにされることをおすすめします。

Zennの差別化の一つである、有料販売では用いにくいことです。
連携リポジトリは現状1つに限られているため、 有料販売を考えている人は、注意が必要そうです。

さいごに

初投稿をしたくて、書き殴りました。

GitHubでの管理には、無限の可能性を感じているので、そこら辺の記事をしばらく投稿したいと思ってます。

私のリポジトリは、Dockerでの構築手順を追記してるので、次はここらへんを。

(あと本記事のリストを作成できるscriptの作成とか)