Merge pull request #3840 from dev-hato/fix_get_tokens

README: トークン取得方法の記述修正

Author: massongit

.textlintrc

@@ -20,7 +20,8 @@
     "ja-hiragana-keishikimeishi": true,
     "no-dead-link": {
         "ignore": [
-            "https://github.com/dev-hato/hato-bot/releases/latest"
+            "https://github.com/dev-hato/hato-bot/releases/latest",
+            "https://platform.openai.com/api-keys"
         ]
     },
     "no-mixed-zenkaku-and-hankaku-alphabet": true,

README.md

@@ -20,8 +20,11 @@
 鳩botを使うには以下が必要です。
 
 - Dockerが動作するPC
-- Slack API Token ([Slack API Tokenの取得手順](./doc/01_Get_Slack_API_Token.md))
-- Yahoo API Token ([Yahoo API Tokenの取得手順](./doc/02_Get_Yahoo_API_Token.md))
+- Slack API Token ([Slack API Tokenの取得手順](./doc/01_Get_Slack_API_Token.md)) (Slackで動かす場合のみ)
+- Discord Bot Token ([Discord Bot Tokenの取得手順](./doc/03_Get_Discord_Bot_Token.md)) (Discordで動かす場合のみ)
+- Misskeyアクセストークン ([Misskeyアクセストークンの取得手順](./doc/04_Get_Misskey_Access_Token.md)) (Misskeyで動かす場合のみ)
+- Yahoo API Token ([Yahoo API Tokenの取得手順](./doc/05_Get_Yahoo_API_Token.md))
+- OpenAI API Key ([OpenAI API Keyの取得手順](./doc/06_Get_OpenAI_API_Token.md))
 
 ### 自分のPC上で動かす
 
@@ -54,17 +57,7 @@
 
     MODEに `discord` を指定すると、DiscordのBotとして動作します。
 
-    DISCORD_API_TOKENにDiscordのBot Tokenを指定します。
-
-    DISCORD_API_TOKENには `Read Messages/View Channels` と、 `Send Messages` の権限が必要です。
-
-    MODEに `misskey` を指定すると、自分のサーバーからのメンションに限って反応するMisskeyのBotとして動作します。
-
-    MISSKEY_URLにBotのいるMisskeyサーバーのドメインを指定します。
-
-    MISSKEY_API_TOKENにMisskeyのBotのアクセストークンを指定します。
-
-    MISSKEY_API_TOKENには `ドライブを操作する`, `ノートを作成・削除する`, `アカウントの情報を見る`, `リアクションを操作する` の権限が必要です。
+    MODEに `misskey` を指定すると、自分のいるサーバーからのメンションに限って反応するMisskeyのBotとして動作します。
 
 6. docker composeで鳩botとPostgreSQLを起動します。
 

README.template.md

@@ -20,8 +20,11 @@
 鳩botを使うには以下が必要です。
 
 - Dockerが動作するPC
-- Slack API Token ([Slack API Tokenの取得手順](./doc/01_Get_Slack_API_Token.md))
-- Yahoo API Token ([Yahoo API Tokenの取得手順](./doc/02_Get_Yahoo_API_Token.md))
+- Slack API Token ([Slack API Tokenの取得手順](./doc/01_Get_Slack_API_Token.md)) (Slackで動かす場合のみ)
+- Discord Bot Token ([Discord Bot Tokenの取得手順](./doc/03_Get_Discord_Bot_Token.md)) (Discordで動かす場合のみ)
+- Misskeyアクセストークン ([Misskeyアクセストークンの取得手順](./doc/04_Get_Misskey_Access_Token.md)) (Misskeyで動かす場合のみ)
+- Yahoo API Token ([Yahoo API Tokenの取得手順](./doc/05_Get_Yahoo_API_Token.md))
+- OpenAI API Key ([OpenAI API Keyの取得手順](./doc/06_Get_OpenAI_API_Token.md))
 
 ### 自分のPC上で動かす
 
@@ -54,17 +57,7 @@
 
     MODEに `discord` を指定すると、DiscordのBotとして動作します。
 
-    DISCORD_API_TOKENにDiscordのBot Tokenを指定します。
-
-    DISCORD_API_TOKENには `Read Messages/View Channels` と、 `Send Messages` の権限が必要です。
-
-    MODEに `misskey` を指定すると、自分のサーバーからのメンションに限って反応するMisskeyのBotとして動作します。
-
-    MISSKEY_URLにBotのいるMisskeyサーバーのドメインを指定します。
-
-    MISSKEY_API_TOKENにMisskeyのBotのアクセストークンを指定します。
-
-    MISSKEY_API_TOKENには `ドライブを操作する`, `ノートを作成・削除する`, `アカウントの情報を見る`, `リアクションを操作する` の権限が必要です。
+    MODEに `misskey` を指定すると、自分のいるサーバーからのメンションに限って反応するMisskeyのBotとして動作します。
 
 6. docker composeで鳩botとPostgreSQLを起動します。
 

doc/04_Setting_to_Event_URL.md doc/02_Setting_to_Event_URL.mddoc/04_Setting_to_Event_URL.md renamed to doc/02_Setting_to_Event_URL.md

@@ -0,0 +1,13 @@
+# Discord Bot Tokenを取得する
+
+1. Discordのアカウントを取得します。
+
+1. [Discord Developer Portal — My Applications](https://discord.com/developers/applications)を開きます。
+
+1. `New Application` をクリックし、Applicationを作成します。
+
+1. 左ペインの `Bot` をクリックします。
+
+1. `Bot Permissions` セクション内の `Read Messages/View Channels` と、 `Send Messages` にチェックを入れます。
+
+1. `TOKEN` セクションの `Copy` をクリックし、Bot Tokenをコピーします。

doc/03_Get_Discord_Bot_Token.md

@@ -0,0 +1,11 @@
+# Misskeyアクセストークンを取得する
+
+1. Bot用のアカウントを取得します。
+
+1. `設定` -> `API` を開きます。
+
+1. `アクセストークン` の発行をクリックします。
+
+1. `ドライブを操作する`, `ノートを作成・削除する`, `アカウントの情報を見る`, `リアクションを操作する` の権限を選択し、右上のチェックボタンをクリックします。
+
+1. 発行されたアクセストークンをメモします。

doc/04_Get_Misskey_Access_Token.md

@@ -0,0 +1,12 @@
+# OpenAI API Keyを取得する
+
+1. OpenAIのアカウントを取得します。
+
+1. [User settings - OpenAI API](https://platform.openai.com/api-keys) を開きます。
+
+1. `Create new secret key` をクリックします。
+
+1. 次のように入力し `Create secret key` をクリックします。
+   * `Permissions`: `Restricted` にしたうえで `Model capabilities` を `Write` にする
+
+1. 発行されたAPI keyをメモします。