Skip to content

Commit

Permalink
add platform usage doc (#50)
Browse files Browse the repository at this point in the history
* update fe docs

* update fe docs

* add fe comments & update fe docs

* update platform usage docs

* fix doc image's path

* update doc's image

* fe: fix dialog button bug

* update docs

* update docs
  • Loading branch information
KarenChuang authored Jan 22, 2019
1 parent ff6a211 commit 1d99915
Show file tree
Hide file tree
Showing 7 changed files with 31 additions and 4 deletions.
Binary file added doc/images/appid-list.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added doc/images/cluster-detail.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added doc/images/create-cluster.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added doc/images/job-list.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
4 changes: 3 additions & 1 deletion doc/wiki-cn/SUMMARY.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,9 @@
# Summary

* [Introduction](README.md)
* [overlord-proxy 使用指南](usage.md)
* [overlord-platform 部署指南](platform-deploy.md)
* [overlord-platform 使用指南](platform-usage.md)
* [overlord-proxy 使用指南](usage.md)
* [overlord-proxy](proxy.md)
* [功能支持](proxy/features.md)
* [性能测试](proxy/benchmark.md)
Expand All @@ -16,4 +17,5 @@
* [集群部署](platform/deploy-cluster.md)
* [集群伸缩](platform/scale.md)
* [节点恢复策略](platform/recovery-policy.md)
* [前端开发指南](platform/front-end.md)
* [工具支持 enri/anzi](tools.md)
26 changes: 26 additions & 0 deletions doc/wiki-cn/platform-usage.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
# overlord-platform 使用指南

## 创建集群

1. 填写名称、总容量(支持单位 G/M)、集群类型(推荐使用 Redis Cluster、版本、型号(支持定制)、分组,APPID 信息为选填内容。
2. 填写完成后点击 立即创建 按钮,将会自动跳转至集群详情页。

![create cluster](../images/create-cluster.gif)

## 查看集群详情

![cluster detail](../images/cluster-detail.png)

*删除集群操作前请务必解除 Appid 关联关系*

## 查看 Appid 列表

1. 查看与 Appid 有关联的集群信息,可通过 *添加关联* 按钮为当前 Appid 继续添加集群。
2. 点击集群列表右侧到 *解除关联* 按钮,可将解除当前 Appid 和集群的关联关系。
3. 点击 Appid 列表底部的 *添加 Appid* 按钮,可创建 Appid。

![appid list](../images/appid-list.gif)

## 查看 Job 列表

![job list](../images/job-list.png)
5 changes: 2 additions & 3 deletions web/src/views/AppId.vue
Original file line number Diff line number Diff line change
Expand Up @@ -74,15 +74,14 @@
{{ GROUP_MAP[row.group] }}
</template>
</el-table-column>
<el-table-column label="详情" width="200">
<el-table-column label="详情" width="230">
<template slot-scope="{ row }">
<el-button type="text" @click="addCorrelation(row)">关联到 {{ appid }}</el-button>
</template>
</el-table-column>
</el-table>
<span slot="footer" class="dialog-footer">
<el-button @click="dialogVisible = false">取 消</el-button>
<el-button type="primary" @click="dialogVisible = false">确 定</el-button>
<el-button @click="dialogVisible = false">关闭</el-button>
</span>
</el-dialog>

Expand Down

0 comments on commit 1d99915

Please sign in to comment.