crate/crate-operator

Documentation available only in raw RST format

开放

#858 创建于 2026年7月8日

 (2 条评论) (0 个反应) (1 位负责人)Python (9 个派生)auto 404
help wanted

仓库指标

星标
 (27 个星标)
PR 合并指标
 (平均合并 9天 1小时) (30 天内合并 17 个 PR)

描述

Problem

There is documentation inside https://github.com/crate/crate-operator/tree/master/docs. However, documentation is in the RST format, meaning it doesn't render in a human-friendly format.

The main README links for example to https://github.com/crate/crate-operator/blob/master/docs/source/configuration.rst for reading up on parameters, but its the raw RST, which doesn't render properly.

There does not seem to be a hosted version of the documentation on cratedb.com/docs. There is a deployment to GitHub pages (https://crate.github.io/crate-operator/), but clicking on links there leads back to the raw RST files.

Suggestion

Similar to cratedb-toolkit, there could be a hosted version of the documentation on readthedocs.io (https://cratedb-toolkit.readthedocs.io/). Ideally, it would also be available on cratedb.com/docs.

贡献者指南