Enrich Documentation: 完善 TiDB 字符串函数中文文档说明
Open
Nobody has claimed this yet.
2024-tidb-docs-dash
type/enhancement
- Dominant language
- Python
- Stars
- 1.8k
- Forks
- 1.2k
- Avg merge
- 1d 16h
- Merged PRs (30d)
- 31
Description
欢迎参与完善优化 TiDB 文档。您的文档完善优化对我们不断提升 TiDB 文档的用户体验非常重要。
概览
当前的 TiDB 字符串函数文档为每个支持的函数提供了基本信息，但没有详细的描述和示例。为了使 TiDB 字符串函数文档更全面、更易于用户使用，我们欢迎外部贡献者丰富每个字符串函数的说明。
目标
- 通过为每个函数提供详细的说明和使用示例，完善 TiDB 字符串函数文档。
- 确保文档内容的一致性和清晰。
所需技能
- 熟练掌握 SQL 和 TiDB 字符串函数。
贡献指南
- 从 sub-issue 列表中选择两个字符串函数。
- 点击跳转到这两个字符串函数对应的 sub-issue 链接。
- 在 sub-issue 页面通过发表
/assign评论将此 sub-issue 分配给自己。如果该 sub-issue 右上角的 Assignees 字段已显示有人认领，请重新选择一个 sub-issue。 - 向 TiDB 中文文档仓库 pingcap/docs-cn 提交 Pull Request (PR)。
- 在创建 PR 时，请在 PR 描述中指明该 PR 解决了哪个问题，例如 "Fix #xxx"。
sub-issue 列表
- #15948
- #15949
- #15950
- #15951
- #15952
- #15953
- #16069
- #16070
- #16071
更多信息
- 关于如何创建 PR 的详情，请参考 TiDB 中文文档贡献指南。
- 请确保在 TiDB 中测试您提供的文档描述和示例。要快速开始使用 TiDB 或 TiDB Cloud，请参考以下文档：
- 不要从其他数据库的文档中复制文档描述或示例。
非常感谢您对完善 TiDB 文档的贡献！感谢您帮助改进 TiDB 文档用户体验。
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the linked TiDB string-functions documentation and choose an available sub-issue such as #16069, #16070, or #16071. Read the TiDB Chinese documentation contribution guide, test each example in TiDB, and submit a PR covering two functions with detailed, consistent descriptions and examples that reference this issue.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- sql
- Domain
- databases, documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- Half a day
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100