Skip to content

Commit 8b9ac6c

Browse files
committed
docs: add description of docs in contributing guide
1 parent 359c639 commit 8b9ac6c

File tree

2 files changed

+28
-0
lines changed

2 files changed

+28
-0
lines changed

docs/contributing.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -110,3 +110,17 @@ The `lint` script uses ESLint to check all source files.
110110
### `yarn test`
111111

112112
The `test` script uses Jest to run unit testings.
113+
114+
## Documentation
115+
116+
VuePress documentation is powered by VuePress itself, which is built from the source code of this repository.
117+
118+
All the markdown source files are placed in `docs` directory. We are maintaining with two translations:
119+
120+
- English (en-US) in `/` path
121+
- Chinese (zh-CN) in `/zh/` path
122+
123+
We have two different deployments:
124+
125+
- Release deployment powered by [Netlify](https://www.netlify.com). This deployment is built from the latest released version, so users will not see unreleased changes. The domain name is [https://vuepress2.netlify.app](https://vuepress2.netlify.app).
126+
- Developer deployment powered by [GitHub Pages](https://pages.github.com). This deployment is built from the latest commit, so developers could preview the latest changes. The domain name is [https://vuepress.github.io](https://vuepress.github.io).

docs/zh/contributing.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -110,3 +110,17 @@ VuePress 使用它自己来构建自己的文档网站。
110110
### `yarn test`
111111

112112
`test` 命令使用 Jest 来运行单元测试。
113+
114+
## 文档
115+
116+
VuePress 的文档是由 VuePress 自己驱动的,是由该仓库中的源码构建而来。
117+
118+
所有的 Markdown 源文件都放置在 `docs` 目录下。我们维护了两种翻译:
119+
120+
- 英语 (en-US) 在 `/` 路径下
121+
- 中文 (zh-CN) 在 `/zh/` 路径下
122+
123+
我们部署了两套站点:
124+
125+
-[Netlify](https://www.netlify.com) 部署的 Release 版本。该站点是从最新发布的版本中构建而来,因此用户不会看到未发布的改动。域名为 [https://vuepress2.netlify.app](https://vuepress2.netlify.app)
126+
-[GitHub Pages](https://pages.github.com) 部署的 Developer 版本。该站点是从最新的提交中构建而来,因此开发者可以预览最新的改动。域名为 [https://vuepress.github.io](https://vuepress.github.io)

0 commit comments

Comments
 (0)