📝 修改文档.

2024-03-22 01:46:18 +08:00
parent 1e9805c99f
commit 5d9fcf7265
31 changed files with 7236 additions and 4542 deletions
--- a/docs/README.md
+++ b/docs/README.md
@@ -2,8 +2,9 @@
 <img style="margin-right: 8px;" src="./assert/logo.svg" width="32px" height="32px"/> orion-ops-pro 是什么
 </h1>

-`orion-ops-pro` 是一款现代化、高颜值的一站式智能运维管理平台，集资产管理、资产授权、批量执行、Web终端、WebSftp、角色管理、系统管理等功能于一体，致力于简化运维团队的治理工作。它是基于 `orion-ops`
-的产品思路进行重构，技术架构升级，并优化了交互逻辑，让操作更快捷友好。
+`orion-ops-pro`
+是一款现代化、高颜值的一站式智能运维管理平台，集资产管理、资产授权、批量执行、Web终端、WebSftp、角色管理、系统管理等功能于一体，致力于简化运维团队的治理工作。它是基于 `orion-ops`
+的产品思路进行重构，技术架构升级，并优化了交互逻辑，让操作更快捷更友好。

 <p style="text-align: left">
    <a target="_blank" style="text-decoration: none" href="https://app.codacy.com/gh/lijiahangmax/orion-ops-pro/dashboard?utm_source=gh&utm_medium=referral&utm_content=&utm_campaign=Badge_grade">
@@ -91,6 +92,12 @@ roadmap: https://lijiahangmax.gitee.io/orion-ops-pro/#/about/roadmap
 ![sftp](./assert/img/terminal_sftp.png "sftp")
 ![传输列表](./assert/img/terminal_transfer.png "传输列表")

+> 批量执行
+
+![批量执行](./assert/img/batch_exec.png "批量执行")
+![执行日志](./assert/img/batch_exec_log.png "执行日志")
+![执行记录](./assert/img/batch_exec_record.png "执行记录")
+
 > 用户管理

 ![用户列表](./assert/img/user_list.png "用户列表")  
--- a/docs/about/change-log.md
+++ b/docs/about/change-log.md
@@ -2,8 +2,9 @@

 ## v1.0.2

-`2024-03-22` `release`
+`2024-03-2` `release`

+* 🚀 升级 `arco design` `2.55.0`
 * 🐞 修复 SFTP 加载失败后一直 loading
 * 🐞 修复 主机终端搜索框报错
 * 🐞 修复 SSH 配置未启用还可以连接
--- a/docs/about/roadmap.md
+++ b/docs/about/roadmap.md
@@ -1,7 +1,8 @@
 ## 功能排期 ⏳

-* 批量执行
 * 定时执行
+* 批量上传
+* 文件夹书签
 * 站内消息
 * 终端背景图片
 * 资产授权 UI 改版
--- a/docs/assert/img/asset_grant.png
+++ b/docs/assert/img/asset_grant.png
--- a/docs/assert/img/asset_host_list.png
+++ b/docs/assert/img/asset_host_list.png
--- a/docs/assert/img/batch_exec.png
+++ b/docs/assert/img/batch_exec.png
--- a/docs/assert/img/batch_exec_log.png
+++ b/docs/assert/img/batch_exec_log.png
--- a/docs/assert/img/batch_exec_record.png
+++ b/docs/assert/img/batch_exec_record.png
--- a/docs/assert/img/system_menu.png
+++ b/docs/assert/img/system_menu.png
--- a/docs/assert/img/terminal_setting.png
+++ b/docs/assert/img/terminal_setting.png
--- a/docs/assert/img/terminal_sftp.png
+++ b/docs/assert/img/terminal_sftp.png
--- a/docs/assert/img/terminal_snippet.png
+++ b/docs/assert/img/terminal_snippet.png
--- a/docs/assert/img/terminal_ssh.png
+++ b/docs/assert/img/terminal_ssh.png
--- a/docs/assert/img/terminal_theme.png
+++ b/docs/assert/img/terminal_theme.png
--- a/docs/assert/img/terminal_transfer.png
+++ b/docs/assert/img/terminal_transfer.png
--- a/docs/assert/img/user_grant_menu.png
+++ b/docs/assert/img/user_grant_menu.png
--- a/docs/assert/img/user_info.png
+++ b/docs/assert/img/user_info.png
--- a/docs/assert/img/user_list.png
+++ b/docs/assert/img/user_list.png
--- a/docs/assert/img/user_operator_log.png
+++ b/docs/assert/img/user_operator_log.png
--- a/docs/assert/img/workplace.png
+++ b/docs/assert/img/workplace.png
--- a/docs/index.html
+++ b/docs/index.html
@@ -2,7 +2,7 @@
 <html lang="en">
 <head>
    <meta charset="UTF-8">
-    <title>关于orion-ops-pro</title>
+    <title>关于 orion-ops-pro</title>
    <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1"/>
    <meta name="description" content="Description">
    <link rel="icon" href="./assert/logo.svg">
--- a/docs/operator/asset-audit.md
+++ b/docs/operator/asset-audit.md
@@ -3,7 +3,7 @@
 在主机终端页面打开的 `SSH` `SFTP` 连接都会记录下来。

 * 详情: 查看连接详情
-* 断开: 断开连接
+* 断开: 断开会话连接
 * 删除: 删除连接记录
 * 清理: 根据条件清理数据

--- a/docs/operator/host-ops.md
+++ b/docs/operator/host-ops.md
@@ -37,17 +37,55 @@
 > SFTP

 * 预览: 默认只能预览 2MB 以内的普通文件, 这个大小可以在前端 env 文件中修改 `VITE_SFTP_PREVIEW_MB`
+* 上传: 如果文件已存在则自动重命名之前的文件

 > 终端面板

 ⭐ 双击终端标签可快速复制会话

+### 批量执行
+
+批量执行 ssh 主机 shell 脚本。
+
+##### 日志面板中有几个内置的快捷键
+
+* 回车: `Enter`
+* 向上滚动: `↑`
+* 向上滚动一页: `ctrl` `↑`
+* 向下滚动: `↓`
+* 向下滚动一页: `ctrl` `↓`
+* 全选: `ctrl` `A`
+* 复制: `ctrl` `C`
+* 搜索: `ctrl` `F`
+* 清空: `ctrl` `L`
+
+⭐ 内置参数同执行模板参数
+
+* 重置: 重置全部参数
+* 执行: 执行所输入的命令
+* 返回: 返回到执行命令页面
+* 从模板中选择: 从模板中选择需要执行的命令
+* 执行历史: 点击历史命令可以快速填入
+
+### 执行记录
+
+查看批量执行任务记录。
+
+* 执行命令: 跳转到批量执行页面
+* 清空: 清空执行记录
+* 删除: 删除执行记录
+* 重新执行: 重新执行此命令
+* 命令: 查看执行时的命令
+* 参数: 查看执行时的参数
+* 日志: 查看执行日志, ctrl + 左键点击会用新页面打开
+* 下载: 下载执行日志
+
 ### 执行模板

 用来维护批量执行的命令模板, 支持动态参数, 使用 `@{{ xxx }}` 来替换命令参数。

 * 新增: 新增执行模板
-* 执行: 使用此命令模板批量执行主机命令
+* 执行: 打开命令执行框并且带入模板参数
 * 修改: 修改执行模板
 * 删除: 删除执行模板