Commit Graph

22 Commits

Author SHA1 Message Date
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
Robert Young 41fc058573
MINOR: Add protocol documentation about ApiVersions Fallback behaviour (#17967)
Documents current ApiVersions fallback mechanism

The broker behaviour when it receives an ApiVersionsRequest ahead of it's supported versions is useful to know as an implementor/manipulator of the protocol.

The behaviour contradicts a point documented in the protocol guide. In the fallback case the protocol version of the response is different from the protocol version of the request.

Also spotted a couple of dead links in the table of contents

Signed-off-by: Robert Young <robeyoun@redhat.com>

Reviewers: Luke Chen <showuon@gmail.com>
2024-12-05 11:22:27 +08:00
Ivan Yurchenko d0f4d691b5
KAFKA-17322: Document required header versions in Protocol Guide (#16867)
Reviewers: Josep Prat <josep.prat@aiven.io>
2024-09-16 14:19:47 +02:00
Ivan Yurchenko ab1eb8d561
KAFKA-17494: Document message structure in Protocol Guide (#17122)
Reviewers: Josep Prat <josep.prat@aiven.io>
2024-09-16 12:03:59 +02:00
Ken Huang 2bc5e01121
KAFKA-17051 ApiKeys#toHtml should exclude the APIs having unstable latest version (#16480)
Reviewers: Chia-Ping Tsai <chia7712@gmail.com>
2024-07-03 02:52:14 +08:00
Mickael Maison c4a3d2475f
MINOR: Refresh of the docs (#16375)
Reviewers: Luke Chen <showuon@gmail.com>, Chia-Ping Tsai <chia7712@gmail.com>
2024-06-18 17:15:47 +02: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
Jorge Esteban Quilcate Otoya 57961c33de
MINOR: Fix partition numbering from 0 to P-1 instead of P in docs (#8572)
Small typo fix

Reviewers: Konstantine Karantasis <konstantine@confluent.io>
2020-04-28 12:10:03 -07:00
Colin P. Mccabe 67fd88050f KAFKA-8984: Improve tagged fields documentation
Author: Colin P. Mccabe <cmccabe@confluent.io>

Reviewers: Vikas Singh <vikas@confluent.io>, Jason Gustafson <jason@confluent.io>

Closes #7477 from cmccabe/KAFKA-8984
2019-11-09 10:37:48 +05:30
康智冬 c5f2bd64d1 MINOR: Fix few typos in the javadocs/docs 2019-09-05 09:07:23 +05:30
Gantigmaa Selenge 42610e5aa1 MINOR: Fix broken link to record format in protocol docs (#5526)
Co-authored-by: Mickael Maison <mickael.maison@gmail.com>
Co-authored-by: Gantigmaa Selenge  <tina.selenge@gmail.com>

Reviewers: Sriharsha Chintalapani <sriharsha@apache.org>, Jason Gustafson <jason@confluent.io>
2018-08-24 14:03:58 -07:00
Andras Beni 462342210f KAFKA-3365; Add documentation method for protocol types and update doc generation (#4735)
Reviewers: Sandor Murakozi <smurakozi@gmail.com>, Magnus Edenhill <magnus@edenhill.se>, Jason Gustafson <jason@confluent.io>
2018-04-18 09:18:45 -07:00
Mickael Maison 36d4b91573 MINOR: Updated SASL Authentication Sequence Docs (#4724)
Reworded the SASL Authentication sequence to update it to >= 1.0.0

Co-authored-by: Edoardo Comar <ecomar@uk.ibm.com>, Mickael Maison <mickael.maison@gmail.com>

Reviewers: Rajini Sivaram <rajinisivaram@googlemail.com>
2018-03-20 13:56:40 +00:00
Andras Beni 29d2e8cf17 KAFKA-3368; Add documentation for old message format (#3425) 2018-03-12 15:13:34 -07:00
Guozhang Wang a15fcea799 MINOR: add architecture section and configure / execution for streams
1. Added an architecture section.
2. Added a configuration / execution sub-section to developer guide.

Minor tweaks and a bunch of missing fixes from `kafka-site` repo.

Author: Guozhang Wang <wangguoz@gmail.com>

Reviewers: Matthias J. Sax <matthias@confluent.io>, Derrick Or <derrickor@gmail.com>, Ewen Cheslack-Postava <ewen@confluent.io>

Closes #2488 from guozhangwang/KMinor-streams-docs-second-pass
2017-02-09 19:13:23 -08:00
Colin P. Mccabe 4a14adbb63 KAFKA-4664; Update docs/protocol.html with KIP-97 information
Author: Colin P. Mccabe <cmccabe@confluent.io>

Reviewers: Gwen Shapira <cshapi@gmail.com>, Ismael Juma <ismael@juma.me.uk>

Closes #2387 from cmccabe/KAFKA-4664
2017-01-27 21:39:27 +00:00
Gwen Shapira 7599d5d78b MINOR: Fix document header/footer links
Based on:  https://github.com/apache/kafka-site/pull/27

I recommend also merging into 10.1.0.0 branch to avoid mishaps when re-publishing docs.

Author: Gwen Shapira <cshapi@gmail.com>

Reviewers: Guozhang Wang <wangguoz@gmail.com>

Closes #2077 from gwenshap/protocol_doc_fix
2016-12-21 13:33:39 -08:00
Gwen Shapira bf98c47389 KAFKA-4244; Fix formatting issues in documentation
Author: Gwen Shapira <cshapi@gmail.com>

Reviewers: Jason Gustafson <jason@confluent.io>

Closes #1966 from gwenshap/KAFKA-4244
2016-10-10 13:39:05 -07:00
Ashish Singh b1ba54025f KAFKA-3699: Update protocol page on website to explain how KIP-35 should be used
…uld be used

Author: Ashish Singh <asingh@cloudera.com>

Reviewers: Oleksiy Krivoshey <oleksiy@luckyteam.co.uk>, Gwen Shapira <cshapi@gmail.com>, Magnus Edenhill <magnus@edenhill.se>, Dana Powers <dana.powers@gmail.com>, Ewen Cheslack-Postava <ewen@confluent.io>

Closes #1395 from SinghAsDev/KAFKA-3699
2016-06-14 09:50:30 -07:00
Rajini Sivaram abac51dc0b KAFKA-3517; Add documentation for SASL/PLAIN
Documentation corresponding to KIP-43 - SASL/PLAIN and multiple mechanism support.

Author: Rajini Sivaram <rajinisivaram@googlemail.com>

Reviewers: Magnus Edenhill <apache_m@edenhill.se>, Jun Rao <junrao@gmail.com>

Closes #1232 from rajinisivaram/KAFKA-3517
2016-05-03 09:49:23 -07:00
Grant Henke 1a451b4812 MINOR: Add header and footer to protocol docs
Because protocol.html is going to be in its own page it needs the header and footer included.

Author: Grant Henke <granthenke@gmail.com>

Reviewers: Gwen Shapira

Closes #1043 from granthenke/protocol-docs-style
2016-03-10 10:44:58 -08:00
Grant Henke f0a4125d3e KAFKA-3361: Initial protocol documentation page and generation
- Moves all generated docs under /docs/generated
- Generates docs for Protocol, Errors, and ApiKeys
- Adds new protocol.html page

Author: Grant Henke <granthenke@gmail.com>

Reviewers: Gwen Shapira

Closes #970 from granthenke/protocol-doc-wip
2016-03-09 21:13:54 -08:00