本页面包含有关 Google 文档季可接受的技术写作项目的详细信息。
项目摘要
- 开源组织:
- Apache Cassandra
- 技术文档工程师:
- dvohra
- 项目名称:
- Apache Cassandra 4.0 文档更新和文档中的解决待办事项
- 项目时长:
- 长期投放(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 / 数据定义(有限的评价点)
- 数据建模
- 动态 / 消息沟通、故障检测和令牌环
- 建筑/担保
- 操作 Cassandra/提示
- 架构/概览(建议作为单独的项目进行)
- 操作 Cassandra/读取装置
- 该社区的许多成员都制作了涵盖这些主题的资料(包括公开博文、Stack Overflow 帖子等)。完成这些部分最有效的方法是从邮寄名单中请求优质的参考资料和资料,然后合成一个简明的 Apache Cassandra 文档集文档。