crate/crate-operator

Documentation available only in raw RST format

Open

#858 opened on 2026年7月8日

GitHub で見る
 (2 comments) (0 reactions) (1 assignee)Python (9 forks)auto 404
help wanted

Repository metrics

Stars
 (27 stars)
PR merge metrics
 (PR metrics pending)

説明

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.

コントリビューターガイド