Commit Graph

22 Commits

Author SHA1 Message Date
Vahid Hashemian 3bfc073f03 MINOR: Make 'Topic-Level Configs' a doc section for easier access
Author: Vahid Hashemian <vahidhashemian@us.ibm.com>

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

Closes #3415 from vahidhashemian/doc/make_topic_config_a_section
2017-07-19 14:25:02 +01:00
Ismael Juma c57cfdf4fa KAFKA-5411: AdminClient javadoc and documentation improvements
- Show AdminClient configs in the docs.
- Update Javadoc config so that public classes exposed by
the AdminClient are included.
- Version and table of contents fixes.

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

Reviewers: Colin Mccabe, Gwen Shapira

Closes #3271 from ijuma/kafka-5411-admin-client-javadoc-configs
2017-06-08 15:27:30 -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
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
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
Vahid Hashemian d2a267b111 KAFKA-3697; Clean up website documentation of client usage
This is to imply that the Java consumer/producer are the recommended consumer/producer now.

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

Reviewers: Jason Gustafson <jason@confluent.io>

Closes #1921 from vahidhashemian/KAFKA-3697
2016-09-29 19:37:20 -07:00
Ashish Singh dddb79f312 MINOR: Update Kafka configuration documentation to use kafka-configs.…
…sh, instead of deprecated kafka-topics.sh --alter

Author: Ashish Singh <asingh@cloudera.com>

Reviewers: Gwen Shapira

Closes #1772 from SinghAsDev/MinorKafkaConfigsDoc
2016-08-25 19:15:51 -07:00
James Cheng 778fcd0e91 KAFKA-3809: Auto-generate documentation for topic-level configuration
ijuma said that it would make sense to split out this work from KAFKA-3234, since KAFKA-3234 had both a mechanical change (generating docs) as well as a change requiring discussion (deprecating/renaming config options).

jjkoshy, I hope you don't mind that I took over this work. It's been 3 months since the last activity on KAFKA-3234, so I thought it would be okay to take over.

This work is essentially is the first 5-6 commits from Joel's https://github.com/apache/kafka/pull/907. However, since I'm not very experienced with git, I didn't do a direct merge/rebase, but instead largely hand-merged it. I did some minor cleanup. All credit goes to Joel, all blame goes to me. :)

For reference, I attached the auto-generated configuration.html file (as a PDF, because github won't let me attache html).
[configuration.pdf](https://github.com/apache/kafka/files/323901/configuration.pdf)

This is my first time writing Scala, so let me know if there are any changes needed.

I don't know who is the right person to review this. ijuma, can you help me redirect this to the appropriate person? Thanks.

Author: James Cheng <jylcheng@yahoo.com>

Reviewers: Ismael Juma <ismael@juma.me.uk>, Joel Koshy <jjkoshy@gmail.com>, Ewen Cheslack-Postava <ewen@confluent.io>

Closes #1527 from wushujames/generate_topic_docs
2016-08-06 18:14:53 -07:00
Dionysis Grigoropoulos f60a3fad38 MINOR: Typo fixes in ReplicaFetchMaxBytesDoc
Author: Dionysis Grigoropoulos <dgrig@erethon.com>

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

Closes #1228 from Erethon/trunk
2016-04-26 11:25:23 -07:00
Guozhang Wang 23b50093f4 KAFKA-3454: add Kafka Streams web docs
Author: Guozhang Wang <wangguoz@gmail.com>

Reviewers: Gwen Shapira

Closes #1127 from guozhangwang/KStreamsDocs
2016-03-25 16:04:58 -07: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
Grant Henke f292820920 KAFKA-2589: The default value for the "rebalance.backoff.ms" property is not specified correctly
… is not specified correctly

Author: Grant Henke <granthenke@gmail.com>

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

Closes #876 from granthenke/rebalance-doc
2016-02-05 13:25:21 -08:00
David Jacot 5979480c3a KAFKA-3098: "partition.assignment.strategy" appears twice in documentation
Author: David Jacot <david.jacot@gmail.com>

Reviewers: Gwen Shapira

Closes #774 from dajac/KAFKA-3098
2016-01-18 09:56:12 -08:00
Eamon Zhang 70011747c8 MINOR: modify config specification of topic level
topic level config delete config options

use --delete-config instead of --deleteConfig

Author: eamon <zhang.eamon@hotmail.com>

Reviewers: Ismael Juma, Grant Henke, Guozhang Wang

Closes #612 from EamonZhang/trunk
2016-01-13 15:01:20 -08:00
Sasaki Toru d9ddc109fd KAFKA-3043: Replace request.required.acks with acks in docs.
In Kafka 0.9, request.required.acks=-1 which configration of producer is replaced by acks=all,
but this old config is remained in docs.

Author: Sasaki Toru <sasakitoa@nttdata.co.jp>

Reviewers: Gwen Shapira

Closes #716 from sasakitoa/acks_doc
2015-12-26 23:14:31 -08:00
Guozhang Wang 395bf46dda KAFKA-2881: Improve Consumer Configs and API Documentation
Author: Guozhang Wang <wangguoz@gmail.com>

Reviewers: Gwen Shapira

Closes #584 from guozhangwang/K2881
2015-11-24 16:39:01 -08:00
Grant Henke 6cbd97597c KAFKA-2809; Improve documentation linking
Often it is useful to link to a specific header within the documentation. Especially when referencing docs in the mailing lists.

This adds anchors and links for all headers in the docs.

Author: Grant Henke <granthenke@gmail.com>

Reviewers: Jun Rao <junrao@gmail.com>

Closes #498 from granthenke/doc-links
2015-11-16 14:14:17 -08:00
Ewen Cheslack-Postava 83eaf3284f KAFKA-2379: Add basic documentation for Kafka Connect.
Author: Ewen Cheslack-Postava <me@ewencp.org>

Reviewers: Gwen Shapira

Closes #475 from ewencp/kafka-2379-connect-docs
2015-11-09 16:29:30 -08:00
Guozhang Wang a87b978223 MINOR: remove old producer in config sections to align with APIs
Author: Guozhang Wang <wangguoz@gmail.com>

Reviewers: Gwen Shapira

Closes #468 from guozhangwang/WikiUpdate
2015-11-09 13:36:35 -08:00
Gwen Shapira b4e1bdf48b KAFKA-2666: Docs: Automatically generate documentation from config classes
…the way we always planned to

Author: Gwen Shapira <cshapi@gmail.com>

Reviewers: Jun Rao, Guozhang Wang

Closes #382 from gwenshap/KAFKA-2666
2015-11-06 19:23:15 -08:00
Grant Henke fc4ef47910 KAFKA-2645: Document potentially breaking changes in the release note…
…s for 0.9.0

Author: Grant Henke <granthenke@gmail.com>

Reviewers: Gwen Shapira, Guozhang Wang

Closes #337 from granthenke/docs
2015-10-27 07:43:19 -07:00
Manikumar reddy O 4016011457 KAFKA-2425; Copy latest docs to kafka repo docs/ directory
This PR copies the latest kafka docs to kafka repo docs directory. Here I have copied 0.8.3/ directory contents from svn website repo to kafka/docs repository.

Some questions: This PR contains generated javadocs also.  Do we need to copy javadocs here?

Author: Manikumar reddy O <manikumar.reddy@gmail.com>

Reviewers: Gwen Shapira, Ismael Juma

Closes #171 from omkreddy/KAFKA-2425-MOVE-DOCS-TO-KAFKA-REPO
2015-10-03 06:50:45 -07:00