Commit Graph

28 Commits

Author SHA1 Message Date
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
Ewen Cheslack-Postava cea4613533 MINOR: Update docs for version 0.10.2.0
Author: Ewen Cheslack-Postava <me@ewencp.org>

Reviewers: Jason Gustafson <jason@confluent.io>

Closes #2480 from ewencp/docs-version-0.10.2.0
2017-02-01 10:25:24 -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
Vahid Hashemian 8e9e63138d MINOR: Fix table of contents and section numbers in the documentation
Removed a non-existing reference in table of contents and fixed some section numbers.

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

Reviewers: Jason Gustafson <jason@confluent.io>

Closes #2004 from vahidhashemian/doc/fix_toc
2016-10-10 17:09:52 -07:00
Derrick Or 06d6d98bed MINOR: Make documentation follow latest template
Make the latest version of our docs follow the latest site template structure.

Author: Derrick Or <derrickor@gmail.com>

Reviewers: Jason Gustafson <jason@confluent.io>

Closes #2003 from derrickdoo/docs-updates
2016-10-10 14:46:36 -07: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
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
Jay Kreps 16f85e84ce MINOR: Improve introduction section in docs to better cover connect and streams. Make uses and ecosystem pages stand alone. 2016-09-28 16:30:21 -07:00
Ismael Juma 3281b3c904 KAFKA-3283; Remove beta from new consumer documentation
Include a few clean-ups (also in producer section), mention deprecation plans and reorder so that the new consumer documentation is before the old consumers.

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

Reviewers: Jason Gustafson <jason@confluent.io>

Closes #1880 from ijuma/remove-beta-from-new-consumer-documentation
2016-09-19 14:26:26 -07:00
Kaufman Ng 6b2564811a KAFKA-3479: Add new consumer metrics documentation
added new consumer metrics section
refactored common metrics into new section
updated TOC

Author: Kaufman Ng <kaufman@confluent.io>

Reviewers: Jason Gustafson <jason@confluent.io>, Ewen Cheslack-Postava <ewen@confluent.io>

Closes #1361 from coughman/KAFKA-3479-consumer-metrics-doc
2016-08-07 14:29:03 -07:00
Ismael Juma 5f498855d9 MINOR: Fix documentation table of contents and `BLOCK_ON_BUFFER_FULL_DOC`
Author: Ismael Juma <ismael@juma.me.uk>

Reviewers: Gwen Shapira

Closes #1423 from ijuma/minor-doc-fixes
2016-05-24 12:53:24 -07:00
Guozhang Wang 6f1873242c MINOR: Add Kafka Streams API / upgrade notes
Author: Guozhang Wang <wangguoz@gmail.com>

Reviewers: Michael G. Noll <michael@confluent.io>, Ismael Juma <ismael@juma.me.uk>

Closes #1321 from guozhangwang/KStreamsJavaDoc
2016-05-10 08:00:51 +01: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
Gwen Shapira 69df734470 MINOR: fix documentation version
This will need to be double-committed.

Author: Gwen Shapira <cshapi@gmail.com>

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

Closes #1107 from gwenshap/fix-doc-version
2016-03-21 13:15:53 -07: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
Jun Rao 5a9b12eb5d trivial doc fix to add link to Quotas 2015-11-24 09:47:54 -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
Jun Rao f6d369b70d trivial 0.9.0 doc changes to fix links 2015-11-13 18:22:05 -08:00
Jun Rao 5d87eac856 additional trivial 0.9.0 doc changes 2015-11-13 14:18:02 -08:00
Jun Rao 397306cdfe trivial doc changes 2015-11-13 10:34:15 -08:00
Gwen Shapira a8ccdc6154 KAFKA-2790: doc improvements
Author: Gwen Shapira <cshapi@gmail.com>

Reviewers: Jun Rao, Guozhang Wang

Closes #491 from gwenshap/KAFKA-2790
2015-11-11 10:54:09 -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
Grant Henke 69af573b35 KAFKA-2783; Drop outdated hadoop contrib modules
Author: Grant Henke <granthenke@gmail.com>

Reviewers: Gwen Shapira

Closes #466 from granthenke/drop-contrib
2015-11-09 11:02:46 -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
Gwen Shapira 34775bd3ed KAFKA-2681: Added SASL documentation
… info from the wiki

Author: Gwen Shapira <cshapi@gmail.com>

Reviewers: Sriharsha Chintalapani, Jun Rao

Closes #401 from gwenshap/KAFKA-2681
2015-11-02 10:16:39 -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