mirror/yapi
2
0
Fork 0
mirror of https://github.com/YMFE/yapi.git synced 2024-12-21 05:19:42 +08:00
Code Issues Packages Projects Releases Wiki Activity

docs: add plugins docs

Browse Source
This commit is contained in:
suxiaoxin 2017-10-13 17:14:47 +08:00
parent b426ac7d74
commit baa22cf321
5 changed files with 26 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
doc/page/manage/build.md
View File

@ -20,10 +20,13 @@ npm install -g yapi-cli --registry https://registry.npm.taobao.org
yapi-cli server
```
## 更新
## 升级
升级项目版本是非常容易的，并且不会影响已有的项目数据，只会同步 vendors 目录下的源码文件。
cd {项目目录}
yapi-cli ls //查看版本号列表
yapi-cli update -v v1.1.0
yapi-cli update //升级到最新版本
yapi-cli update -v v1.1.0 //升级到指定版本
## 配置邮箱 (仅支持 SMTP)
打开项目目录 config.json 文件，新增 mail 配置， 替换默认的邮箱配置

3
doc/page/plugin/list.md
View File

@ -1,3 +1,6 @@
## 怎么分享我的插件？
Fork github.com/ymfe/yapi ，编辑根目录下的 plugin.json 文件， 然后 Pull-Request 到 ymfe/yapi
## 插件列表
<ul id="list">

8
static/doc/devops.html
View File

@ -92,7 +92,7 @@
<!-- <li > -->
<li >
<a href="#更新">更新</a>
<a href="#升级">升级</a>
</li>
<!-- <li > -->
@ -118,9 +118,11 @@ proxy_set_header Connection <span class="token string">"upgrade"</span><span cla
<h2 class="subject" id="安装">安装 <a class="hashlink" href="#安装">#</a></h2><p>执行 yapi-cli server 启动可视化部署程序，输入相应的配置和点击开始部署，就能完成整个网站的部署。部署完成之后，可按照提示信息，执行 node/{网站路径/server/app.js} 启动服务器。在浏览器打开指定url, 点击登录输入您刚才设置的管理员邮箱，默认密码(ymfe.org) 登录系统（默认密码可在个人中心修改）。</p>
<pre><code>npm install -g yapi-cli --registry https<span class="token operator">:</span>//registry.npm.taobao.org
yapi-cli server
</code></pre><h2 class="subject" id="更新">更新 <a class="hashlink" href="#更新">#</a></h2><pre><code>cd <span class="token punctuation">{</span>项目目录<span class="token punctuation">}</span>
</code></pre><h2 class="subject" id="升级">升级 <a class="hashlink" href="#升级">#</a></h2><p>升级项目版本是非常容易的，并且不会影响已有的项目数据，只会同步 vendors 目录下的源码文件。</p>
<pre><code>cd <span class="token punctuation">{</span>项目目录<span class="token punctuation">}</span>
yapi-cli ls //查看版本号列表
yapi-cli update -v v1<span class="token number">.1</span>.<span class="token number">0</span>
yapi-cli update //升级到最新版本
yapi-cli update -v v1<span class="token number">.1</span>.<span class="token number">0</span> //升级到指定版本
</code></pre><h2 class="subject" id="配置邮箱__仅支持_SMTP_">配置邮箱 (仅支持 SMTP) <a class="hashlink" href="#配置邮箱__仅支持_SMTP_">#</a></h2><p>打开项目目录 config.json 文件，新增 mail 配置， 替换默认的邮箱配置</p>
<pre><code><span class="token punctuation">{</span>
<span class="token property">"port"</span><span class="token operator">:</span> <span class="token string">"*****"</span><span class="token punctuation">,</span>

9
static/doc/plugin-list.html
View File

@ -110,8 +110,12 @@
<a href="plugin-list.html">插件列表</a>
</li>
<ul class="nav docs-sidenav-extend" style="display:block;" >
<ul class="nav docs-sidenav-extend" >
<li >
<a href="#怎么分享我的插件？">怎么分享我的插件？</a>
</li>
<li class="active" >
<a href="#插件列表">插件列表</a>
</li>
@ -124,7 +128,8 @@
<div class="content-right markdown-body use-sidebar" role="main">
<h2 class="subject" id="插件列表">插件列表 <a class="hashlink" href="#插件列表">#</a></h2><ul id="list">
<h2 class="subject" id="怎么分享我的插件？">怎么分享我的插件？ <a class="hashlink" href="#怎么分享我的插件？">#</a></h2><p>Fork github.com/ymfe/yapi ，编辑根目录下的 plugin.json 文件， 然后 Pull-Request 到 ymfe/yapi</p>
<h2 class="subject" id="插件列表">插件列表 <a class="hashlink" href="#插件列表">#</a></h2><ul id="list">
</ul>

7
static/doc/qa.html
View File

@ -149,6 +149,10 @@
<li >
<a href="#Q2__怎么快速把之前项目接口迁移过来？">Q2: 怎么快速把之前项目接口迁移过来？</a>
</li>
<li >
<a href="#Q3__忘记密码怎么办？">Q3: 忘记密码怎么办？</a>
</li>
</ul>
@ -160,7 +164,7 @@
<p>本页面罗列了大家使用 YApi 时遇到的常见问题.</p>
<p>如果没有找到您要的答案，请 qtalk 联系: <code>wenbo.dong; wenxiong.su; wenjie.zhang.</code></p>
<h2 class="subject" id="Q1__怎样联系组长？">Q1: 怎样联系组长？ <a class="hashlink" href="#Q1__怎样联系组长？">#</a></h2><p>A: 组长分为 <code>分组组长</code> 和 <code>项目组长</code>:</p>
<h2 class="subject" id="Q1__怎样联系组长？">Q1: 怎样联系组长？ <a class="hashlink" href="#Q1__怎样联系组长？">#</a></h2><p>组长分为 <code>分组组长</code> 和 <code>项目组长</code>:</p>
<ul>
<li>分组组长：选择首页左侧的分组，点击右侧面板的 <code>成员列表</code>，成员右侧显示着 <code>组长/开发者</code> 的权限信息。
<img src="./images/usage/manage_find_manager.png" /></li><li>项目组长: 点击项目页的 <code>设置</code> - <code>成员列表</code>，成员右侧显示着 <code>组长/开发者</code> 的权限信息。
@ -169,6 +173,7 @@
<p>第二步 录制当前项目所有请求，导出到har文件</p>
<p>第三步 将Har数据导入到YApi平台</p>
<p>具体使用方法请参考YApi<a href="./data.html#HAR%08%08_数据导入">文档</a></p>
<h2 class="subject" id="Q3__忘记密码怎么办？">Q3: 忘记密码怎么办？ <a class="hashlink" href="#Q3__忘记密码怎么办？">#</a></h2><p>请联系 <code>超级管理员</code> ，只有超级管理员能重置密码。</p>
</div>
</div>