Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documentation feedback: Add "Used by" gallery of supported applications and frameworks #184

Open
amotl opened this issue Dec 8, 2024 · 0 comments
Labels
documentation Improvements or additions to documentation

Comments

@amotl
Copy link
Member

amotl commented Dec 8, 2024

Documentation feedback

CrateDB is special when compared to other databases, foremost because it's an OLAP database instead of an OLTP database.

That means downstream applications and frameworks may need to consider using some of the special Support Features of CrateDB's SQLAlchemy dialect implementation, in order to compensate for certain database features missing that are ubiquitous on traditional OLTP RDBMS.

Proposal

In this spirit, and to educate readers and increase visibility, it makes sense to spend a dedicated section within the documentation, enumerating all the downstream applications and frameworks, where CrateDB offers dedicated and reasonably verified support for.

As a start, it can be as simple as a basic "Used by" enumeration.

Relevant information, mostly located within the source code of corresponding repositories, conveys details how to »make things work with CrateDB«, so it delivers important insights and blueprints for others to get inspired about how to design adapters for other applications and frameworks, even in different programming languages than Python.

Examples

Backlog

@amotl amotl added the documentation Improvements or additions to documentation label Dec 8, 2024
@amotl amotl changed the title Documentation feedback on /docs/index.rst: Gallery-like enumeration of supported applications and frameworks Documentation feedback on /docs/index.rst: "Used by" enumeration of supported applications and frameworks Dec 9, 2024
@amotl amotl changed the title Documentation feedback on /docs/index.rst: "Used by" enumeration of supported applications and frameworks Documentation feedback: Add "Used by" enumeration of supported applications and frameworks Dec 9, 2024
@amotl amotl changed the title Documentation feedback: Add "Used by" enumeration of supported applications and frameworks Documentation feedback: Add "Used by" gallery of supported applications and frameworks Dec 9, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

1 participant