Commit Graph

64 Commits

Author SHA1 Message Date
Kaushik Raina dbfda79951
KAFKA-19283: Update transaction exception handling documentation (#19931)
Added docs on Enhancements to transactional producer error handling:

* Added standardized exception categories (`RetriableException`,
`RefreshRetriableException`, `AbortableException`,
`ApplicationRecoverableException`, `InvalidConfigurationException`,
`KafkaException`) to ensure clearer error handling patterns.
* Included a link to example template code for handling transaction
exceptions: [Transaction Client

Demo](https://github.com/apache/kafka/blob/trunk/examples/src/main/java/kafka/examples/TransactionalClientDemo.java).

Reviewers: Justine Olshan <jolshan@confluent.io>
2025-06-09 17:07:29 -07:00
Andrew Schofield 016a4a6c4c
KAFKA-19353: Upgrade note and initial docs for KIP-932 (#19863)
CI / build (push) Waiting to run Details
This is the initial documentation for KIP-932 preview in AK 4.1. The aim
is to get very minimal docs in before the cutoff. Longer term, more
comprehensive documentation will be provided for AK 4.2.

The PR includes:
* Generation of group-level configuration documentation
* Add link to KafkaShareConsumer to API docs
* Add a summary of share group rational to design docs
* Add basic operations information for share groups to ops docs
* Add upgrade note describing arrival of KIP-932 preview in 4.1

Reviewers: Apoorv Mittal <apoorvmittal10@gmail.com>

---------

Co-authored-by: Apoorv Mittal <apoorvmittal10@gmail.com>
2025-06-03 13:23:11 +01:00
Ken Huang b129ed4566
MINOR: Use immutable KIP link (#19153)
Reviewers: TengYao Chi <kitingiao@gmail.com>, Chia-Ping Tsai <chia7712@gmail.com>
2025-03-09 23:42:33 +08:00
mingdaoy a33a413d15
MINOR: Adjust docs for the committed message (#19022)
Reviewers: Andrew Schofield <aschofield@confluent.io>
2025-02-25 13:27:33 +00:00
Calvin Liu a1372ced69
KAFKA-15583 doc update for the "strict min ISR" rule (#18880)
Reviewers: Matthias J. Sax <matthias@confluent.io>, Dave Troiano <dtroiano@confluent.io>, Chia-Ping Tsai <chia7712@gmail.com>
2025-02-23 13:06:50 +08:00
Andrew Schofield c6f2276e32
KAFKA-17671: Create better documentation for transactions (#17454)
Co-authored-by: Matthias J. Sax <mjsax@apache.org>

Reviewers: Matthias Sax <mjsax@apache.org>, Justine Olshan <jolshan@confluent.io>
2025-01-10 09:53:51 +00:00
Mickael Maison 13d9a199f2
KAFKA-18011 Remove ZooKeeper sections from the docs (#17813)
Reviewers: Chia-Ping Tsai <chia7712@gmail.com>
2024-11-26 01:58:48 +08:00
wperlichek 688c2c0913
MINOR: Fix broken hyperlink for producer API in documentation (#17701)
Reviewers: Divij Vaidya <diviv@amazon.com>
2024-11-06 10:26:36 +01:00
tkuramoto33 5a01945cb7
MINOR: Fix javadoc url for KafkaProducer (#17200)
Fix javadoc url for KafkaProducer

Reviewers: Luke Chen <showuon@gmail.com>
2024-09-15 20:00:29 +08:00
Shawn Hsu 3ebad6349d
MINOR: Fix missing code tag in doc (#16466)
Reviewers: Chia-Ping Tsai <chia7712@gmail.com>
2024-06-27 20:52:46 +08:00
Mickael Maison 74be72a559
MINOR: Various fixes in the docs (#14914)
- Only use https links
- Fix broken HTML tags
- Replace usage of <tt> which is deprecated with <code>
- Replace hardcoded version numbers

Reviewers: Chris Egerton <fearthecellos@gmail.com>, Greg Harris <gharris1727@gmail.com>
2023-12-04 22:06:49 +01:00
Lucia Cerchie 17862ffaf2
KAFKA-15418: update Kafka design docs with decompression information (#14322)
Reviewers: Divij Vaidya <diviv@amazon.com>, Matthias J. Sax <mjsax@apache.org>

---------

Co-authored-by: Cerchie <lcerchie@confluent.io>
2023-09-08 11:58:32 +02:00
minjian.cai 49c1697ab0
MINOR: fix typos for doc (#13883)
Reviewers: Divij Vaidya <diviv@amazon.com>
2023-06-21 09:57:43 +02:00
Chase Thomas d2f900b055
MINOR: Small update docs/design.html grammar and typo (#12691)
Reviewers: Jason Gustafson <jason@confluent.io>
2022-09-27 11:46:25 -07:00
Jason Gustafson 1c0f8f90e2
MINOR: Update design docs to avoid zookeeper-specific assumptions (#12690)
Update a few cases in the documentation which do not make sense for KRaft.

Reviewers: José Armando García Sancio <jsancio@users.noreply.github.com>
2022-09-26 13:01:07 -07:00
RivenSun 53ad99309d
MINOR: Improve document description in zero-copy (#12099)
Follow up of #12052 to improve the description.

Reviewer: David Jacot <djacot@confluent.io>
2022-04-29 17:44:39 +02:00
RivenSun fb66b3668b
KAFKA-13799: Improve documentation for Kafka zero-copy (#12052)
Improve documentation for Kafka zero-copy. Kafka combines pagecache and zero-copy to greatly improve message consumption efficiency. But zero-copy only works in PlaintextTransportLayer.

Reviewers: Divij Vaidya <divijvaidya13@gmail.com>, Guozhang Wang <wangguoz@gmail.com>
2022-04-20 10:31:32 -07:00
Luke Chen e82df83968
KAFKA-13374: Update doc to mention read from leader/followers (#11408)
Reviewers: Mickael Maison <mickael.maison@gmail.com>
2021-12-20 18:34:20 +01:00
Lee Dongjin 9d305c79d3
KAFKA-13430: Remove broker-wide quota properties from the documentation (#11463)
Reviewers: David Jacot <djacot@confluent.io>
2021-11-04 10:04:02 +01:00
Josep Prat f5a94d913f
MINOR: Fix indentation for several doc pages (#10766)
Fixes the indentation of the code listings for:

api.html
configuration.html
design.html
implementation.html
toc.html
These changes consist of whitespaces added or removed for consistency. It also contains a couple of fixes on unbalanced html tags.

Reviewers: Luke Chen <showuon@gmail.com>, Bill Bejeck <bbejeck@apache.org>
2021-06-17 15:58:40 -04:00
Tom Bentley 6add0594a7
MINOR: Remove erroneous extra <code> in design doc (#9657)
Reviewers: Bill Bejeck <bbejeck@apache.org>
2020-11-30 15:41:14 -05:00
Bill Bejeck b4f00d7ef6
KAFKA-10679: Migrate upgrade changes from site to kafka/docs (#9551)
During the AK website upgrade, changes made to kafka-site weren't migrated back to kafka-docs.

This PR is an initial attempt at porting the changes to kafka/docs, but it does not include the streams changes. Those will come in a separate PR.

For the most part, the bulk of the changes in the PR are cosmetic. Only the introduction.html has substantial changes, but it's a direct port from the live documentation.

For testing:

I reviewed the PR diffs
Rendered the changes locally

Reviewers: Matthias J. Sax <mjsax@apache.org>
2020-11-03 13:40:44 -05:00
Tom Bentley cfadb8b8d9
MINOR: Define the term tombstone, since it's used elsewhere in the docs (#3480)
Reviewers: Manikumar Reddy <manikumar.reddy@gmail.com>
2020-07-09 16:27:52 +05:30
showuon 2bc87de08e
MINOR: Update the link to the Raft paper in docs (#8560)
Update the link to the Raft paper pointing to the Usenix conference link.

old broken link: https://ramcloud.stanford.edu/wiki/download/attachments/11370504/raft.pdf
new link: https://www.usenix.org/system/files/conference/atc14/atc14-paper-ongaro.pdf

Reviewers: Boyang Chen <boyang@confluent.io>, Konstantine Karantasis <konstantine@confluent.io>
2020-04-27 23:25:46 -07:00
Boyang Chen 27943e3987 KAFKA-8219: add doc changes for static membership release (#6790)
* add doc changes for static membership release

* address comments

* address comments for a separate page

* address Matthias' comment
2019-05-27 14:25:47 -07:00
commandini 51c72ad025 MINOR: Fixed broken link to the IBM article about j-zerocopy (#6749)
Reviewers: Jason Gustafson <jason@confluent.io>
2019-05-18 14:41:39 -07:00
Xiongqi Wu b86e8c1ea9 MINOR: add docs for KIP-354 KAFKA-7321 (#6724)
MINOR: update documentation for the log cleaner max compaction lag feature (KIP-354) implemented in KAFKA-7321

Author: Xiongqi Wu <xiowu@linkedin.com>
Reviewer: Joel Koshy <jjkoshy@gmail.com>
2019-05-13 22:54:06 -07:00
Joyce Fee cc4a7f01e8 MINOR: cleanup policy doc update (#6692)
Reviewers: Guozhang Wang <wangguoz@gmail.com>
2019-05-08 18:38:28 -07:00
Sayat eede70a805 KAFKA-7413: Replace slave terminology with follower in documentation (#5653)
Reviewers: John Roesler <john@confluent.io>, Ryanne Dolan, Ismael Juma <ismael@juma.me.uk>
2018-10-28 22:12:42 -07:00
John Eismeier 83c3996974 MINOR: Fix some typos
Just a doc change

Author: John Eismeier <john.eismeier@gmail.com>

Reviewers: Ewen Cheslack-Postava <ewen@confluent.io>

Closes #4573 from jeis2497052/trunk
2018-10-20 19:40:53 -07:00
Lee Dongjin 741cb761c5 KAFKA-4514; Add Codec for ZStandard Compression (#2267)
This patch adds support for zstandard compression to Kafka as documented in KIP-110: https://cwiki.apache.org/confluence/display/KAFKA/KIP-110%3A+Add+Codec+for+ZStandard+Compression. 

Reviewers: Ivan Babrou <ibobrik@gmail.com>, Ismael Juma <ismael@juma.me.uk>, Jason Gustafson <jason@confluent.io>
2018-10-09 17:13:33 -07:00
Jon Lee f9cdadfdcf KAFKA-7177; Update 2.0 documentation to reflect changed quota behaviors by KIP-219
Updated the 2.0 document for changed quota behaviors.

Author: Jon Lee <jonlee@linkedin.com>

Reviewers: Ismael Juma <ismael@juma.me.uk>, Dong Lin <lindong28@gmail.com>

Closes #5384 from jonlee2/KAFKA-7177
2018-07-21 00:04:16 -07:00
Ivan Babrou b887eeb721
KAFKA-4711: fix docs on unclean.leader.election.enable default 2017-07-24 12:06:12 -07:00
Jason Gustafson cb3952a4fd KAFKA-5021; Update delivery semantics documentation for EoS (KIP-98)
Author: Jason Gustafson <jason@confluent.io>

Reviewers: Apurva Mehta <apurva@confluent.io>, Ismael Juma <ismael@juma.me.uk>, Guozhang Wang <wangguoz@gmail.com>

Closes #3388 from hachikuji/KAFKA-5021
2017-06-20 16:56:38 -07:00
Edoardo Comar 491774bd52 KAFKA-5290; Docs need clarification on meaning of 'committed' to the log
based on conversations with vahidhashemian rajinisivaram apurvam

The docs didn't make clear that what gets committed and what gets not may depend on the producer acks.

Author: Edoardo Comar <ecomar@uk.ibm.com>

Reviewers: Vahid Hashemian <vahidhashemian@us.ibm.com>, Apurva Mehta <apurva@confluent.io>, Jason Gustafson <jason@confluent.io>

Closes #3035 from edoardocomar/DOC-clarification-on-committed
2017-06-20 14:21:53 -07:00
Guozhang Wang 57b0d0fe57 MINOR: syntax brush for java / bash / json / text
Author: Guozhang Wang <wangguoz@gmail.com>

Reviewers: Derrick Or <derrickor@gmail.com>, Ismael Juma <ismael@juma.me.uk>

Closes #3214 from guozhangwang/KMinor-doc-java-brush
2017-06-07 15:17:25 +01:00
Rajini Sivaram 670193f22d KAFKA-4957; Request rate quotas documentation
Author: Rajini Sivaram <rajinisivaram@googlemail.com>

Reviewers: Jun Rao <junrao@gmail.com>

Closes #3069 from rajinisivaram/KAFKA-4957
2017-05-16 16:36:25 -07:00
dasl c063172c23 MINOR: Fix error in design docs
Author: dasl <dasl-@users.noreply.github.com>

Reviewers: Gwen Shapira

Closes #2357 from dasl-/trunk
2017-01-12 11:28:46 -08:00
Derrick Or 53428694a6 Separate Streams documentation and setup docs with easy to set variables
- Seperate Streams documentation out to a standalone page.
- Setup templates to use handlebars.js
- Create template variables to swap in frequently updated values like version number from a single file templateData.js

Author: Derrick Or <derrickor@gmail.com>

Reviewers: Guozhang Wang <wangguoz@gmail.com>

Closes #2245 from derrickdoo/docTemplates
2016-12-13 17:59:49 -08:00
Apurva Mehta c62dc28ceb MINOR: Fix documentation of compaction
Removed a duplicate line and also cleaned up some of the language around compaction guarantees.

Author: Apurva Mehta <apurva.1618@gmail.com>

Reviewers: Gwen Shapira

Closes #2089 from apurvam/fix-documentation-of-compaction and squashes the following commits:

03c5bdd [Apurva Mehta] Fix line length to be consistent with the rest of the file
0af1a86 [Apurva Mehta] MINOR: fix duplicate line in docs for compaction.
2016-11-01 18:17:42 -07:00
Jason Gustafson 9662e466d9 MINOR: Some images should be centered in the documentation
Author: Jason Gustafson <jason@confluent.io>

Reviewers: Ismael Juma <ismael@juma.me.uk>

Closes #2029 from hachikuji/center-some-images
2016-10-14 10:04:13 -07:00
Vahid Hashemian ae9532c6b3 MINOR: Fixed broken links in the documentation
Author: Vahid Hashemian <vahidhashemian@us.ibm.com>

Reviewers: Jason Gustafson <jason@confluent.io>

Closes #2010 from vahidhashemian/doc/fix_hyperlinks
2016-10-11 20:25:35 -07:00
Andrea Cosentino 9179bbc067 KAFKA-4130; Link to Varnish architect notes is broken
Author: Andrea Cosentino <ancosen@gmail.com>

Reviewers: Jason Gustafson <jason@confluent.io>

Closes #1835 from oscerd/KAFKA-4130
2016-10-11 09:32:36 -07:00
Vahid Hashemian e972d2afd3 MINOR: Fix typos in documentation
And improve readability by adding proper punctuations.

Author: Vahid Hashemian <vahidhashemian@us.ibm.com>

Reviewers: Jason Gustafson <jason@confluent.io>

Closes #2002 from vahidhashemian/doc/fix_typos
2016-10-10 15:58:37 -07:00
pilo 91d025e063 MINOR: Clarify doc on consumption of topics
In doc it stays:

_"Our topic is divided into a set of totally ordered partitions, each of which is consumed by one consumer at any given time."_

And consumer is described as:

_"We'll call **processes** that subscribe to topics and process the feed of published messages **consumers**."_

Which might lead to a wrong conclusion - that each partition can be read by one process at any given time.

I think this statements misses information about **consumer groups**, so i propose:

_"Our topic is divided into a set of totally ordered partitions, each of which is consumed by exactly one consumer (from each subscribed consumer groups) at any given time"_

This contribution is my original work and I license the work to the project under the project's open source license.

Author: pilo <jakub.pilimon@4finance.com>

Reviewers: Jiangjie Qin <becket.qin@gmail.com>, Jason Gustafson <jason@confluent.io>

Closes #1900 from pilloPl/minor/doc-fix
2016-10-03 19:35:54 -07:00
Rajini Sivaram f27a6f319a KAFKA-4079; Documentation for secure quotas
Details in KIP-55.

Author: Rajini Sivaram <rajinisivaram@googlemail.com>

Reviewers: Jun Rao <junrao@gmail.com>

Closes #1847 from rajinisivaram/KAFKA-4079
2016-09-19 12:16:45 -07:00
Eric Wasserman 5f040cd77f KAFKA-1981; Make log compaction point configurable
Now uses LogSegment.largestTimestamp to determine age of segment's messages.

Author: Eric Wasserman <eric.wasserman@gmail.com>

Reviewers: Jun Rao <junrao@gmail.com>

Closes #1794 from ewasserman/feat-1981
2016-09-11 20:45:05 -05:00
Nihed Bbarek c2459d3251 MINOR: Update design.html
Since 0.9.0.1 Configuration parameter log.cleaner.enable is now true by default.

Author: Nihed MBAREK <nihedmm@gmail.com>

Reviewers: Ismael Juma <ismael@juma.me.uk>

Closes #1592 from nihed/patch-1
2016-07-09 02:07:46 +01:00
Paul Cavallaro 3a20ba3055 MINOR: Fix small typo in design section
Sentence was missing "as", minor grammar clean up.

Author: Paul Cavallaro <paulcavallaro@gmail.com>

Reviewers: Ewen Cheslack-Postava <ewen@confluent.io>

Closes #1151 from paulcavallaro/docs-fix
2016-04-03 18:14:53 -07:00
Manikumar reddy O ac7b2e95d3 KAFKA-2551; Update Unclean leader election docs
Author: Manikumar reddy O <manikumar.reddy@gmail.com>

Reviewers: Ismael Juma <ismael@juma.me.uk>, Sriharsha Chintalapani <mail@harsha.io>

Closes #1054 from omkreddy/KAFKA-2551
2016-03-13 20:32:47 -07:00