docs: 优化部分文档, 增加部分 faq

lijinke666 · lijinke666 · commit ae2ab397241a · 2022-01-13T19:24:39.000+08:00
diff --git a/.github/workflows/issue-labeled.yml b/.github/workflows/issue-labeled.yml
@@ -17,9 +17,9 @@ jobs:
           token: ${{ secrets.GITHUB_TOKEN }}
           issue-number: ${{ github.event.issue.number }}
           body: |
-            你好 @${{ github.event.issue.user.login }}，请提供一个可以在线访问的链接, 或者 [codesandbox](https://codesandbox.io/s/29zle) 示例并详细说明复现步骤, 15 天内未回复issue自动关闭。
+            你好 @${{ github.event.issue.user.login }}，请提供一个可以在线访问的链接, 或者使用 [codesandbox](https://codesandbox.io/s/29zle) 提供示例并详细说明复现步骤, 15 天内未回复issue自动关闭。
 
-            Hello, @${{ github.event.issue.user.login }}, please provide an accessible link or [codesandbox](https://codesandbox.io/s/29zle) usage to describe the reproduction steps. The issue will be closed without any replay within 15 days.
+            Hello, @${{ github.event.issue.user.login }}, please provide an accessible link or usage [codesandbox](https://codesandbox.io/s/29zle) to describe the reproduction steps. The issue will be closed without any replay within 15 days.
 
       - name: Need more info
         if: github.event.label.name == '👀 need more info'
diff --git a/.github/workflows/release-notify.yml b/.github/workflows/release-notify.yml
@@ -18,8 +18,8 @@ jobs:
             ${{ secrets.DING_TALK_ACCESS_TOKEN }}
             ${{ secrets.DING_TALK_GROUP_TOKEN }}
             ${{ secrets.DING_TALK_PUBLIC_TOKEN }}
-          notify_title: '🎉 {release_tag} 发布 🎉'
-          notify_body: '## { title } <hr /> ![preview](https://gw.alipayobjects.com/zos/antfincdn/ISzgBCtgR/2c5c4aaa-4f40-46f7-8f6b-427fa9ff07bb.png) <hr /> { body } <hr />'
-          notify_footer: '> 前往 [**AntV/S2 Releases**]({ release_url }) 查看完整信息.'
+          notify_title: '🎉 新版本发布 🎉'
+          notify_body: '![preview](https://gw.alipayobjects.com/zos/antfincdn/ISzgBCtgR/2c5c4aaa-4f40-46f7-8f6b-427fa9ff07bb.png) <hr /> 看看有哪些更新吧 <hr />'
+          notify_footer: '> 前往 [**AntV/S2 Releases**](https://github.com/antvis/S2/releases/latest) 查看完整信息.'
           at_all: false
           enable_prerelease: false
diff --git a/s2-site/docs/api/basic-class/base-cell.zh.md b/s2-site/docs/api/basic-class/base-cell.zh.md
@@ -19,7 +19,7 @@ order: 4
 | getTextStyle | 获取文本样式 | `() => void` |
 | getFormattedFieldValue | 获取格式化后的字段值 | `() => { formattedValue: string, value: string }` |
 | getMaxTextWidth | 获取文本最大宽度 | `() => number` |
-| getTextPosition | 获取文本最大宽度 | [Point](#point) |
+| getTextPosition | 获取文本坐标 | [Point](#point) |
 | getContentArea | 获取内容区域 | `() => { x: number, y: number, width: number, height: number }` |
 | updateByState | 根据状态更新单元格样式 | `(stateName: InteractionStateName, cell: S2CellType) => void` |
 | hideInteractionShape | 隐藏单元格的交互图层 | `() => void` |
diff --git a/s2-site/docs/api/general/S2Options.zh.md b/s2-site/docs/api/general/S2Options.zh.md
@@ -14,17 +14,17 @@ order: 1
 | tooltip | [Tooltip](#tooltip) |    |  |  tooltip 总配置 |
 | interaction | [Interaction](#interaction) |    |  |  表格交互配置 |
 | pagination | [Pagination](#pagination) |  |    | 分页配置 |
-| frozenRowHeader | `boolean` |  |   `true` | 冻结行头 (透视表有效) |
+| frozenRowHeader | `boolean` |  |   `true` | 冻结行头 （透视表有效） |
 | showSeriesNumber | `boolean` |  |  `false` | 是否显示行序号 |
 | scrollReachNodeField | [NodeField](#nodefield) |  |  | 滚动监听的节点度量 |
 | showDefaultHeaderActionIcon |`boolean` |  |   `true` | 是否展示默认行列头操作图标 |
 | headerActionIcons | [HeaderActionIcon[]](#headeractionicon) |  |   `false` | 自定义行列头操作图标（需要将 `showDefaultHeaderActionIcon` 置为 `false`） |
 | customSVGIcons | [CustomSVGIcon[]](#customsvgicon) |  |   `false` | 自定义 svg 图标 |
-| style | [Style](#style) |  |    | 单元格样式设置, 比如布局类型, 宽高, 边距, 是否隐藏数值列头等 |
-| frozenRowCount | `number` |  |    | 冻结行的数量，从顶部开始计数 (明细表有效) |
-| frozenColCount | `number` |  |    | 冻结列的数量，从左侧开始计数 (明细表有效) |
-| frozenTrailingRowCount | `number` |    |  | 冻结行数量，从底部开始计数 (明细表有效) |
-| frozenTrailingColCount | `number` |    |  | 冻结列的数量，从右侧开始计数 (明细表有效) |
+| style | [Style](#style) |  |    | 单元格样式设置，比如布局类型，宽高，边距，是否隐藏数值列头等 |
+| frozenRowCount | `number` |  |    | 冻结行的数量，从顶部开始计数 （明细表有效） |
+| frozenColCount | `number` |  |    | 冻结列的数量，从左侧开始计数 （明细表有效） |
+| frozenTrailingRowCount | `number` |    |  | 冻结行数量，从底部开始计数 （明细表有效） |
+| frozenTrailingColCount | `number` |    |  | 冻结列的数量，从右侧开始计数 （明细表有效） |
 | hierarchyCollapse | `boolean` |  |   `false` | 在树状结构模式下行头是否默认展开。 |
 | hdAdapter | `boolean` |  |   `true` | 是否开启高清屏适配，解决多屏切换，高清视网膜屏字体渲染模糊的问题 |
 | mergedCellsInfo | [MergedCellInfo[][]](#mergedcellinfo) |    |  | 合并单元格信息 |
@@ -42,7 +42,7 @@ order: 1
 | mappingDisplayDataItem | [MappingDataItemCallback](#mappingdataitemcallback) |  |    | 转换数据，用于 tooltip 显示 |
 | otterLayout | [OtterLayout](#otterlayout) |  |  |   自定义 layout |
 | dataSet | [DataSet](#dataset) |  |  |   自定义数据集 |
-| supportCSSTransform | `boolean` |  |   `false` | 设置为true可解决父元素缩放引起的鼠标定位错误 |
+| supportCSSTransform | `boolean` |  |   `false` | 开启后支持 CSS transform, 解决父元素设置 `transform` 后，鼠标坐标响应不正确的问题  |
 
 `markdown:docs/common/interaction.zh.md`
 
diff --git a/s2-site/docs/manual/contribution.zh.md b/s2-site/docs/manual/contribution.zh.md
@@ -16,12 +16,14 @@ order: 7
 
 目前，我们基于 `master` 分支开发，有任何修改，请基于 `master` 拉一个分支，然后通过 `PR` 的形式，我们集成了钉钉机器人，会第一次时间 review 你的 PR, 给与反馈
 
-## 提交 Bug
+## 提交 Bug 反馈
 
-很抱歉又写了一些 bug, 但求友好的提交一个有意义的 bug, 谁也不希望反馈的 bug 是这样：
+很抱歉又写了一些 bug, 但求友好的提交一个有意义的 bug 反馈，谁也不希望反馈的 bug 是这样：
 
 ![preview](https://gw.alipayobjects.com/zos/antfincdn/j0jUvKwT%26/dd59fe64-7108-4ad7-a544-e19d79eea890.png)
 
+没有版本信息，没有复现步骤，没有问题描述，没有代码片段，开局一句话，内容全靠猜。
+
 首先选择 [Bug report]
 
 ![preview](https://gw.alipayobjects.com/zos/antfincdn/oAnzfiVl2/9d83b3e8-b05c-4475-b736-92c45448546a.png)
@@ -36,7 +38,7 @@ order: 7
 2. 安装依赖：`yarn bootstrap` 或者 `yarn`
 3. 提交你的改动，commit 请遵守 [AngularJS Git Commit Message Conventions](https://docs.google.com/document/d/1QrDFcIiPjSLDn3EL15IJygNPiHORgU1_OOAqWjiDU5Y/edit#heading=h.uyo6cb12dt6w)
 4. 如果你的改动是修复 bug, 还可以在提交信息后面加上 `close #issue 号`, 这样可以在 pr 合并后，可以自动关闭对应的 issue, 比如 `fix: render bug close #123`
-5. 确保加上了对应的单元测试和文档 (如有必要)
+5. 确保加上了对应的单元测试和文档 （如有必要）
 6. 所有 Lint 和 Test 检查通过后，并且 review 通过，我们会合并你的 pr.
 
 ![preview](https://gw.alipayobjects.com/zos/antfincdn/ssOxFrycD/86339514-5f9a-4101-8690-e47c97cd8af5.png)
@@ -52,8 +54,8 @@ npm i -g yarn
 1. `yarn bootstrap` 安装依赖
 2. `yarn site:bootstrap` 安装网站相关依赖
 3. `yarn site:start` 启动本地的 `S2` 网站
-4. `yarn core:start` 可视化的方式调试核心层测试 (基于 jest-electron)
-5. `yarn react:start` 可视化的方式调试组件层测试 (基于 jest-electron)
-6. `yarn react:playground` 启动本地的组件层demo (基于 vite)
-7. `yarn build` 构建 `@antv/s2` 和 `@antv/s2-react` 两个包, 分别输出 `umd`, `esm` 和 `lib` 目录
+4. `yarn core:start` 可视化的方式调试核心层测试 （基于 jest-electron)
+5. `yarn react:start` 可视化的方式调试组件层测试 （基于 jest-electron)
+6. `yarn react:playground` 启动本地的组件层 demo （基于 vite)
+7. `yarn build` 构建 `@antv/s2` 和 `@antv/s2-react` 两个包，分别输出 `umd`, `esm` 和 `lib` 目录
 8. `yarn test` 运行单元格测试
diff --git a/s2-site/docs/manual/faq.zh.md b/s2-site/docs/manual/faq.zh.md
@@ -3,7 +3,7 @@ title: 常见问题
 order: 8
 ---
 
-在提出问题前，建议仔细阅读一遍文档。
+**在提出问题前，建议仔细阅读一遍文档。**
 
 ## 1. 使用问题
 
@@ -43,8 +43,8 @@ order: 8
 ```ts
 <script src="./dist/index.min.js"></script>
 <script>
-const s2 = new window.S2.PivotSheet(container, s2DataConfig, s2options);
-s2.render();
+   const s2 = new window.S2.PivotSheet(container, s2DataConfig, s2options);
+   s2.render();
 </script>
 ```
 
@@ -67,15 +67,50 @@ s2.render();
 
 ### 父级元素使用了 `transform: scale` 后，图表鼠标坐标响应不正确
 
-可以调用 `s2.changeSize` 根据缩放比改变图表大小，使图表和父元素缩放比保持一致
+可以开启 `supportCSSTransform` 属性
+
+```ts
+const s2Options = {
+   supportCSSTransform: true
+}
+```
+
+也可以手动调用 `s2.changeSize` 根据缩放比改变图表大小，使图表和父元素缩放比保持一致
 
 ```ts
 const scale = 0.8
 s2.changeSize(width * scale, height * scale)
 s2.render(false)
 ```
 
-可参考 [issue #808](https://github.com/antvis/S2/issues/808) （感谢 [cylnet](https://github.com/cylnet))
+可参考 issue [#808](https://github.com/antvis/S2/issues/808) [#990](https://github.com/antvis/S2/pull/990) （感谢 [@cylnet](https://github.com/cylnet) [@xiaochong44](https://github.com/xiaochong44))
+
+### 如何更新表格配置？
+
+```ts
+const pivotSheet = new PivotSheet(document.getElementById('container'), dataCfg, options);
+```
+
+更新 options: [可选项](https://s2.antv.vision/zh/docs/api/general/S2Options)
+
+```ts
+pivotSheet.setOptions({ ... })
+pivotSheet.render(false) // 重新渲染，不更新数据
+```
+
+更新 dataCfg: [可选项](https://s2.antv.vision/zh/docs/api/general/S2DataConfig)
+
+```ts
+pivotSheet.setDataCfg({ ... })
+pivotSheet.render(true) // 重新渲染，且更新数据
+```
+
+更新 theme: [可选项](https://s2.antv.vision/zh/docs/api/general/S2Theme)
+
+```ts
+pivotSheet.setThemeCfg({ ... })
+pivotSheet.render(false)  // 重新渲染，不更新数据
+```
 
 ### 图表渲染不出来，怎么回事？
 
@@ -132,6 +167,10 @@ s2.render(false)
 
 配套的 [分析组件](/zh/examples/react-component), 目前还没有 `@antv/s2-vue`, `@antv/s2-angular` 的开发计划，欢迎社区一起建设 👏🏻.
 
+### 怎样贡献代码？
+
+请查看 [贡献指南](https://s2.antv.vision/zh/docs/manual/contribution)
+
 ### 为什么在小程序上面表格无法显示？
 
 目前 `S2` 只支持 `web` 平台，小程序暂不支持。
