mirror/yapi
2
0
Fork 0
mirror of https://github.com/YMFE/yapi.git synced 2025-01-06 12:45:22 +08:00
Code Issues Packages Projects Releases Wiki Activity

docs: 更新文档

Browse Source
This commit is contained in:
wenbo.dong 2017-09-13 11:55:53 +08:00
parent b22a38cc4d
commit ce58872b0e
4 changed files with 24 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
doc/page/usage/manage.md
View File

@ -1,6 +1,6 @@
接口管理的逻辑较为复杂，操作频率高，层层审批将严重拖慢生产效率，因此传统的金字塔管理模式并不适用。
YAPI 将扁平化管理模式的思想引入到产品的权限管理中，`超级管理员` 拥有最高的权限，并将权限分配给若干 `组长`，`超级管理员` 只需管理`组长` 即可，实际上管理YAPI各大分组与项目的是“`组长`”。`组长`对分组或项目负责，一般由BU负责人/项目负责人担任。
YApi 将扁平化管理模式的思想引入到产品的权限管理中，`超级管理员` 拥有最高的权限，并将权限分配给若干 `组长`，`超级管理员` 只需管理`组长` 即可，实际上管理YAPI各大分组与项目的是“`组长`”。`组长`对分组或项目负责，一般由BU负责人/项目负责人担任。
## 认识组长
@ -10,11 +10,18 @@ YAPI 将扁平化管理模式的思想引入到产品的权限管理中，`超
`项目组长` 无法操作分组，但拥有项目的全部权限，`项目组长` 是 YApi 的基层管理者，承担了 YApi 绝大部分的日常管理工作。
### 如何成为组长？
> - 联系超级管理员，说明要创建的分组名称和自己的用户名。
## 权限列表
新用户未加入项目或分组时，是 `“游客”`
### 项目权限
| 操作 | 游客 | 开发者 | 组长 | 超级管理员 |
| 操作 | 游客 | 项目开发者 | 项目组长 | 超级管理员 |
| :-------------- | :------------: | :------------: | :------------: | :------------: |
| 浏览公开项目与接口 | ✓ | ✓ | ✓ | ✓ |
| 浏览私有项目与接口 | | ✓ | ✓ | ✓ |
@ -27,7 +34,7 @@ YAPI 将扁平化管理模式的思想引入到产品的权限管理中，`超
### 分组权限
| 操作 | 游客 | 开发者 | 组长 | 超级管理员 |
| 操作 | 游客 | 项目开发者 | 分组组长 | 超级管理员 |
| :-------------- | :------------: | :------------: | :------------: | :------------: |
| 浏览分组 | ✓ | ✓ | ✓ | ✓ |
| 在分组中新建项目 | | ✓ | ✓ | ✓ |

3
doc/page/usage/quickstart.md
View File

@ -6,7 +6,7 @@
* [获取权限](#获取权限)
* [找到一个项目](#选择项目)
* [新建接口](#新建_编辑接口)
* [新建接口](#新建接口)
搞定~
@ -15,6 +15,7 @@
- 登录后查看项目，如果找不到对应分组或项目，需要联系组长获取项目权限。
## 选择项目
- 如果你已经登录，会在首页右侧看到一些项目 (可以在左侧的分组列表切换分组来查看不同分组下的项目)。

2
static/doc/index-创建第一个API.html
View File

@ -133,7 +133,7 @@
<h3 class="subject" id="如何创建项目？">如何创建项目？ <a class="hashlink" href="#如何创建项目？">#</a></h3><p>把大象装进冰箱分几步？三步：把冰箱门打开，把大象装进去，关门，搞定~</p>
<p>新建接口分几步？也是三步：</p>
<ul>
<li><a href="#获取权限">获取权限</a></li><li><a href="#选择项目">找到一个项目</a></li><li><a href="#新建_编辑接口">新建接口</a></li></ul>
<li><a href="#获取权限">获取权限</a></li><li><a href="#选择项目">找到一个项目</a></li><li><a href="#新建接口">新建接口</a></li></ul>
<p>搞定~</p>
<h2 class="subject" id="获取权限">获取权限 <a class="hashlink" href="#获取权限">#</a></h2><ul>
<li>登录后查看项目，如果找不到对应分组或项目，需要联系组长获取项目权限。</li></ul>

17
static/doc/index-管理分组与项目.html
View File

@ -127,17 +127,22 @@
<div class="content-right markdown-body use-sidebar" role="main">
<p>接口管理的逻辑较为复杂，操作频率高，层层审批将严重拖慢生产效率，因此传统的金字塔管理模式并不适用。</p>
<p>YAPI 将扁平化管理模式的思想引入到产品的权限管理中，<code>超级管理员</code> 拥有最高的权限，并将权限分配给若干 <code>组长</code>，<code>超级管理员</code> 只需管理<code>组长</code> 即可，实际上管理YAPI各大分组与项目的是“<code>组长</code>”。<code>组长</code>对分组或项目负责，一般由BU负责人/项目负责人担任。</p>
<p>YApi 将扁平化管理模式的思想引入到产品的权限管理中，<code>超级管理员</code> 拥有最高的权限，并将权限分配给若干 <code>组长</code>，<code>超级管理员</code> 只需管理<code>组长</code> 即可，实际上管理YAPI各大分组与项目的是“<code>组长</code>”。<code>组长</code>对分组或项目负责，一般由BU负责人/项目负责人担任。</p>
<h2 class="subject" id="认识组长">认识组长 <a class="hashlink" href="#认识组长">#</a></h2><p>组长分为 <code>分组组长</code> 与 <code>项目组长</code>，组长对分组或项目负责，拥有分组或项目下的所有权限，二者区别如下：</p>
<p><code>分组组长</code> 有权限修改分组、删除分组，可以创建分组下的项目。一般来说，组长只需要对项目负责，将项目的操作任务安排给项目组长处理即可。</p>
<p><code>项目组长</code> 无法操作分组，但拥有项目的全部权限，<code>项目组长</code> 是 YApi 的基层管理者，承担了 YApi 绝大部分的日常管理工作。</p>
<h2 class="subject" id="权限列表">权限列表 <a class="hashlink" href="#权限列表">#</a></h2><h3 class="subject" id="项目权限">项目权限 <a class="hashlink" href="#项目权限">#</a></h3><table>
<h3 class="subject" id="如何成为组长？">如何成为组长？ <a class="hashlink" href="#如何成为组长？">#</a></h3><blockquote>
<ul>
<li>联系超级管理员，说明要创建的分组名称和自己的用户名。</li></ul>
</blockquote>
<h2 class="subject" id="权限列表">权限列表 <a class="hashlink" href="#权限列表">#</a></h2><p>新用户未加入项目或分组时，是 <code>“游客”</code></p>
<h3 class="subject" id="项目权限">项目权限 <a class="hashlink" href="#项目权限">#</a></h3><table>
<thead>
<tr>
<th style="text-align:left">操作</th>
<th style="text-align:center">游客</th>
<th style="text-align:center">开发者</th>
<th style="text-align:center">组长</th>
<th style="text-align:center">项目开发者</th>
<th style="text-align:center">项目组长</th>
<th style="text-align:center">超级管理员</th>
</tr>
</thead>
@ -198,8 +203,8 @@
<tr>
<th style="text-align:left">操作</th>
<th style="text-align:center">游客</th>
<th style="text-align:center">开发者</th>
<th style="text-align:center">组长</th>
<th style="text-align:center">项目开发者</th>
<th style="text-align:center">分组组长</th>
<th style="text-align:center">超级管理员</th>
</tr>
</thead>