crate/cratedb-guide - Githubissues

# The CrateDB Guide 📖 _Guidelines and tutorials about [CrateDB]._ 📖 🔗 Handbook: [Install](https://cratedb.com/docs/guide/install/) • [Getting Started](https://cratedb.com/docs/guide/getting-started.html) • [Administration](https://cratedb.com/docs/guide/admin/) • [Performance](https://cratedb.com/docs/guide/performance/) 🔗 Ecosystem: [Application Domains](https://cratedb.com/docs/guide/domain/) • [Integrations](https://cratedb.com/docs/guide/integrate/) • [Reference Architectures](https://cratedb.com/docs/guide/reference-architectures/) 📖 More information: [Drivers and Integrations](https://cratedb.com/docs/clients/) • [Integration Tutorials](https://community.cratedb.com/t/overview-of-cratedb-integration-tutorials/1015) • [Reference Documentation](https://cratedb.com/docs/crate/reference/) ✅ CI Status: [![](https://github.com/crate/cratedb-guide/actions/workflows/docs.yml/badge.svg)](https://github.com/crate/cratedb-guide/actions/workflows/docs.yml) [![](https://readthedocs.org/projects/cratedb-guide/badge/?version=latest)](https://readthedocs.org/projects/cratedb-guide) [![](https://img.shields.io/endpoint.svg?color=blue&url=https%3A%2F%2Fraw.githubusercontent.com%2Fcrate%2Fcratedb-guide%2Fmain%2Fdocs%2Fbuild.json)](https://github.com/crate/cratedb-guide/blob/main/docs/build.json)

👨‍💻 Usage

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.

🧐 What's Inside

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.

💁 Contributing

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.