Skip to content

Commit

Permalink
docs: fix path of preview image and relavant docs
Browse files Browse the repository at this point in the history
  • Loading branch information
mengxi-ream authored and xiaoluoHe committed Jun 18, 2024
1 parent fc94499 commit 8c6aa0a
Show file tree
Hide file tree
Showing 6 changed files with 24 additions and 24 deletions.
14 changes: 7 additions & 7 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -164,16 +164,16 @@ You can get started with using VChart through this type of task. VChart provides

After completing the task, you can submit the self-made case to the official website demo for more people in need to learn and use.

All demos are stored in the `docs/assets/examples `directory
All demos are stored in the `docs/assets/examples` directory

1. Please create a new `docs/*** `or `demo/*** `branch based on the develop branch for development
1. Please create a new `docs/***` or `demo/***` branch based on the develop branch for development
2. (If you have already installed, skip this step) Global installation [@microsoft/rush](https://rushjs.io/pages/intro/get_started/): `npm i --global @microsoft/rush`
3. Run `rush update`
4. Run `rush docs `to preview the current demo content locally
5. `Docs `directory
1. `Docs/assets/examples/menu.json `Add your demo information to the directory file
2. Complete the Chinese and English demo documents in the `zh `/ `en `directory respectively
3. Add the demo preview image in the `docs/public/vchart/preview `directory and update the relative path in the demo document
4. Run `rush docs` to preview the current demo content locally
5. `Docs` directory
1. `Docs/assets/examples/menu.json` Add your demo information to the directory file
2. Complete the Chinese and English demo documents in the `zh`/`en` directory respectively
3. Add the demo preview image in the `docs/public/vchart/preview` directory and update the path in the demo document accordingly, for example, `/vchart/preview/basic-map_1.9.1.png`
6. Submit all code and create a Pull Request on Github, inviting others to review

### Feature Task Development Guide
Expand Down
8 changes: 4 additions & 4 deletions CONTRIBUTING.zh-CN.md
Original file line number Diff line number Diff line change
Expand Up @@ -163,14 +163,14 @@ VChart 的入门问题,你可以通过 [issue 列表](https://github.com/VisAc

所有的 demo 存放在 `docs/assets/examples` 目录下

1. 请基于 develop 分支,新拉一个 `docs/***``demo/***` 分支进行开发
1. 请基于 develop 分支,新拉一个 `docs/***` `demo/***` 分支进行开发
2. (如果你已经安装,请跳过此步骤)全局安装 [@microsoft/rush](https://rushjs.io/pages/intro/get_started/)`npm i --global @microsoft/rush`
3. 根目录下运行 `rush update`
4. 运行`rush docs` 在本地预览目前 demo 内容
4. 运行 `rush docs` 在本地预览目前 demo 内容
5. `docs` 目录下:
1. `docs/assets/examples/menu.json` 目录文件中添加你的 demo 信息
2.`zh`/`en`目录下分别完成中英文 demo 文档
3.`docs/public/vchart/preview`目录下添加 demo 预览图片并将相对路径更新在 demo 文档中
2. `zh`/`en` 目录下分别完成中英文 demo 文档
3.`docs/public/vchart/preview` 目录下添加 demo 预览图片并将路径更新在 demo 文档中,例如 `/vchart/preview/basic-map_1.9.1.png`
6. 提交所有代码,并在 Github 创建 Pull Request,邀请其他人进行 review

### Feature Task 开发指南
Expand Down
2 changes: 1 addition & 1 deletion docs/assets/examples/en/bar-chart/bar-customized-label.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ category: examples
group: bar chart
title: Bar chart with custom label
keywords: barChart,comparison,distribution,rectangle,comparison,rank,axis,label
cover: ../../../../public/vchart/preview/bar-customized-label-en_1.11.1.png
cover: /vchart/preview/bar-customized-label-en_1.11.1.png
option: barChart
---

Expand Down
2 changes: 1 addition & 1 deletion docs/assets/examples/zh/bar-chart/bar-customized-label.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ category: examples
group: bar chart
title: 自定义标签的条形图
keywords: barChart,comparison,distribution,rectangle,comparison,rank,axis,label
cover: ../../../../public/vchart/preview/bar-customized-label_1.11.1.png
cover: /vchart/preview/bar-customized-label_1.11.1.png
option: barChart
---

Expand Down
14 changes: 7 additions & 7 deletions docs/assets/guide/en/tutorial_docs/Contribution_Guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -164,16 +164,16 @@ You can get started with using VChart through this type of task. VChart provides

After completing the task, you can submit the self-made case to the official website demo for more people in need to learn and use.

All demos are stored in the `docs/assets/examples `directory
All demos are stored in the `docs/assets/examples` directory

1. Please create a new `docs/*** `or `demo/*** `branch based on the develop branch for development
1. Please create a new `docs/***` or `demo/***` branch based on the develop branch for development
2. (If you have already installed, skip this step) Global installation [@microsoft/rush](https://rushjs.io/pages/intro/get_started/): `npm i --global @microsoft/rush`
3. Run `rush update`
4. Run `rush docs `to preview the current demo content locally
5. `Docs `directory
1. `Docs/assets/examples/menu.json `Add your demo information to the directory file
2. Complete the Chinese and English demo documents in the `zh `/ `en `directory respectively
3. Add the demo preview image in the `docs/public/vchart/preview `directory and update the relative path in the demo document
4. Run `rush docs` to preview the current demo content locally
5. `Docs` directory
1. `Docs/assets/examples/menu.json` Add your demo information to the directory file
2. Complete the Chinese and English demo documents in the `zh`/`en` directory respectively
3. Add the demo preview image in the `docs/public/vchart/preview` directory and update the path in the demo document accordingly, for example, `/vchart/preview/basic-map_1.9.1.png`
6. Submit all code and create a Pull Request on Github, inviting others to review

### Feature Task Development Guide
Expand Down
8 changes: 4 additions & 4 deletions docs/assets/guide/zh/tutorial_docs/Contribution_Guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -163,14 +163,14 @@ VChart 的入门问题,你可以通过 [issue 列表](https://github.com/VisAc

所有的 demo 存放在 `docs/assets/examples` 目录下

1. 请基于 develop 分支,新拉一个 `docs/***``demo/***` 分支进行开发
1. 请基于 develop 分支,新拉一个 `docs/***` `demo/***` 分支进行开发
2. (如果你已经安装,请跳过此步骤)全局安装 [@microsoft/rush](https://rushjs.io/pages/intro/get_started/)`npm i --global @microsoft/rush`
3. 根目录下运行 `rush update`
4. 运行`rush docs` 在本地预览目前 demo 内容
4. 运行 `rush docs` 在本地预览目前 demo 内容
5. `docs` 目录下:
1. `docs/assets/examples/menu.json` 目录文件中添加你的 demo 信息
2.`zh`/`en`目录下分别完成中英文 demo 文档
3.`docs/public/vchart/preview`目录下添加 demo 预览图片并将相对路径更新在 demo 文档中
2. `zh`/`en` 目录下分别完成中英文 demo 文档
3.`docs/public/vchart/preview` 目录下添加 demo 预览图片并将路径更新在 demo 文档中,例如 `/vchart/preview/basic-map_1.9.1.png`
6. 提交所有代码,并在 Github 创建 Pull Request,邀请其他人进行 review

### Feature Task 开发指南
Expand Down

0 comments on commit 8c6aa0a

Please sign in to comment.