Участие в разработке документации YDB
YDB следует подходу «Документация как код», что означает, что документация YDB разрабатывается с использованием аналогичных методов и инструментов, как и основной исходный код проекта на C++.
Исходный код документации состоит из файлов Markdown и конфигурационных файлов YAML, расположенных в папке ydb/docs основного репозитория YDB на GitHub. Компилятором этого исходного кода является инструмент с открытым исходным кодом под названием Diplodoc. Подробности о его диалекте Markdown, параметрах конфигурации, расширениях и многом другом можно найти в его документации.
Процесс предложения изменений в исходном коде документации в основном аналогичен изменению любого другого исходного кода YDB, поэтому большая часть Процесс разработки: работа над изменениями кода YDB применима. Основные дополнительные особенности:
- Для pull-запросов к документации выполняются дополнительные прекоммитные проверки. Одна из этих проверок оставляет комментарий со ссылкой на онлайн-предпросмотр изменений или список ошибок.
- Процесс ревью кода включает дополнительные шаги. См. Процесс ревью документации YDB и Руководство по стилю документации YDB.
- Для небольших изменений, таких как исправление опечатки, можно использовать функцию «Edit this file» в веб-интерфейсе GitHub. Каждая страница документации имеет ссылку «Edit on GitHub» (представлена значком карандаша в правом верхнем углу), которая ведёт к исходному коду страницы в веб-интерфейсе GitHub.
После мёрджа pull-запроса с документацией в ветку main CI/CD-пайплайн автоматически публикует её на сайте YDB. Документация также автоматически публикуется для стабильных версий сервера YDB из веток git с именами stable-*, где разрабатываются эти версии. Если код C++ и документация для функции были закоммичены отдельно, и между этими коммитами была создана новая стабильная ветка, может потребоваться бекпортирование некоторых изменений в стабильную ветку. То же самое относится к исправлению опечаток и другим «багфиксам» в содержании документации. Подробнее о процессе релиза YDB см. Manage YDB releases.