[PATCH compass-ci] doc/manual/borrow-machine: improve readability

Signed-off-by: Li Ping <1477412247@qq.com> --- doc/manual/borrow-machine.en.md | 18 +++++++++--------- doc/manual/borrow-machine.zh.md | 18 +++++++++--------- 2 files changed, 18 insertions(+), 18 deletions(-) diff --git a/doc/manual/borrow-machine.en.md b/doc/manual/borrow-machine.en.md index 7e66f40..72bcdcb 100644 --- a/doc/manual/borrow-machine.en.md +++ b/doc/manual/borrow-machine.en.md @@ -64,24 +64,24 @@ If you have not completed above works, reference to [apply-account.md](https://g # FAQ -## Customize the borrowing time +* Customize the borrowing time Find key in the yaml file and edit its value according to your requirement. - - The borrowing period can be calculated in days and hours. - - The maximum period is no more than 10 day. + The borrowing period can be calculated in days and hours. + The maximum period is no more than 10 day. -## Guidance for command submit +* Guidance for command submit See the usage and options for command 'submit' the command below: - submit -h + submit -h Reference the following line to learn the advanced usage for command 'submit': + + [submit detailed usage](https://gitee.com/wu_fengguang/compass-ci/blob/master/doc/manual/submit-job....) - [submit detailed usage](https://gitee.com/wu_fengguang/compass-ci/blob/master/doc/manual/submit-job....) - -## Available testbox +* Available testbox For a full list of testbox, reference to https://gitee.com/wu_fengguang/lab-z9/tree/master/hosts @@ -96,6 +96,6 @@ If you have not completed above works, reference to [apply-account.md](https://g > - You will need to wait if there are already tasks in the task queue for the machine. > - Your job will be randomly assigned to a machine that meets the requirements if the testbox name is not end with '-axx'. -## Specify the OS +* Specify the OS About supportted `os`, `os_arch`, `os_version`, reference to [os-os_verison-os_arch.md](https://gitee.com/wu_fengguang/compass-ci/blob/master/doc/job/os-os_verison-...) diff --git a/doc/manual/borrow-machine.zh.md b/doc/manual/borrow-machine.zh.md index 73aea6b..c19d8a5 100644 --- a/doc/manual/borrow-machine.zh.md +++ b/doc/manual/borrow-machine.zh.md @@ -3,7 +3,7 @@ - 申请account - 配置默认yaml文件 -如果未完成以上步骤,请参考[apply-account.md](https://gitee.com/wu_fengguang/compass-ci/blob/master/doc/manual/apply-account.md)完成操作。 +如果未完成以上步骤,请参考 [apply-account.md](https://gitee.com/wu_fengguang/compass-ci/blob/master/doc/manual/apply-accou...) 完成操作。 # 申请测试机 @@ -62,14 +62,14 @@ # FAQ -## 自定义借用时长 +* 自定义借用时长 - 在借用机器的yaml实例文件中,找到’runtime‘字段,根据需求修改借用时长。 + 在借用机器的yaml实例文件中,找到 **runtime** 字段,根据需求修改借用时长。 - - 借用机器可以按照小时(h)、天(d)来计算。 - - 借用时长最多不超过10天。 + 借用机器可以按照小时(h)、天(d)来计算。 + 借用时长最多不超过10天。 -## submit命令指导 +* submit命令指导 学习submit命令,您可以使用 以下命令查看submit命令的各项参数及使用方法: @@ -77,9 +77,9 @@ 也可以参考submit命令手册学习submit命令高级用法: - [submit命令详解](https://gitee.com/wu_fengguang/compass-ci/blob/master/doc/manual/submit-job....) + [submit命令详解](https://gitee.com/wu_fengguang/compass-ci/blob/master/doc/manual/submit-job....) -## 可选的testbox +* 可选的testbox 查看可选的testbox列表,请参考:https://gitee.com/wu_fengguang/lab-z9/tree/master/hosts @@ -95,6 +95,6 @@ > - 物理机的testbox若选择以`--axx`结尾的,则表示指定到了具体的某一个物理机。若此物理机任务队列中已经有任务在排队,则需要等待队列中前面的任务执行完毕后,才会轮到你提交的borrow任务。 > - 物理机的testbox若不选择以`-axx`结尾的,表示不指定具体的某一个物理机。则此时集群中的空闲物理机会即时被分配执行你的borrow任务。 -## 如何 borrow 指定的操作系统 +* 如何 borrow 指定的操作系统 关于支持的`os`, `os_arch`, `os_version`,参见:[os-os_verison-os_arch.md](https://gitee.com/wu_fengguang/compass-ci/blob/master/doc/job/os-os_verison-...) -- 2.23.0
participants (1)
-
Li Ping