diff --git a/docs/Bot市场/bot安装.md b/docs/Bot市场/bot安装.md index 7a307e3..a0f772f 100644 --- a/docs/Bot市场/bot安装.md +++ b/docs/Bot市场/bot安装.md @@ -1,4 +1,20 @@ --- sidebar_label: 'bot安装' sidebar_position: 1 ---- \ No newline at end of file +--- + +# bot安装 + +Bot安装是进行bot安装和管理控制的重要模块,主要包括bot安装、安装查询、安装管理等功能。 + +在bot详情页,用户点击“安装此Bot”按钮后,可以看到该bot工作所需的各项权限信息。若用户同意授予bot所需的相关权限即可进行安装。用户可选择将bot安装到所有仓库(用户拥有的所有仓库)中,也可以选择指定的仓库进行安装。 + +![botinstall1](/img/botinstall1.png) + +在个人“设置”或者“仓库设置”中,用户可以看到目前已经安装的Bot情况,点击“配置”按钮可以对bot安装情况进行配置,点击“卸载”按钮可以进行卸载。 + +![botinstall2](/img/bot/botinstall2.png) + +在bot安装配置页中,用户可以掌握该bot的安装位置和工作状态。若用户需要更改bot的工作仓库时,可以进行更改安装位置。bot的工作状态包括激活和挂起,用户可根据需要对bot的状态进行调整,将其挂起或者激活,会影响到bot对仓库数据的访问权限。 + +![botinstall3](/img/bot/botinstall3.png) \ No newline at end of file diff --git a/docs/Bot市场/bot市场.md b/docs/Bot市场/bot市场.md index e9f6503..216a566 100644 --- a/docs/Bot市场/bot市场.md +++ b/docs/Bot市场/bot市场.md @@ -1,4 +1,24 @@ --- sidebar_label: 'bot市场' sidebar_position: 4 ---- \ No newline at end of file +--- + +# Bot市场 + +Bot市场是进行Bot分享与复用的重要模块,主要包括bot的搜索发现,详情查看等功能。 + +Bot市场主页中展示了目前所有已经上架市场的bot简要信息,包括bot的头像,名称,开发者,简介和安装次数等信息,用户可根据这些基本信息初步判断该bot是否符合自己的项目需求。 + +在bot市场主页中,用户可以选择指定的bot种类,筛选出特定分类的bot,在这个种类范围内进行搜索与选择。 + +此外,用户通过在搜索栏中输入关键字进行搜索,可检索出内容包含指定关键字的相关bot。 + +用户可结合种类筛选和关键字搜索缩小范围,在市场中快速找到符合项目相关需求的bot。 + +![botmarket1](/img/bot/botmarket1.png) + +在bot市场页中,用户点击指定的bot卡片即可进入该bot的详情页。Bot的详情页包含bot的头像,名称,开发者,种类和详细介绍等信息,用户可在此掌握该bot的各项介绍,进一步判断是否将其安装到指定仓库中。 + +![botmarket2](/img/bot/botmarket2.png) + +在bot详情页中,若用户认为该bot满足自己的项目需求,可点击“安装此Bot”按钮,了解该bot的权限信息,将其安装到指定的仓库中,关于安装的更多介绍可见“Bot安装”部分。 \ No newline at end of file diff --git a/docs/Bot市场/bot开发.md b/docs/Bot市场/bot开发.md index 12fe799..4adc959 100644 --- a/docs/Bot市场/bot开发.md +++ b/docs/Bot市场/bot开发.md @@ -1,4 +1,22 @@ --- sidebar_label: 'bot开发' sidebar_position: 3 ---- \ No newline at end of file +--- + +# Bot开发 + +Bot开发是开发者进行bot注册的重要模块。 + +在个人“设置”中,用户可以看到目前已经注册的bot列表,点击对应bot的“编辑”按钮可以对已注册的bot进行配置;点击“Bot注册”按钮开始注册新的bot。 + +![botcreate1](/img/bot/botcreate1.png) + +在注册页中,开发者需要填写bot注册的相关信息,包括bot的名称、Webhook 地址,详细介绍等,系统将对开发者输入的信息进行合法性校验,确保bot各项信息的完整性和有效性。此外,系统将自动生成bot的唯一标识,同时调用 GitLink 平台的相关接口生成bot的身份凭证信息,包括客户端密钥和私钥等。 + +开发者需通过这些身份信息结合平台接口进行bot身份认证后,调用相关接口完成bot的相关功能。 + +平台开发API链接(待完善):https://www.gitlink.org.cn/docs/api#introduction + +![botcreate2](/img/bot/botcreate2.png) + +![botcreate3](/img/bot/botcreate3.png) \ No newline at end of file diff --git a/docs/Bot市场/bot配置.md b/docs/Bot市场/bot配置.md index 106bad9..4260b3d 100644 --- a/docs/Bot市场/bot配置.md +++ b/docs/Bot市场/bot配置.md @@ -1,4 +1,23 @@ --- sidebar_label: 'bot配置' sidebar_position: 2 ---- \ No newline at end of file +--- + +# Bot配置 + +Bot配置是开发者进行bot维护和配置的重要模块,主要包括bot基本信息维护、权限&订阅事件管理、高级选项配置等功能。 + +Bot的基本信息维护中,开发者可以看到bot的各项基本信息,并可以根据需要对bot的头像,名称,Webhook地址等进行修改。 + +![botconfig1](/img/bot/botconfig1.png) + +Bot的权限&订阅事件管理中,开发者可根据对仓库资源的访问需要为bot分配不同的权限和等级,比如增加代码库权限,将拉取请求的写权限变为读权限等。开发者还能更改当前bot订阅的事件列表,比如订阅代码库推送,取消拉取请求分配订阅等,以实现bot功能的更新与升级。 + +![botconfig2](/img/bot/botconfig2.png) + + +Bot高级选项配置中,开发者可以改变bot的公私有状态,从而影响到bot的使用范围。需要注意的是,公开状态下的bot在已有其他仓库安装的情况下不能变成私有。开发者可选择将bot上架到市场,需要填写上架信息,包括市场简介,主要功能,次要功能等各项信息。 + +开发者还能进行bot的删除和转让操作,发起转让意味着更改bot的所有权,需要输入接受者的用户名。在接受者确定接受后,即可完成bot的所有权变更,拒绝则会取消本次的转让操作。 + +![botconfig3](/img/bot/botconfig3.png) diff --git a/static/img/bot/botconfig1.png b/static/img/bot/botconfig1.png new file mode 100644 index 0000000..75d3aa8 Binary files /dev/null and b/static/img/bot/botconfig1.png differ diff --git a/static/img/bot/botconfig2.png b/static/img/bot/botconfig2.png new file mode 100644 index 0000000..e932702 Binary files /dev/null and b/static/img/bot/botconfig2.png differ diff --git a/static/img/bot/botconfig3.png b/static/img/bot/botconfig3.png new file mode 100644 index 0000000..d368eff Binary files /dev/null and b/static/img/bot/botconfig3.png differ diff --git a/static/img/bot/botcreate1.png b/static/img/bot/botcreate1.png new file mode 100644 index 0000000..1383604 Binary files /dev/null and b/static/img/bot/botcreate1.png differ diff --git a/static/img/bot/botcreate2.png b/static/img/bot/botcreate2.png new file mode 100644 index 0000000..533e03e Binary files /dev/null and b/static/img/bot/botcreate2.png differ diff --git a/static/img/bot/botcreate3.png b/static/img/bot/botcreate3.png new file mode 100644 index 0000000..4165b5b Binary files /dev/null and b/static/img/bot/botcreate3.png differ diff --git a/static/img/bot/botinstall1.png b/static/img/bot/botinstall1.png new file mode 100644 index 0000000..4e7a881 Binary files /dev/null and b/static/img/bot/botinstall1.png differ diff --git a/static/img/bot/botinstall2.png b/static/img/bot/botinstall2.png new file mode 100644 index 0000000..e257d9e Binary files /dev/null and b/static/img/bot/botinstall2.png differ diff --git a/static/img/bot/botinstall3.png b/static/img/bot/botinstall3.png new file mode 100644 index 0000000..687fbcb Binary files /dev/null and b/static/img/bot/botinstall3.png differ diff --git a/static/img/bot/botmarket1.png b/static/img/bot/botmarket1.png new file mode 100644 index 0000000..111f71f Binary files /dev/null and b/static/img/bot/botmarket1.png differ diff --git a/static/img/bot/botmarket2.png b/static/img/bot/botmarket2.png new file mode 100644 index 0000000..ee495e9 Binary files /dev/null and b/static/img/bot/botmarket2.png differ diff --git a/static/img/botinstall1.png b/static/img/botinstall1.png new file mode 100644 index 0000000..4e7a881 Binary files /dev/null and b/static/img/botinstall1.png differ