Skip to content

Commit

Permalink
Small doc fixes
Browse files Browse the repository at this point in the history
  • Loading branch information
vevi committed Sep 15, 2022
1 parent 795415e commit ee2821d
Show file tree
Hide file tree
Showing 3 changed files with 9 additions and 7 deletions.
3 changes: 3 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,9 @@ We aim to respond to your issues soonest. If you wish to receive a faster respon
your steps and provide information about your environment in the bug reports. And if you're proposing a new feature,
it'll help us to evaluate the priority if you explain why you need it.

The label ["good first issue"](https://github.com/barcostreams/barco/labels/good%20first%20issue) marks tasks that are
beginner-friendly.

## Client libraries

[Barco Client in golang][go-client] is the reference implementation under Apache License 2.0 and it's currently the
Expand Down
11 changes: 5 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,9 @@
# Barco Streams

Barco is a lightweight, elastic, kubernetes-native event streaming system. It acts as a persistent buffer between
services, supporting peaks by seamlessly scaling and allowing events to be consumed at a later time from
the peak.
Barco is a lightweight, elastic, Kubernetes-native event streaming system. It acts as a persistent buffer between
services providing at least once delivery guarantees.

Barco Streams is optimized to be resource efficient, have minimal operational overhead and be a good K8s neighbor.

![go build](https://github.com/barcostreams/barco/actions/workflows/go.yml/badge.svg)

Expand Down Expand Up @@ -37,9 +38,7 @@ the peak.
Barco Streams is not production ready, expect bugs and things that don't work.

We honestly value your contribution to make this project ready for general availability. If you want to contribute,
check out the [Issues section on GitHub](https://github.com/barcostreams/barco/issues).
The label ["good first issue"](https://github.com/barcostreams/barco/labels/good%20first%20issue) marks tasks that are
beginner-friendly.
check out the [Contributing Guide](./CONTRIBUTING.md).
</details>

-----
Expand Down
2 changes: 1 addition & 1 deletion docs/TECHNICAL_INTRO.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ Bypassing the kernel page cache has the following benefits:
for resources with unrelated applications on the K8s node.
- No copies between the kernel cache and the internal read/write buffers.
- We can use read ahead strategies tuned to the workload when reading.
- We can use buffering and flush strategies tuned to the workload when reading.
- We can use buffering and flush strategies tuned to the workload when writing.
- We can control exactly the amount of memory dedicated for buffers and caching (K8s working set).

Additionally, when writing, Barco brokers [compresses and checksums chunks](./developer/FILE_FORMATS.md) of data once
Expand Down

0 comments on commit ee2821d

Please sign in to comment.