# qa docs

**Repository Path**: pupie/qa-docs

## Basic Information

- **Project Name**: qa docs
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2020-03-10
- **Last Updated**: 2020-12-19

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

---
home: true
features:
  - title: Web
    details: QA Docs项目Web系统。
  - title: iOS
    details: iOS App是苹果系统的程序。
  - title: android
    details: Android App是安卓系统的程序。

footer: caozhiye | Copyright © 2019-present
---

# QA文档项目(QA DOCS)

<p align="center">
  <a href="https://www.thoughtworks.com/" target="_blank">
    <img width="480" src="https://www.thoughtworks.com/imgs/tw-logo.svg" alt="logo">
  </a>
</p>

```
why docs?

需要一个git仓库(name: qa-docs)管理文档，方便团队成员之间的协作。例如:

* 越来越多的Feature环境信息
* 各维护项目的背景知识
* 服务架构的线框图
* app各版本下载链接管理(staging/prod/debug)
* QA&Dev记录查询bug案例的经验方法
* 文档需要git的版本管理机制
```

## 项目背景
QA DOCS项目由TWer来维护的。

## New to QA Docs
:::warning Rampups
欢迎加入Thoughtworks！

请首先关注一下[团队成员](/team/team-member.md)
:::

## 如何在本地使用文档?
by [Markdown](https://v1.vuepress.vuejs.org/guide/markdown.html)
### 使用Docker [推荐]
之所以推荐使用Docker，是因为这样可以规避环境中Node版本以及其他的依赖问题
- Install docker in MacOS [https://docs.docker.com/docker-for-mac/install/](https://docs.docker.com/docker-for-mac/install/)

- Run doc service `docker-compose up -d`

- Open website [http://localhost:4000/](http://localhost:4000/)

### 使用NodeJs
对于NodeJs大拿们来说，也许这样更习惯

- Install nodejs. recommend [Nvm](https://github.com/nvm-sh/nvm) install.

```bash
curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.35.0/install.sh | bash
nvm install v10.16.0
```

- Install vuepress
```bash
npm install -g vuepress --registry https://registry.npm.taobao.org
```

- Start doc server `npm i && npm run doc`

- Open website [http://localhost:8080/](http://localhost:8080/)