docs: Refine README and docker compose files in examples #489
Conversation
|
Why we will run CI this time: 1. modify a new webp pic in design 2. remove a docker-compose yaml. why CI failure: there was a PR forced merge but the test failed even when the PR merged. |
|
Thank @yokofly |
jovezhong
changed the title
| - ./grafana_provisioning:/etc/grafana/provisioning | ||
| depends_on: | ||
| init-proton: | ||
| condition: service_completed_successfully |
There was a problem hiding this comment.
You may like to put another empty line after
There was a problem hiding this comment.
I tested all docker compose files. Without the empty line in the bottom, it can work, but I am not sure whether having the empty last line is a best practice or not. Maybe nice to have
There was a problem hiding this comment.
Saw some discussions https://stackoverflow.com/questions/2287967/why-is-it-recommended-to-have-empty-line-in-the-end-of-a-source-file More like to avoid unexpected errors for old tools.
| tlsClientCert: "" | ||
| tlsClientKey: "" | ||
| version: 1 | ||
| editable: true |
| volumes: | ||
| - ./grafana_provisioning:/etc/grafana/provisioning | ||
| depends_on: | ||
| - proton |
| # <string, required> path to dashboard files on disk. Required when using the 'file' type | ||
| path: /etc/grafana/provisioning/dashboards | ||
| # <bool> use folder names from filesystem to create folders in Grafana | ||
| foldersFromFilesStructure: true |
There was a problem hiding this comment.
Same here and for others
README.md
Outdated
| Proton is a unified streaming and historical data analytics database in a single binary. It helps data engineers and platform engineers solve complex real-time analytics use cases, and powers the [Timeplus](https://timeplus.com) streaming analytics platform. | ||
| 1. **[Apache Flink](https://github.com/apache/flink) or [ksqlDB](https://github.com/confluentinc/ksql) alternative.** Proton provides powerful streaming SQL functionalities, such as streaming ETL, tumble/hop/session windows, watermarks, materialized views, CDC and data revision processing, and more. | ||
| 2. **Fast.** Proton is written in C++, with optimized performance through SIMD. [For example](https://www.timeplus.com/post/scary-fast), on an Apple MacBookPro with M2 Max, Proton can deliver 90 million EPS, 4 millisecond end-to-end latency, and high cardinality aggregation with 1 million unique keys. | ||
| 3. **Lightweight.** Proton is a single binary (\<500MB). No JVM or any other dependencies. You can also run it with Docker, or on an AWS t2.nano instance (1 vCPU and 0.5 GiB memory). |
There was a problem hiding this comment.
Do we need mention 500MB here ?
There was a problem hiding this comment.
<500MB is not a bad number, but yes, this is optional but doesn't hurt. Comparing to other solutions, we are still relatively small size
Add my comments to simplify the messages, guides
|
|
Added Timeplus cloud as one of options
Refine the Proton top level README as well as various README and Docker Compose files in examples folder.