Skip to content

KAFKA-3361: Initial protocol documentation page and generation (0.9)#1038

Closed
granthenke wants to merge 2 commits into
apache:0.9.0from
granthenke:protocol-docs-0.9
Closed

KAFKA-3361: Initial protocol documentation page and generation (0.9)#1038
granthenke wants to merge 2 commits into
apache:0.9.0from
granthenke:protocol-docs-0.9

Conversation

@granthenke
Copy link
Copy Markdown
Member

  • Moves all generated docs under /docs/generated
  • Generates docs for Protocol, Errors, and ApiKeys
  • Adds new protocol.html page

- Moves all generated docs under /docs/generated
- Generates docs for Protocol, Errors, and ApiKeys
- Adds new protocol.html page
Comment thread docs/protocol.html Outdated
@@ -0,0 +1,163 @@
<h3><a id="protocol" href="#protocol">Kafka Wire Protocol</a></h3>

<p>This document covers the protocol implemented in Kafka 0.8 and beyond. It is meant to give a readable guide to the protocol that covers the available requests, their binary format, and the proper way to make use of them to implement a client. This document assumes you understand the basic design and terminology described <a href="https://kafka.apache.org/documentation.html#design">here</a></p>
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Didn't we change that?

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We did...not sure why the cherry pick missed it. Will fix.

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Updated. Tried to cherry pick both commits at once, must have ignored this one.

asfgit pushed a commit that referenced this pull request Mar 10, 2016
- 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 #1038 from granthenke/protocol-docs-0.9
@gwenshap
Copy link
Copy Markdown
Contributor

LGTM. Site repo is next?
I'm not planning on reviewing it tonight though.

@granthenke
Copy link
Copy Markdown
Member Author

@gwenshap Yeah, I will work on that tomorrow.

@granthenke granthenke closed this Mar 10, 2016
efeg pushed a commit to efeg/kafka that referenced this pull request Jan 29, 2020
mumrah pushed a commit to mumrah/kafka that referenced this pull request Aug 14, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants