Documentation link returns 404

[hammerhead]

Hi @amotl,

I recently sent out references to cratedb-toolkit to a few users. In the README, there is a link to the documentation pointing to https://cratedb-toolkit.readthedocs.io/ which returns a 404. Is there documentation already available that can be linked to or does it still need to be created?

Thanks!

[amotl]

Thanks for your feedback. Documentation still needs to be whipped up, there is currently a void. Apologies, we will try to improve soon.

[amotl]

Hi again. We spent some cycles on establishing a proper documentation. Thanks for the bump.

Status Quo

Live

• CrateDB Toolkit

  The "Datasets API", the "I/O Subsystem", and the "Retention and Expiration" subsystem are the most prominent ones already shipping with Toolkit, so you will already find corresponding documentation about them.

Preview

Both subsystems are included in GH-88, and need some more love before integrating. Let us know about your needs and interest, so we can adjust velocity correspondingly.

• CrateDB CFR
• CrateDB WTF

Outlook

Please review and validate the documentation, and don't hesitate to provide any kind of feedback to improve. Thank you! 🙏

[amotl]

Closing this, because navigating to the documentation does not yield a 404 response any longer. Please re-open when applicable, or create a new issue for conveying back suggestions about improvements. Thanks!