docs(inkless): update readme with new sections and glossary #483
+236
−9
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
jeqo
force-pushed
the
jeqo/docs-fix-perf
branch
2 times, most recently
from
fcf81a5 to
11df5ae
Compare
jeqo
force-pushed
the
jeqo/docs-fixes
branch
2 times, most recently
from
3ade0f8 to
5fbc089
Compare
giuseppelillo
requested changes
Jan 20, 2026
docs/inkless/GLOSSARY.md
Outdated
| ## B | ||
|
|
||
| **Batch** | ||
| In Inkless, a batch refers to a group of producer records that are written together as part of an object. Batches are the unit of coordination tracked by the Batch Coordinator. |
Contributor
There was a problem hiding this comment.
For more clarity, I would add here that a batch comprises only messages from the same topic partition
docs/inkless/GLOSSARY.md
Outdated
| Configuration that enables clients (producers/consumers) and brokers to prefer operations within the same rack/AZ, minimizing cross-AZ data transfer costs. See [CLIENT-BROKER-AZ-ALIGNMENT.md](./CLIENT-BROKER-AZ-ALIGNMENT.md) for detailed implementation and configuration guide. | ||
|
|
||
| **Read Amplification** | ||
| When reading data for one partition requires fetching objects containing data from multiple partitions. |
Contributor
There was a problem hiding this comment.
I think it's best to be more accurate and define what read amplification is in theory, and then how it applies to diskless like it's described here.
Contributor
Author
There was a problem hiding this comment.
Good idea. Clarifying this on the last commit.
Co-authored-by: Giuseppe Lillo <giuseppe.lillo@aiven.io>
Co-authored-by: Giuseppe Lillo <giuseppe.lillo@aiven.io>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.