【 TiDBer 唠嗑茶话会 38 】关于文档的爱恨情仇,统统可以在这里倾诉~

问题类型:
技术点描述不全,其实可能其他地方有描述,但是主要页内可能没有链接
出现的页面:
https://docs.pingcap.com/zh/tidb/stable/ticdc-faq

出现的问题:
1、在以上页面中未说明 CDC 下游为 表字段 CHAR/BINARY、VARCHAR/VARBINARY类型的会被转换,可能会被认为数据复制到下游后变成乱码了,其实不是。在

有说明,

2、此处说明了 CHAR/BINARY、VARCHAR/VARBINARY类型的会被转换,

1)但是未说明下游数据被转换后 如何转换成原数据;
2)下图中列出了 Column 的类型码, 但是未说明 哪些类型系统作为下游时会被转换

其实这类问题可能是分类了,分类的方式或知识点不同的原因导致 相关文档被分开存放,但是使用的人能把所有的文档都看到 的机率较小,初学者可能是用的时候才去看,照着文档做。

个人建议:
类似问题可以在主要页面加 注意事项或者常见问题中说明 +技术点描述的链接信息

1 个赞

问题分类: TiDB 和 Golang 的简单 CRUD 应用程序code缺乏注释,
出现的页面:
https://docs.pingcap.com/zh/tidb/stable/dev-guide-sample-application-golang
出现的问题:实例code部署缺乏注释,没有注明程序code实际意义,尽管最后能跑起来。
群里的菜鸟一开始学习go部署tidb是一脸懵逼,又没时间重新系统学习go语言,可能简明注释并没有什么实际效果,但比没有好。

1 个赞

tidb文档还是比较翔实的

看到文档就头疼,但是最全的知识点都是在文档中,所有痛苦并快乐着吧

需求类型:新增文档
需求背景:TiDB 与 Java 的简单 CRUD 应用实例和使用 SpringBoot 构建 TiDB 应用里,可以有一个jdbc 连接配置的最佳示例,避免一些配置的坑
https://docs.pingcap.com/zh/tidb/stable/dev-guide-sample-application-java


https://docs.pingcap.com/zh/tidb/stable/dev-guide-sample-application-spring-boot

1 个赞
  • 问题分类:步骤可能不完整
  • 出现的页面:TiDB 环境与系统配置检查 | PingCAP Docs
  • 出现的问题:
    我测试时,操作系统版本是CentOS7.9。按照TIDB官方文档中的集群安装步骤进行安装TIDB操作,其中有一步是系统优化参数,我按照步骤5 的方法一,进行了操作系统配置,这样就跳过了方法二。步骤6的检查我也做了,当时通过了。但是执行tidb check 时,发现关闭透明大页的检测未通过。

最后我通过以下命令完全关闭了透明大页:

# vi /etc/rc.d/rc.local 
if test -f /sys/kernel/mm/transparent_hugepage/enabled; then
echo never > /sys/kernel/mm/transparent_hugepage/enabled
fi
if test -f /sys/kernel/mm/transparent_hugepage/defrag; then
echo never > /sys/kernel/mm/transparent_hugepage/defrag
fi
# chmod +x /etc/rc.d/rc.local

文档的这部分关闭透明大页的内容是不是需要重新调整下?

1 个赞
  • 需求类型:增加对各类异常导致的原因已经解决办法
  • 需求背景:文档对异常解决办法描述不清晰,或者组件出现异常时提示不明显
  • 期望增加对各类异常导致的原因已经解决办法。

继续加油吧

文档绝大部分还是比较详细的,提一个有点不切实际的要求,是否可以提供文档下载功能呢

这类问题适合在 asktug 讨论或者是在专栏上寻求拒绝,这类的 trouble shooting 不太适合放到文档里面来~

Hello,这里我看是每一步都是有注释的呀。向您征集一下这里的修改意见。具体是哪里增加注释会提升易读性呢?

个人感觉文档的参数和命令介绍应该多一些:
使用权限
注意事项
关联的参数及所带来的影响

之前提了一些文档的小问题,反馈很及时,最近在忙其他的,没有时间“找茬”了

对于部分监控的描述,处理的可操作性很低。这块还要增强一下。

1 个赞

有的监控项搜不到:joy:

1 个赞

虽然TiDB的文档是比较完美的,但是我在下面描述的地方理解起来有些吃力:

spark.tispark.pd.addresses $pd_host:$pd_port
spark.sql.extensions org.apache.spark.sql.TiExtensions
spark.sql.catalog.tidb_catalog  org.apache.spark.sql.catalyst.catalog.TiCatalog
spark.sql.catalog.tidb_catalog.pd.addresses $pd_host:$pd_port

还是需要通过 TiUP 先进行 TiSpark 组件安装会后,再进行上述的集群部署过程呢。此处一直存在困惑,也没将 TiSpark 集群部署成功。

1 个赞

哈哈,不错,生态很好

https://github.com/pingcap/docs-cn/pull/11284

相关 PR 已提,具体可见进度~

1 个赞

文档还是比较详细

大爱无言,润物无声~