Up until now, each downstream project maintains their own developer guide in form of the DEVELOP.rst file. This is not sustainable, because we would like to provide a concise and canonical variant, and not stop at the first version, but constantly evolve it. This is difficult to pull off when needing to manage so many redundant representations on behalf of each and every project which includes a corresponding file.
Solution
In the spirit of GH-468, this patch turns around https://github.com/crate/cratedb-guide/pull/52, and adds a canonical documentation authoring guide here instead, to have a likewise canonical place to link to. In this way, we don't need to maintain this information redundantly.
Problem
Up until now, each downstream project maintains their own developer guide in form of the
DEVELOP.rstfile. This is not sustainable, because we would like to provide a concise and canonical variant, and not stop at the first version, but constantly evolve it. This is difficult to pull off when needing to manage so many redundant representations on behalf of each and every project which includes a corresponding file.Solution
In the spirit of GH-468, this patch turns around https://github.com/crate/cratedb-guide/pull/52, and adds a canonical documentation authoring guide here instead, to have a likewise canonical place to link to. In this way, we don't need to maintain this information redundantly.
Preview
https://crate-docs-theme--469.org.readthedocs.build/en/469/authoring.html
/cc @WalBeh, @karynzv, @surister, @wierdvanderhaar