Merge branch 'dev-doc' of gitlab.corp.qunar.com:mfe/yapi into dev-doc

This commit is contained in:
suxiaoxin 2017-10-13 17:14:50 +08:00
commit 7e96e91f63
10 changed files with 13 additions and 9 deletions

Binary file not shown.

Before

Width:  |  Height:  |  Size: 273 KiB

After

Width:  |  Height:  |  Size: 172 KiB

View File

@ -4,7 +4,7 @@ YApi 是高效、易用、功能强大的api管理平台。
在开始使用 YApi 之前,我们先来熟悉一下 YApi 的网站结构这将让你快速了解YApi。
## 登录与注册
想要使用 YApi ,首先要拥有账号,目前支持注册账号登录与QSSO登录两种方式
想要使用 YApi ,首先要注册账号。
<img src="./images/usage/login.png" />

View File

@ -13,9 +13,11 @@
## 获取权限
新用户登录后没有任何项目或分组的权限,只能浏览已存在分组下面的公开项目
新用户登录拥有 `个人空间` 分组下的全部权限,个人空间分组仅自己可见,因此可以在这里任意试用 YApi 的功能
如果找不到想找的项目,可能是未成为项目成员,此时应联系 `项目组长` 将你加入该项目。
除此以外没有任何项目或分组的权限,只能浏览已存在分组下面的公开项目。
如果找不到想找的项目,可能是尚未成为项目成员,此时应联系 `项目组长` 将你加入该项目。
[怎样联系组长?](./qa.html#Q__怎样联系组长)

View File

@ -169,7 +169,7 @@
<p>YApi 是高效、易用、功能强大的api管理平台。
<!-- 它有扁平化的管理结构(`超管`-`组长`-`组员`),有清晰的接口组织方式(`分组`-`项目`-`接口`)有更方便的mock方案。 --></p>
<p>在开始使用 YApi 之前,我们先来熟悉一下 YApi 的网站结构这将让你快速了解YApi。</p>
<h2 class="subject" id="登录与注册">登录与注册 <a class="hashlink" href="#登录与注册">#</a></h2><p>想要使用 YApi ,首先要拥有账号,目前支持注册账号登录与QSSO登录两种方式</p>
<h2 class="subject" id="登录与注册">登录与注册 <a class="hashlink" href="#登录与注册">#</a></h2><p>想要使用 YApi ,首先要注册账号。</p>
<p><img src="./images/usage/login.png" /></p>
<h2 class="subject" id="首页">首页 <a class="hashlink" href="#首页">#</a></h2><p>登录后进入首页,首页展示了分组与项目。</p>
<p>此时你作为新用户,没有任何分组与项目的权限,因此只能搜索、浏览 “公开项目” 的接口,如果在首页找不到任何项目,请联系管理员将你加入对应项目。</p>

Binary file not shown.

Before

Width:  |  Height:  |  Size: 273 KiB

After

Width:  |  Height:  |  Size: 172 KiB

View File

@ -149,7 +149,7 @@
<p>YApi 是高效、易用、功能强大的api管理平台。
<!-- 它有扁平化的管理结构(`超管`-`组长`-`组员`),有清晰的接口组织方式(`分组`-`项目`-`接口`)有更方便的mock方案。 --></p>
<p>在开始使用 YApi 之前,我们先来熟悉一下 YApi 的网站结构这将让你快速了解YApi。</p>
<h2 class="subject" id="登录与注册">登录与注册 <a class="hashlink" href="#登录与注册">#</a></h2><p>想要使用 YApi ,首先要拥有账号,目前支持注册账号登录与QSSO登录两种方式</p>
<h2 class="subject" id="登录与注册">登录与注册 <a class="hashlink" href="#登录与注册">#</a></h2><p>想要使用 YApi ,首先要注册账号。</p>
<p><img src="./images/usage/login.png" /></p>
<h2 class="subject" id="首页">首页 <a class="hashlink" href="#首页">#</a></h2><p>登录后进入首页,首页展示了分组与项目。</p>
<p>此时你作为新用户,没有任何分组与项目的权限,因此只能搜索、浏览 “公开项目” 的接口,如果在首页找不到任何项目,请联系管理员将你加入对应项目。</p>

View File

@ -167,8 +167,9 @@
<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><p>新用户登录后没有任何项目或分组的权限,只能浏览已存在分组下面的公开项目。</p>
<p>如果找不到想找的项目,可能是未成为项目成员,此时应联系 <code>项目组长</code> 将你加入该项目。</p>
<h2 class="subject" id="获取权限">获取权限 <a class="hashlink" href="#获取权限">#</a></h2><p>新用户登录拥有 <code>个人空间</code> 分组下的全部权限,个人空间分组仅自己可见,因此可以在这里任意试用 YApi 的功能。</p>
<p>除此以外没有任何项目或分组的权限,只能浏览已存在分组下面的公开项目。</p>
<p>如果找不到想找的项目,可能是尚未成为项目成员,此时应联系 <code>项目组长</code> 将你加入该项目。</p>
<p><a href="./qa.html#Q__怎样联系组长">怎样联系组长?</a></p>
<p><img src="./images/usage/manage_ask.png" /></p>
<ul>

View File

@ -8,6 +8,7 @@ $(document).ready(function() {
var $versionSelector = $('.version-selector');
var $versionMask = $('.m-version-mask');
var isPanelHide = true;
var winWidth = $(window).width();
var h2 = $('.content-right').find('h2');
var h3 = $('.content-right').find('h3');
var a = $('.content-left').find('a');

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long