Skip to content

Commit

Permalink
Add change notice (#161)
Browse files Browse the repository at this point in the history
  • Loading branch information
torbsto committed Aug 22, 2023
1 parent 7b9becb commit 49bf6a9
Show file tree
Hide file tree
Showing 3 changed files with 36 additions and 29 deletions.
6 changes: 5 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,11 @@
[![Latest release](https://img.shields.io/github/v/release/bakdata/quick)](https://github.com/bakdata/quick/releases/latest)
[![Build status](https://github.com/bakdata/quick/actions/workflows/master-ci.yml/badge.svg)](https://github.com/bakdata/quick/actions/workflows/master-ci.yml)

> [!WARNING]
> We are currently rethinking Quick's approach and moving from applications to composable libraries.
> During this transition, there will be less updates in this repository.
> Visit our [user guide](https://bakdata.github.io/quick/latest/user/) for more information.
For detailed usage and installation instructions, check out
the [documentation](https://bakdata.github.io/quick/latest/user/).

Expand Down Expand Up @@ -34,7 +39,6 @@ Just open an issue beforehand and let us know what you want to do and why.
See our [contribution guide](https://bakdata.github.io/quick/latest/developer/contributing/)
and [development overview](https://bakdata.github.io/quick/latest/developer/development/) for more information.


## License

Quick is licensed under the [Apache 2.0 license](https://github.com/bakdata/quick/blob/master/LICENSE).
33 changes: 6 additions & 27 deletions docs/docs/roadmap.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,43 +6,22 @@ and [project boards](https://github.com/bakdata/quick/projects).

## Upcoming releases

### 0.9

Development: Q4 2022

* Providing DateTime support
* Extending range queries by giving users a possibility to
make a range over the value field

### Further ideas

* A possibility to deploy a mirror without creating a topic
* Further extension of range queries (range exclusively on keys, range using DateTime)
* Extending `Mutation` possibilities, for example, to ingest an array of values
* Providing a `between` semantics for having a range open on two fields
* Simplifying the `@topic` directive
* Redefining topic semantics
* Improving Gateway Performance (using JSON instead of generic types)
* Supporting additional query arguments (for example, filters)
* Supporting custom authorization
* Supporting different ingress controllers like nginx
* Implementing a Kafka-Streams library for custom REST APIs in Quick

We are currently rethinking Quick's approach and moving from applications to composable libraries.

## Completed releases

The [changelog](../changelog) has a detailed list of releases.

### 0.8

* Range queries support
* Improved gateway performance: Pre-computation of a key's location
* Kafka 3.0 support
- Range queries support
- Improved gateway performance: Pre-computation of a key's location
- Kafka 3.0 support

### 0.7

* Protobuf support
- Protobuf support

### 0.6

* Open-Source release 🎉
- Open-Source release 🎉
26 changes: 25 additions & 1 deletion docs/docs/user/index.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,30 @@
# Quick user guide

!!! warning "Important information"

We are currently rethinking Quick's approach and are moving from applications to composable libraries.
Subsequently, we are deprecating the CLI and the applications like the Manager and Ingest service,
and there will be less development activity during this period.

We instead focus on providing you the tools to integrate live data from Kafka in your GraphQL server.
The libraries will offer a similar set of features as Quick does now,
but allow you to integrate it with your custom solutions.
To expose the data from Kafka, this includes:

- creating different types of Kafka Stream indexes
- providing information about the partitioning
- applying the GraphQL field selection to Avro and Protobuf objects in your index.

To then query the data from a GraphQL server, the library provides:

- clients for querying different index types
- pre-computed routing to the replica that holds the queried key.

If you have any questions or feedback,
feel free to [open an issue](https://github.com/bakdata/quick/issues/new/)
or contact us by mail ([contact@d9p.io](mailto:contact@d9p.io)).


## What is Quick?

Quick orchestrates your data as a real-time stream of events.
Expand All @@ -24,7 +49,6 @@ You can apply a GraphQL schema to it that describes the data of your topic.
With the help of mirrors, the gateway can then efficiently query their content.
Next to querying data, it also supports ingesting data through a GraphQL interface.


## User guide

The user guide is split into three parts:
Expand Down

0 comments on commit 49bf6a9

Please sign in to comment.