本仓库保存了 MeterSphere 项目 的 官方文档，该文档使用 MkDocs 文档框架下的 Material for MkDocs 主题进行构建。

本地开发

克隆本仓库

  1. git clone https://github.com/metersphere/docs.git

安装依赖

  1. cd docs
  2. pip install -r requirements/requirements.txt

修改文档内容

本文档的文档结构定义在 mkdocs.yml 文件中，文档的具体内容均在 docs 目录中。

  1. ..........
  2. nav:
  3.     - 项目介绍: index.md
  4.     - 快速开始:
  5.           - 一键部署: quick_start/quick_start.md
  6.           - 创建项目: quick_start/create_project.md
  7.           - 使用测试跟踪: quick_start/test_track.md
  8.           - 使用接口测试: quick_start/api_test.md
  9.           - 使用性能测试: quick_start/load_test.md
  10.     - 系统架构: system_arch.md
  11.     - 安装部署:
  12.           - 在线安装: installation/online_installation.md
  13.           - 离线安装: installation/offline_installation.md
  14.           - 在线升级: installation/online_upgrade.md
  15.           - 离线升级: installation/offline_upgrade.md
  16.     - 用户手册:
  17.           - 通用功能: user_manual/general.md
  18.           - 测试跟踪:
  19.                 - 模块说明: user_manual/test_track/intro.md
  20.                 - 首页: user_manual/test_track/home.md
  21.                 - 功能用例: user_manual/test_track/test_case.md
  22.                 - 用例评审: user_manual/test_track/test_case_review.md
  23.                 - 测试计划: user_manual/test_track/test_plan.md
  24.                 - 缺陷管理: user_manual/test_track/test_defect.md
  25.                 - 报告: user_manual/test_track/test_report.md
  26.           - 接口测试:
  27.                 - 模块说明: user_manual/api_test/intro.md
  28.                 - 首页: user_manual/api_test/home.md
  29.                 - 接口定义: user_manual/api_test/api_definition.md
  30.                 - 接口自动化: user_manual/api_test/api_automation.md
  31.                 - 接口测试报告中心: user_manual/api_test/test_report.md
  32.                 - 用例步骤说明: user_manual/api_test/api_step.md
  33.                 - 内置函数: user_manual/api_test/functions.md
  34.           - 性能测试:
  35.                 - 模块说明: user_manual/load_test/intro.md
  36.                 - 首页: user_manual/load_test/home.md
  37.                 - 性能测试: user_manual/load_test/load_test.md
  38.                 - 性能测试报告中心: user_manual/load_test/test_report.md
  39.           - 项目设置:
  40.                 - 项目信息: user_manual/project_management/project_info.md
  41.                 - 项目成员: user_manual/project_management/project_user.md
  42.                 - 用户组与权限: user_manual/prosject_management/usergroup_permission.md
  43.                 - 项目环境: user_manual/project_management/project_environment.md
  44.                 - 文件管理: user_manual/project_management/file_management.md
  45.                 - 自定义代码片段: user_manual/project_management/customcode_snippets.md
  46.                 - 操作日志: user_manual/project_management/operation_log.md
  47.                 - 应用管理: user_manual/project_management/application_management.md
  48.           - 系统设置:
  49.                 - 模块说明: user_manual/system_management/intro.md
  50.                 - 系统管理: user_manual/system_management/system.md
  51.                 - 工作空间管理: user_manual/system_management/workspace.md
  52.                 - 项目管理: user_manual/system_management/project.md
  53.                 - 个人信息管理: user_manual/system_management/personal.md      
  54.     - 使用教程:
  55.           - 使用 MeterSphere 进行 Dubbo 接口测试: tutorial/dubbo.md
  56.           - 使用 MeterSphere 进行场景化接口测试: tutorial/api_testing.md
  57.           - 使用预执行脚本功能生成接口认证签名: tutorial/pre_processor.md
  58.           - 【视频】MeterSphere 如何与 TAPD和 Jira 对接: https://www.bilibili.com/video/BV1jr4y1c7Lg/
  59.           - 【视频】MeterSphere 如何对接邮件、钉钉、企业微信: https://www.bilibili.com/video/BV1dp4y167ch/
  60.           - 【视频】如何在 MeterSphere 中做场景化的接口测试: https://www.bilibili.com/video/BV1vy4y1q7f7/
  61.           - 【视频】如何在 MeterSphere 中导入 Postman 脚本做接口测试: https://www.bilibili.com/video/BV1W54y1C7uY
  62.           - 【视频】如何在 MeterSphere 中导入 Swagger UI 脚本做接口测试: https://www.bilibili.com/video/BV1YK411A7E8/
  63.     - 常见问题:
  64.           - 安装部署相关: faq/installation.md
  65.           - 测试跟踪相关: faq/test_track.md
  66.           - 接口测试相关: faq/api_test.md
  67.           - 性能测试相关: faq/load_test.md
  68.           - 报表统计相关: faq/report_statistics.md
  69.           - 系统设置相关: faq/system_management.md
  70.           - 企业版相关: faq/enterprise.md
  71.     - 开发文档: dev_manual.md
  72.     - 用户案例:
  73.           - 88完美邮箱全面提升产品质量的落地指南: case_studies/88com.md
  74.           - 蔚澜环保基于MeterSphere的自动化测试实践: case_studies/weilanep.md
  75.           - 易盛信息MeterSphere接口测试使用经验: case_studies/esunny.md
  76.           - 永福信息基于MeterSphere从项目维度持续推进测试任务: case_studies/yongfu.md
  77.           - 九里云基于MeterSphere落地一站式自动化测试平台: case_studies/jiuliyun.md
  78.           - 民生科技基于MeterSphere平台实现测试用例复用: case_studies/mskj.md
  79.           - 360借助MeterSphere提升自动化测试水平: case_studies/360b.md
  80.     - 更新说明: about/changelog.md
  81.     - 联系我们: about/contact.md
  82.     - JMeter 资源合集: awesome-jmeter.md
  83.     - 企业版试用: enterprise.md
  84. ..........

文档内容使用 markdown 语法编写，若要添加新的文档，需要先在 mkdocs.yml 文件中的 nav 部分增加对应章节导航。

本地调试文档

  1. mkdocs serve

执行上述命令后，可通过 http://127.0.0.1:8000 地址查看生成的文档内容，当修改文档后，页面内容会自动更新。

构建文档

  1. mkdocs build

执行上述命令后，会在 site 目录下生成文档站点的静态文件，将目录中的内容复制到任意 HTTP 服务器上即可完成文档的部署。

帮助完善文档

Fork 文档仓库

点击仓库右上角的 fork 按钮，复制本仓库到自己的 github 账号。

克隆 fork 后的仓库

  1. git clone https://github.com/your-github-account/docs.git

本地修改并调试

Push 修改内容到 GitHub 仓库

提交 Pull Request 到本仓库

问题反馈

如果您发现文档中存在错误，或对文档内容存在疑问，请提交 GitHub Issue 到 MeterSphere 项目的主仓库