OSS ドキュメント(GitHub 連携)
オープンソースソフトウェア(OSS)のドキュメントを、料金プランの枠とは別に公開できます。管理している公開 GitHub リポジトリをドキュメントに紐付けると、そのドキュメントは OSS ドキュメント になります。
OSS ドキュメントになると変わること
| 項目 | OSS ドキュメント |
|---|---|
| ドキュメントの枠 | 料金プランのドキュメントの枠に含まれません。OSS ドキュメントは、組織あたり3つまでです。 |
| 独自ドメイン・Google Analytics | どのプランでも利用できます(Free プランを含みます)。 |
| AI の回答 | 組織の AI 回答枠とは別に、OSS ドキュメントの分をまとめて月1,000回まで回答します。BYOK・Enterprise の組織は、上限がありません。 |
| 閲覧制限 | かけられません。OSS ドキュメントは、どなたでも閲覧できることを前提としています。 |
| 「Powered by 問次郎」 | プランにかかわらず、公開ページに表示します。 |
メンバーの数など、ほかの上限は、組織の料金プランのとおりです。
紐付けの条件
- リポジトリが 公開(Public) されていること。
- 紐付ける方が、そのリポジトリの 管理者(Admin または Maintain の権限) であること。
- 1つのドキュメントに紐付けられるリポジトリは1つです。同じリポジトリを、ほかのドキュメントに紐付けることはできません。
- 閲覧制限をかけているドキュメントは紐付けられません。先に閲覧制限を外してください。
- アーカイブしたドキュメントは紐付けられません。
問次郎は、紐付けるときに GitHub で上記の条件を確認します。GitHub のトークン(アクセス権)は保存しません。
リポジトリを紐付ける
- ドキュメントの編集画面を開きます。
- 右のパネルの「設定」タブを開き、「連携」の「GitHub 連携」にある「紐付ける」を押します。
- 表示された画面で、リポジトリを owner/repository の形式(例: kairo-inc/example)で入力し、「GitHub で確かめて紐付ける」を押します。
- GitHub の画面が開きます。問次郎への許可を確認して、許可します。
- 編集画面に戻り、結果が表示されます。紐付けると、「GitHub 連携」の欄にリポジトリの名前が表示されます。
- 紐付けられなかった場合: 理由(リポジトリが見つからない、公開されていない、管理者ではない、すでにほかのドキュメントに紐付いている、OSS ドキュメントの上限に達している、など)が表示されます。
- 別のリポジトリに変える場合: 「GitHub 連携」の「変更する」を押し、新しいリポジトリを入力して紐付け直します。
紐付けを外す
- 右のパネルの「設定」タブの「GitHub 連携」にある「変更する」を押します。
- 「紐付けを外す」を押します。
紐付けを外すと、通常のドキュメントに戻り、料金プランのドキュメントの枠に含まれるようになります。ドキュメントの枠に空きがない場合は、外せません。ほかのドキュメントをアーカイブするか、枠を追加してから外してください。枠については利用プランをご覧ください。
よくある質問
有料プランでも OSS ドキュメントを使えますか?
はい。どのプランでも、組織あたり3つまで OSS ドキュメントにできます。OSS ドキュメントは、プランのドキュメントの枠に含まれません。
OSS ドキュメントの AI の回答が月1,000回を超えるとどうなりますか?
その月は、OSS ドキュメントの AI チャットが回答できなくなります。組織の AI 回答枠や AI 追加枠は使用しません。翌月になると、再び回答できるようになります。
組織のメンバーの数は増えますか?
いいえ。メンバーの数の上限は、組織の料金プランのとおりです。