本页详细介绍了 Google 文档季收录的技术文案项目。
项目摘要
- 开源组织:
- Apache Cassandra
- 技术文档工程师:
- dvohra
- 项目名称:
- Apache Cassandra 4.0 文档更新以及文档中的 TODO 解析
- 项目时长:
- 长时间运行(5 个月)
Project description
项目由两个子项目组成,如下所示:
1. Apache Cassandra 4.0 文档更新
检查并更新现有的 Apache Cassandra 文档,确保其与即将发布的 Apache Cassandra 4.0 版本保持一致。
我们建议
采用以下方法:首先发送邮件至 cassandra-dev
邮寄名单,让 Cassandra 贡献者突出显示文档中需要更新的部分。
其次,我们会
对现有文档进行结构化审核,以找出可能存在的缺口。
例如:在结构化审核中,技术编写人员可以将 Cassandra 配置文件文档
(http://cassandra.apache.org/doc/latest/configuration/cassandra_config_file.html) 与源代码中实际包含的配置选项
(https://github.com/apache/cassandra/blob/trunk/src/java/org/apache/cassandra/config/Config.java) 进行比较。
2. 解决 Apache Cassandra 文档中的 TODO
Apache Cassandra 文档中包含多个部分
,这些部分都被突出标记为“TODO”(或尚未完成的任务)。它们是:
- 操作 Cassandra / 备份
- 操作 Cassandra / 批量加载
- CQL / 数据定义(有限的审核点)
- 数据建模
- Dynamo / Gossip、故障检测和令牌环
- 架构/保证
- 操作 Cassandra/提示
- 架构/概览(建议将其作为单独的项目)
- 操作 Cassandra/Read Repair
- 社区的许多成员都制作了有关这些主题的资料(包括公开博文、Stack Overflow 帖子等)。若要完成这些部分,最有效的方法可能是从邮寄名单中请求获取实用参考文献和资料,并将其整合到 Apache Cassandra 文档集中的简洁文档中。