docs: upgrade api docs #2818

BBSQQ · 2020-09-10T11:43:17Z

Checklist

npm test passes
tests and/or benchmarks are included
commit message follows commit guidelines

Description of change

Rewrite api documents

accesslint

There are accessibility issues in these changes.

README.md

accesslint · 2020-09-10T11:43:27Z

README.zh-CN.md

@@ -27,7 +27,7 @@ G2 是一套基于图形语法理论的可视化底层引擎，以数据驱动

 ## 📺 线上示例

-<a href="https://g2.antv.vision/zh/examples/gallery"><img src="https://user-images.githubusercontent.com/6628666/75466330-fe1d0c00-59c4-11ea-91ba-506f60ef8af4.png" /></a>
+<a href="https://g2.antv.vision/zh/examples/gallery"><img src="https://user-images.githubusercontent.com/6628666/75466330-fe1d0c00-59c4-11ea-91ba-506f60ef8af4.png" style='width: 100%'/></a>


This image is missing a text alternative (alt attribute). This is a problem for people using screen readers.

accesslint · 2020-09-10T11:43:27Z

docs/api-zh/chart.md

+
+| 默认交互          | 描述                                                                          | 效果展示                                                                                                |
+| ----------------- | ----------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- |
+| tooltip           | 鼠标在 chart 上移动时显示提示信息                                             | <img src="https://gw.alipayobjects.com/mdn/rms_f5c722/afts/img/A*UMsFRZwIDvMAAAAAAAAAAABkARQnAQ">       |


This image is missing a text alternative (alt attribute). This is a problem for people using screen readers.

accesslint · 2020-09-10T11:43:27Z

docs/api-zh/chart.md

+| 默认交互          | 描述                                                                          | 效果展示                                                                                                |
+| ----------------- | ----------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- |
+| tooltip           | 鼠标在 chart 上移动时显示提示信息                                             | <img src="https://gw.alipayobjects.com/mdn/rms_f5c722/afts/img/A*UMsFRZwIDvMAAAAAAAAAAABkARQnAQ">       |
+| legend-active     | 鼠标移动到图例选项时，图例项高亮，对应的图形高亮                              | <img src="https://gw.alipayobjects.com/mdn/rms_f5c722/afts/img/A*fjkTR70h9YAAAAAAAAAAAABkARQnAQ">       |


This image is missing a text alternative (alt attribute). This is a problem for people using screen readers.

accesslint · 2020-09-10T11:43:28Z

docs/api-zh/chart.md

+| ----------------- | ----------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- |
+| tooltip           | 鼠标在 chart 上移动时显示提示信息                                             | <img src="https://gw.alipayobjects.com/mdn/rms_f5c722/afts/img/A*UMsFRZwIDvMAAAAAAAAAAABkARQnAQ">       |
+| legend-active     | 鼠标移动到图例选项时，图例项高亮，对应的图形高亮                              | <img src="https://gw.alipayobjects.com/mdn/rms_f5c722/afts/img/A*fjkTR70h9YAAAAAAAAAAAABkARQnAQ">       |
+| legend-filter     | 分类图例的勾选                                                                | <img src="https://gw.alipayobjects.com/mdn/rms_f5c722/afts/img/A*qKwJTbpJLyUAAAAAAAAAAABkARQnAQ">       |


This image is missing a text alternative (alt attribute). This is a problem for people using screen readers.

accesslint · 2020-09-10T11:43:28Z

docs/api-zh/chart.md

+| tooltip           | 鼠标在 chart 上移动时显示提示信息                                             | <img src="https://gw.alipayobjects.com/mdn/rms_f5c722/afts/img/A*UMsFRZwIDvMAAAAAAAAAAABkARQnAQ">       |
+| legend-active     | 鼠标移动到图例选项时，图例项高亮，对应的图形高亮                              | <img src="https://gw.alipayobjects.com/mdn/rms_f5c722/afts/img/A*fjkTR70h9YAAAAAAAAAAAABkARQnAQ">       |
+| legend-filter     | 分类图例的勾选                                                                | <img src="https://gw.alipayobjects.com/mdn/rms_f5c722/afts/img/A*qKwJTbpJLyUAAAAAAAAAAABkARQnAQ">       |
+| continuous-filter | 连续图例的过滤                                                                | <img src="https://gw.alipayobjects.com/mdn/rms_f5c722/afts/img/A*pe97RKJM_XAAAAAAAAAAAABkARQnAQ">       |


This image is missing a text alternative (alt attribute). This is a problem for people using screen readers.

accesslint · 2020-09-10T11:43:28Z

docs/api-zh/geom-fun.md

+3. jitter：扰动散开，将数据的位置轻微的调整，使得映射后的图形位置不再重叠。仅适用于分类数据，将分类数据转换成索引值，在索引值 [ -0.5 ,0.5 ] 的范围内进行随机分布。
+   <img alt='jitter' src='https://gw.alipayobjects.com/mdn/rms_f5c722/afts/img/A*c_oTS4jAICkAAAAAAAAAAAAAARQnAQ' width='100%' style='max-width: 900px'/>
+4. symmetric：数据对称，使得生成的图形居中对齐，例如河流图、漏斗图。
+   <img src="https://gw.alipayobjects.com/mdn/rms_f5c722/afts/img/A*igxpSIu_xngAAAAAAAAAAABkARQnAQ" width='100%' style='max-width: 900px'>


This image is missing a text alternative (alt attribute). This is a problem for people using screen readers.

hustcc · 2020-09-11T10:45:38Z

这么大的改动！问几个问题：

如果这个更新部署之后，原网站文档中的地址和新文档地址，有多少保持一致，多少地址变化掉，变化掉的会有自动跳转嘛？
新文档地址怎么避免 404？

BBSQQ · 2020-09-11T10:59:16Z

这么大的改动！问几个问题：

如果这个更新部署之后，原网站文档中的地址和新文档地址，有多少保持一致，多少地址变化掉，变化掉的会有自动跳转嘛？

新文档地址怎么避免 404？

没有自动跳转。之前上的那版定位是为了填补 API 空缺临时上的，再之前下线的那版机器生成的就更没有链接存留了。这个问题记下了，确实需要从官网层面解决。
这次我人肉检查了404，之后 Gatsby 层会出一个解决方案，自动检查无效链接。上报 404 链接 gatsby-theme-antv#202

docs/api-zh/chart-fun.md

hustcc · 2020-09-14T01:38:33Z

docs/api-zh/geom-fun.md

@@ -0,0 +1,424 @@
+<!--## geometry方法-->


同理，命名上既有 fun 又有 api 的~~统一成一个词可以嘛~~

done 统一为 func

hustcc · 2020-09-14T01:39:46Z

docs/api-zh/geom.md

@@ -0,0 +1,90 @@
+<!--## chart\[geom\](options) 创建几何标记-->


geometry 都用全称吧，包括 coord。g2 v4 后的一些 api 都是改成了全称，比如 coord ---> coordinate.

hustcc · 2020-09-14T01:40:44Z

docs/api-zh/register.md

+
+### G2.registerEngine
+
+注册渲染引擎，目前 G2 支持 svg canvas。


这个直接去掉吧，不用让外部开发感知。

hustcc · 2020-09-14T01:47:57Z

docs/common/AnnotationBaseOption.md

@@ -0,0 +1,29 @@
+#### option.top


文件命名，小写+连接线。

hustcc · 2020-09-14T01:51:42Z

yarn.lock 文件去掉。

accesslint

There are accessibility issues in these changes.

accesslint · 2020-09-14T02:33:01Z

docs/api-zh/geometry-func.md

+3. jitter：扰动散开，将数据的位置轻微的调整，使得映射后的图形位置不再重叠。仅适用于分类数据，将分类数据转换成索引值，在索引值 [ -0.5 ,0.5 ] 的范围内进行随机分布。
+   <img alt='jitter' src='https://gw.alipayobjects.com/mdn/rms_f5c722/afts/img/A*c_oTS4jAICkAAAAAAAAAAAAAARQnAQ' width='100%' style='max-width: 900px'/>
+4. symmetric：数据对称，使得生成的图形居中对齐，例如河流图、漏斗图。
+   <img src="https://gw.alipayobjects.com/mdn/rms_f5c722/afts/img/A*igxpSIu_xngAAAAAAAAAAABkARQnAQ" width='100%' style='max-width: 900px'>


This image is missing a text alternative (alt attribute). This is a problem for people using screen readers.

accesslint

There are accessibility issues in these changes.

accesslint · 2020-09-14T02:36:24Z

docs/api-zh/geometry-func.md

+3. jitter：扰动散开，将数据的位置轻微的调整，使得映射后的图形位置不再重叠。仅适用于分类数据，将分类数据转换成索引值，在索引值 [ -0.5 ,0.5 ] 的范围内进行随机分布。
+   <img alt='jitter' src='https://gw.alipayobjects.com/mdn/rms_f5c722/afts/img/A*c_oTS4jAICkAAAAAAAAAAAAAARQnAQ' width='100%' style='max-width: 900px'/>
+4. symmetric：数据对称，使得生成的图形居中对齐，例如河流图、漏斗图。
+   <img src="https://gw.alipayobjects.com/mdn/rms_f5c722/afts/img/A*igxpSIu_xngAAAAAAAAAAABkARQnAQ" width='100%' style='max-width: 900px'>


This image is missing a text alternative (alt attribute). This is a problem for people using screen readers.

BBSQQ · 2020-09-14T02:37:32Z

yarn.lock 文件去掉。

done

hustcc · 2020-09-14T02:44:38Z

docs/api/coord.zh.md

@@ -0,0 +1,6 @@
+---


coordinate 文件名。

hustcc · 2020-09-14T02:45:22Z

docs/api/geom.en.md

@@ -0,0 +1,8 @@
+---


geometry 拆分成三层是为什么

hustcc · 2020-09-14T02:45:45Z

docs/common/Region.md

@@ -0,0 +1,14 @@
+_Region_ 结构如下：


这里还有一个文件命名问题。

accesslint

There are accessibility issues in these changes.

accesslint · 2020-09-14T02:54:38Z

docs/api-zh/geometry-func.md

+3. jitter：扰动散开，将数据的位置轻微的调整，使得映射后的图形位置不再重叠。仅适用于分类数据，将分类数据转换成索引值，在索引值 [ -0.5 ,0.5 ] 的范围内进行随机分布。
+   <img alt='jitter' src='https://gw.alipayobjects.com/mdn/rms_f5c722/afts/img/A*c_oTS4jAICkAAAAAAAAAAAAAARQnAQ' width='100%' style='max-width: 900px'/>
+4. symmetric：数据对称，使得生成的图形居中对齐，例如河流图、漏斗图。
+   <img src="https://gw.alipayobjects.com/mdn/rms_f5c722/afts/img/A*igxpSIu_xngAAAAAAAAAAABkARQnAQ" width='100%' style='max-width: 900px'>


This image is missing a text alternative (alt attribute). This is a problem for people using screen readers.

accesslint

There are accessibility issues in these changes.

accesslint · 2020-09-14T03:12:29Z

docs/api-zh/geometry-func.md

+3. jitter：扰动散开，将数据的位置轻微的调整，使得映射后的图形位置不再重叠。仅适用于分类数据，将分类数据转换成索引值，在索引值 [ -0.5 ,0.5 ] 的范围内进行随机分布。
+   <img alt='jitter' src='https://gw.alipayobjects.com/mdn/rms_f5c722/afts/img/A*c_oTS4jAICkAAAAAAAAAAAAAARQnAQ' width='100%' style='max-width: 900px'/>
+4. symmetric：数据对称，使得生成的图形居中对齐，例如河流图、漏斗图。
+   <img src="https://gw.alipayobjects.com/mdn/rms_f5c722/afts/img/A*igxpSIu_xngAAAAAAAAAAABkARQnAQ" width='100%' style='max-width: 900px'>


This image is missing a text alternative (alt attribute). This is a problem for people using screen readers.

docs: upgrade api docs

d854e48

BBSQQ requested review from simaQ, hustcc, pddpd, visiky, arranzeyuwang and lxfu1 September 10, 2020 11:43

auto-add-label bot added the Documentation label Sep 10, 2020

pr-triage bot added the PR: unreviewed label Sep 10, 2020

accesslint bot suggested changes Sep 10, 2020

View reviewed changes

pr-triage bot added PR: reviewed-changes-requested and removed PR: unreviewed labels Sep 10, 2020

docs: fix some format issues

8c2155c

pr-triage bot added PR: unreviewed and removed PR: reviewed-changes-requested labels Sep 11, 2020

docs: fix some md

593b6e8

hustcc reviewed Sep 14, 2020

View reviewed changes

docs/api-zh/chart-fun.md Outdated Show resolved Hide resolved

hustcc reviewed Sep 14, 2020

View reviewed changes

羽熙 added 2 commits September 14, 2020 10:27

docs: uniform file naming

702191c

docs: delete yarn lock

aaf229c

accesslint bot suggested changes Sep 14, 2020

View reviewed changes

pr-triage bot added PR: reviewed-changes-requested and removed PR: unreviewed labels Sep 14, 2020

docs: modify git ignore

09ccf53

pr-triage bot added PR: unreviewed and removed PR: reviewed-changes-requested labels Sep 14, 2020

accesslint bot suggested changes Sep 14, 2020

View reviewed changes

pr-triage bot added PR: reviewed-changes-requested and removed PR: unreviewed labels Sep 14, 2020

hustcc reviewed Sep 14, 2020

View reviewed changes

docs/api/coord.zh.md Outdated

@@ -0,0 +1,6 @@

---

Copy link

Member

hustcc Sep 14, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

coordinate 文件名。

hustcc reviewed Sep 14, 2020

View reviewed changes

docs/api/geom.en.md Outdated

@@ -0,0 +1,8 @@

---

Copy link

Member

hustcc Sep 14, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

geometry 拆分成三层是为什么

hustcc reviewed Sep 14, 2020

View reviewed changes

docs/common/Region.md

@@ -0,0 +1,14 @@

_Region_ 结构如下：

Copy link

Member

hustcc Sep 14, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

这里还有一个文件命名问题。

docs: modify api route name

2fd5bb1

pr-triage bot added PR: unreviewed and removed PR: reviewed-changes-requested labels Sep 14, 2020

accesslint bot suggested changes Sep 14, 2020

View reviewed changes

pr-triage bot added PR: reviewed-changes-requested and removed PR: unreviewed labels Sep 14, 2020

docs: upgrade gatsby version

5f2df79

pr-triage bot added PR: unreviewed and removed PR: reviewed-changes-requested labels Sep 14, 2020

accesslint bot suggested changes Sep 14, 2020

View reviewed changes

pr-triage bot added PR: reviewed-changes-requested and removed PR: unreviewed labels Sep 14, 2020

hustcc approved these changes Sep 14, 2020

View reviewed changes

hustcc merged commit e472de5 into master Sep 14, 2020

hustcc deleted the api-docs branch September 14, 2020 03:46

pr-triage bot added PR: merged and removed PR: reviewed-changes-requested labels Sep 14, 2020

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

docs: upgrade api docs #2818

docs: upgrade api docs #2818

BBSQQ commented Sep 10, 2020

accesslint bot left a comment

accesslint bot Sep 10, 2020

accesslint bot Sep 10, 2020

accesslint bot Sep 10, 2020

accesslint bot Sep 10, 2020

accesslint bot Sep 10, 2020

accesslint bot Sep 10, 2020

hustcc commented Sep 11, 2020

BBSQQ commented Sep 11, 2020

hustcc Sep 14, 2020

BBSQQ Sep 14, 2020

hustcc Sep 14, 2020

BBSQQ Sep 14, 2020

hustcc Sep 14, 2020

BBSQQ Sep 14, 2020

hustcc Sep 14, 2020 •

edited

BBSQQ Sep 14, 2020

hustcc commented Sep 14, 2020

accesslint bot left a comment

accesslint bot Sep 14, 2020

accesslint bot left a comment

accesslint bot Sep 14, 2020

BBSQQ commented Sep 14, 2020

hustcc Sep 14, 2020

hustcc Sep 14, 2020

hustcc Sep 14, 2020

accesslint bot left a comment

accesslint bot Sep 14, 2020

accesslint bot left a comment

accesslint bot Sep 14, 2020

		@@ -0,0 +1,90 @@
		<!--## chart\[geom\](options) 创建几何标记-->


		### G2.registerEngine

		注册渲染引擎，目前 G2 支持 svg canvas。

docs: upgrade api docs #2818

docs: upgrade api docs #2818

Conversation

BBSQQ commented Sep 10, 2020

Checklist

Description of change

accesslint bot left a comment

Choose a reason for hiding this comment

accesslint bot Sep 10, 2020

Choose a reason for hiding this comment

accesslint bot Sep 10, 2020

Choose a reason for hiding this comment

accesslint bot Sep 10, 2020

Choose a reason for hiding this comment

accesslint bot Sep 10, 2020

Choose a reason for hiding this comment

accesslint bot Sep 10, 2020

Choose a reason for hiding this comment

accesslint bot Sep 10, 2020

Choose a reason for hiding this comment

hustcc commented Sep 11, 2020

BBSQQ commented Sep 11, 2020

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

hustcc Sep 14, 2020 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

hustcc commented Sep 14, 2020

accesslint bot left a comment

Choose a reason for hiding this comment

accesslint bot Sep 14, 2020

Choose a reason for hiding this comment

accesslint bot left a comment

Choose a reason for hiding this comment

accesslint bot Sep 14, 2020

Choose a reason for hiding this comment

BBSQQ commented Sep 14, 2020

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

accesslint bot left a comment

Choose a reason for hiding this comment

accesslint bot Sep 14, 2020

Choose a reason for hiding this comment

accesslint bot left a comment

Choose a reason for hiding this comment

accesslint bot Sep 14, 2020

Choose a reason for hiding this comment

hustcc Sep 14, 2020 •

edited