📖 Guidelines and tutorials about CrateDB. 📖
🔗 Handbook: Install • Getting Started • Administration • Performance
🔗 Ecosystem: Application Domains • Integrations • Reference Architectures
📖 More information: Drivers and Integrations • Integration Tutorials • Reference Documentation
✅ CI Status:
-
This repository contains the sources for the documentation pages rendered to https://cratedb.com/docs/guide/. The content is optimally consumed from there.
-
If you are looking for something specific, please use the search feature, for example, searching for "flink".
-
You can use the content and code snippets for educational and knowledge base purposes, or as blueprints for your own projects.
-
Sources for statically rendered documentation about CrateDB written in Markdown and/or reStructuredText.
-
The documentation system is based on Sphinx, MyST, sphinx-design, sphinx-design-elements, and many other Sphinx addons and plugins.
-
The documentation theme is crate-docs-theme.
-
The project uses Read the Docs for publishing.
Interested in contributing to this project? Thank you so much!
As an open-source project, we are always looking for improvements in form of contributions, whether it be in the form of a new feature, improved infrastructure, or better documentation.
Your bug reports, feature requests, and patches are highly appreciated.
See also the developer docs to learn how to set up a development sandbox, in order to start editing. The contribution docs include general information about how to contribute to CrateDB repositories.