На этой странице содержится подробная информация о проекте технического написания, принятом для участия в Google Season of Docs.
Краткое описание проекта
- Организация с открытым исходным кодом:
- Апач Кассандра
- Технический писатель:
- двора
- Название проекта:
- Обновление документации Apache Cassandra 4.0 и устранение TODO в документации
- Длина проекта:
- Длительный ход (5 месяцев)
Описание Проекта
Проект состоит из двух подпроектов:
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. Разрешение TODO в документации Apache Cassandra
Документация Apache Cassandra содержит несколько разделов.
выделены как «TODO» (или задачи, которые еще предстоит выполнить). Это:
- Работа с Cassandra/Резервное копирование
- Эксплуатация Кассандры / Массовая загрузка
- CQL/Определения данных (ограниченное количество точек проверки)
- Моделирование данных
- Динамо / Сплетни, Обнаружение сбоев и Token Ring
- Архитектура/Гарантии
- Работа с Кассандрой/Советы
- Архитектура/Обзор (предлагается как отдельный проект)
- Эксплуатация Cassandra/Чтение восстановления
- Многие члены сообщества подготовили материалы по этим темам (включая публикации в общедоступных блогах, сообщения о переполнении стека и т. д.). Наиболее продуктивным подходом к заполнению этих разделов может быть запрос хороших ссылок и материалов из списков рассылки и их синтез в краткий документ из набора документации Apache Cassandra.