mirror/yapi
2
0
Fork 0
mirror of https://github.com/YMFE/yapi.git synced 2025-01-18 13:04:46 +08:00
Code Issues Packages Projects Releases Wiki Activity

docs: opti

Browse Source
This commit is contained in:
suxiaoxin 2017-11-06 19:31:43 +08:00
parent 5f743d60e2
commit 441cb0bbb2
4 changed files with 29 additions and 15 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -1,5 +1,5 @@
# 内网部署
使用我们提供的 yapi-cli 工具，部署 YApi 平台是非常容易的。建议部署成 http 站点，因 chrome 浏览器安全限制，部署成 https 会导致 测试功能的文件上传功能异常。
使用我们提供的 yapi-cli 工具，部署 YApi 平台是非常容易的。建议部署成 http 站点，因 chrome 浏览器安全限制，部署成 https 会导致测试功能在请求 http 站点时文件上传功能异常。
如果您是将服务器代理到 nginx 服务器，请配置 nginx 支持 websocket。
```

14
doc/page/usage/qa.md
View File

@ -2,7 +2,7 @@
如果没有找到您要的答案，请联系管理员.
## Q1: 怎样联系组长？
## Q1 怎样联系组长？
组长分为 `分组组长` 和 `项目组长`:
- 分组组长：选择首页左侧的分组，点击右侧面板的 `成员列表`，成员右侧显示着 `组长/开发者` 的权限信息。
@ -10,7 +10,7 @@
- 项目组长: 点击项目页的 `设置` - `成员列表`，成员右侧显示着 `组长/开发者` 的权限信息。
<img src="./images/usage/manage_find_project_owner.png" />
## Q2: 怎么快速迁移旧项目？
## Q2 怎么快速迁移旧项目？
第一步. 使用 Chrome 浏览器开发者工具录制功能
@ -20,14 +20,20 @@
具体使用方法请参考 YApi <a href="./data.html#HAR%08%08_数据导入">文档</a>
## Q3: 忘记密码怎么办？
## Q3 忘记密码怎么办？
请联系 `超级管理员` ，只有超级管理员能重置密码。
## 04: 发现了 Bug 怎么办？
## Q4 发现了 Bug 怎么办？
请反馈到 <a href="https://github.com/YMFE/yapi/issues" _blank="target">Github</a>，功能性的问题我们会在一周内修复，并在每周一发布新的版本 Tag.
## Q5 可视化部署一直处于 github 压缩包下载状态怎么办？
可按 Ctrl + c 中断部署操作，然后删除之前部署的文件，重新部署。
如果还是不行，请参考 文档 -> 内网部署 -> <a href="https://yapi.ymfe.org/devops.html#方式二. 命令行部署" >命令行部署</a> 文档
<br>
<br>
<br>

4
static/doc/devops.html
View File

@ -139,7 +139,7 @@
<div class="content-right markdown-body use-sidebar" role="main">
<h1 class="subject" id="内网部署">内网部署 <a class="hashlink" href="#内网部署">#</a></h1><p>使用我们提供的 yapi-cli 工具，部署 YApi 平台是非常容易的。建议部署成 http 站点，因 chrome 浏览器安全限制，部署成 https 会导致 测试功能的文件上传功能异常。</p>
<h1 class="subject" id="内网部署">内网部署 <a class="hashlink" href="#内网部署">#</a></h1><p>使用我们提供的 yapi-cli 工具，部署 YApi 平台是非常容易的。建议部署成 http 站点，因 chrome 浏览器安全限制，部署成 https 会导致测试功能在请求 http 站点时文件上传功能异常。</p>
<p>如果您是将服务器代理到 nginx 服务器，请配置 nginx 支持 websocket。</p>
<pre><code>在location /添加
proxy_http_version <span class="token number">1.1</span><span class="token punctuation">;</span>
@ -156,7 +156,7 @@ cd yapi
git clone https<span class="token operator">:</span>//github.com/YMFE/yapi.git vendors //或者下载 zip 包解压到 vendors 目录
cp vendors/config_example.json ./config.json //复制完成后请修改相关配置
cd vendors
npm install --production
npm install --production --registry https<span class="token operator">:</span>//registry.npm.taobao.org
npm run install-server //安装程序会初始化数据库索引和管理员账号，管理员账号名可在 config.json 配置
node server/app.js //启动服务器后，请访问 <span class="token number">127.0</span>.<span class="token number">0.1</span><span class="token operator">:</span><span class="token punctuation">{</span>config.json配置的端口<span class="token punctuation">}</span>，初次运行会有个编译的过程，请耐心等候
</code></pre><h2 class="subject" id="升级">升级 <a class="hashlink" href="#升级">#</a></h2><p>升级项目版本是非常容易的，并且不会影响已有的项目数据，只会同步 vendors 目录下的源码文件。</p>

24
static/doc/qa.html
View File

@ -100,25 +100,31 @@
<!-- <li > -->
<li >
<a href="#Q1: 怎样联系组长？">Q1: 怎样联系组长？</a>
<a href="#Q1 怎样联系组长？">Q1 怎样联系组长？</a>
</li>
<!-- <li > -->
<li >
<a href="#Q2: 怎么快速迁移旧项目？">Q2: 怎么快速迁移旧项目？</a>
<a href="#Q2 怎么快速迁移旧项目？">Q2 怎么快速迁移旧项目？</a>
</li>
<!-- <li > -->
<li >
<a href="#Q3: 忘记密码怎么办？">Q3: 忘记密码怎么办？</a>
<a href="#Q3 忘记密码怎么办？">Q3 忘记密码怎么办？</a>
</li>
<!-- <li > -->
<li >
<a href="#04: 发现了 Bug 怎么办？">04: 发现了 Bug 怎么办？</a>
<a href="#Q4 发现了 Bug 怎么办？">Q4 发现了 Bug 怎么办？</a>
</li>
<!-- <li > -->
<li >
<a href="#Q5 可视化部署一直处于 github 压缩包下载状态怎么办？">Q5 可视化部署一直处于 github 压缩包下载状态怎么办？</a>
</li>
</ul>
@ -129,17 +135,19 @@
<p>本页面罗列了大家使用 YApi 时遇到的常见问题.</p>
<p>如果没有找到您要的答案，请联系管理员.</p>
<h2 class="subject" id="Q1__怎样联系组长？">Q1: 怎样联系组长？ <a class="hashlink" href="#Q1__怎样联系组长？">#</a></h2><p>组长分为 <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> 的权限信息。
<img src="./images/usage/manage_find_project_owner.png" /></li></ul>
<h2 class="subject" id="Q2__怎么快速迁移旧项目？">Q2: 怎么快速迁移旧项目？ <a class="hashlink" href="#Q2__怎么快速迁移旧项目？">#</a></h2><p>第一步. 使用 Chrome 浏览器开发者工具录制功能</p>
<h2 class="subject" id="Q2_怎么快速迁移旧项目？">Q2 怎么快速迁移旧项目？ <a class="hashlink" href="#Q2_怎么快速迁移旧项目？">#</a></h2><p>第一步. 使用 Chrome 浏览器开发者工具录制功能</p>
<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>
<h2 class="subject" id="04__发现了_Bug_怎么办？">04: 发现了 Bug 怎么办？ <a class="hashlink" href="#04__发现了_Bug_怎么办？">#</a></h2><p>请反馈到 <a href="https://github.com/YMFE/yapi/issues" _blank="target">Github</a>，功能性的问题我们会在一周内修复，并在每周一发布新的版本 Tag.</p>
<h2 class="subject" id="Q3_忘记密码怎么办？">Q3 忘记密码怎么办？ <a class="hashlink" href="#Q3_忘记密码怎么办？">#</a></h2><p>请联系 <code>超级管理员</code> ，只有超级管理员能重置密码。</p>
<h2 class="subject" id="Q4_发现了_Bug_怎么办？">Q4 发现了 Bug 怎么办？ <a class="hashlink" href="#Q4_发现了_Bug_怎么办？">#</a></h2><p>请反馈到 <a href="https://github.com/YMFE/yapi/issues" _blank="target">Github</a>，功能性的问题我们会在一周内修复，并在每周一发布新的版本 Tag.</p>
<h2 class="subject" id="Q5_可视化部署一直处于_github_压缩包下载状态怎么办？">Q5 可视化部署一直处于 github 压缩包下载状态怎么办？ <a class="hashlink" href="#Q5_可视化部署一直处于_github_压缩包下载状态怎么办？">#</a></h2><p>可按 Ctrl + c 中断部署操作，然后删除之前部署的文件，重新部署。</p>
<p>如果还是不行，请参考 文档 -&gt; 内网部署 -&gt; <a href="https://yapi.ymfe.org/devops.html#方式二. 命令行部署" >命令行部署</a> 文档</p>
<p><br>
<br>
<br>