Commit Graph

36 Commits

Author SHA1 Message Date
Viktor Somogyi-Vass 776041db11 KAFKA-7804: Update docs for topic-command related KIP-377
This PR adds a upgrade notes and changes examples to use the bootstrap-server.

Author: Viktor Somogyi-Vass <viktorsomogyi@gmail.com>

Reviewers: Srinivas <srinivas96alluri@gmail.com>, Manikumar Reddy <manikumar.reddy@gmail.com>

Closes #6118 from viktorsomogyi/topiccommand-adminclient-doc
2019-02-04 13:46:33 -08: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
Ismael Juma b4722cc16f
KAFKA-7524: Recommend Scala 2.12 and use it for development (#5530)
Scala 2.12 has better support for newer Java versions and includes additional
compiler warnings that are helpful during development. In addition, Scala 2.11
hasn't been supported by the Scala community for a long time, the soon to be
released Spark 2.4.0 will finally support Scala 2.12 (this was the main reason
preventing many from upgrading to Scala 2.12) and Scala 2.13 is at the RC stage.
It's time to start recommending the Scala 2.12 build as we prepare support for
Scala 2.13 and start thinking about removing support for Scala 2.11.

In the meantime, Jenkins will continue to build all supported Scala versions (including
Scala 2.11) so the PR and trunk jobs will fail if people accidentally use methods
introduced in Scala 2.12.

Reviewers: Ewen Cheslack-Postava <me@ewencp.org>
2018-10-28 11:31:39 -07:00
Mickael Maison 28e29a4c61 MINOR: Updated Quickstart to mention log.dirs (#5361)
The default server.properties file now contains the log.dirs setting and not log.dir anymore.

Co-authored-by: Mickael Maison <mickael.maison@gmail.com>
Co-authored-by: Katherine Farmer <kfarme3@uk.ibm.com>
Reviewers: Manikumar Reddy O <manikumar.reddy@gmail.com>, Sriharsha Chintalapani <sriharsha@apache.org>
2018-07-17 22:24:08 -07:00
Vahid Hashemian ebe749b4ee MINOR: Improve a Windows quickstart instruction
The output of `wmic` can be very long and could truncate the search keywords in the existing command. If those keywords are truncated no process is returned in the output. An update is suggested to the command by which the query is performed inside the `wmic` command itself instead of using pipes and `find`.

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

Reviewers: Guozhang Wang <wangguoz@gmail.com>

Closes #4083 from vahidhashemian/minor/improve_quickstart_for_windows_wmic
2017-10-26 13:46:11 -07:00
Vahid Hashemian beb0ad9bbb MINOR: Make Kafka Connect step in quickstart more Windows friendly
Author: Vahid Hashemian <vahidhashemian@us.ibm.com>

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

Closes #2498 from vahidhashemian/doc/connect_quickstart_update
2017-07-20 22:06:46 -07:00
Eno Thereska 7bfe008ae1 MINOR: Move quickstart under streams
Author: Eno Thereska <eno.thereska@gmail.com>

Reviewers: Michael G. Noll <michael@confluent.io>, Damian Guy <damian.guy@gmail.com>, Guozhang Wang <wangguoz@gmail.com>

Closes #3494 from enothereska/minor-quickstart-docs

rename section name and bold font for section names
2017-07-09 17:35:14 -07:00
Ismael Juma c574c58a16 MINOR: Improve versioning in docs when a full version is required
Also fix quickstart.

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

Reviewers: Damian Guy <damian.guy@gmail.com>

Closes #3501 from ijuma/introduce-full-version-variable-in-docs
2017-07-07 14:41:54 +01:00
Kevin Sweeney 785d8e20ca MINOR: Provide link to ZooKeeper within Quickstart
Author: Kevin Sweeney <restlessdesign@users.noreply.github.com>

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

Closes #3372 from restlessdesign/patch-1
2017-06-22 14:03:39 +01: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
Ismael Juma bcf447e93e KAFKA-4422; Drop support for Scala 2.10 (KIP-119)
Author: Ismael Juma <ismael@juma.me.uk>

Reviewers: Ewen Cheslack-Postava <me@ewencp.org>

Closes #2956 from ijuma/kafka-4422-drop-support-scala-2.10
2017-05-11 08:08:11 +01:00
Matthias J. Sax 2064a2a55d HOTFIX: fix broken link for wordcount demo example
Author: Matthias J. Sax <matthias@confluent.io>

Reviewers: Guozhang Wang <wangguoz@gmail.com>

Closes #2644 from mjsax/hotfixBrokerLink
2017-03-06 09:52:17 -08:00
Vahid Hashemian 601d4040d4 MINOR: Fix quickstart in docs
Reverting some of the recent changes to quickstart doc. Further explanation is provided inline.

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

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

Closes #2539 from vahidhashemian/doc/fix_quickstart_issues
2017-02-10 15:06:54 -08: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
Guozhang Wang c8baf28545 MINOR: Update Streams docs: quickstart and concepts
Added figures for topology and table-stream duality; added sections about aggregations; misc code fixes.

Author: Guozhang Wang <wangguoz@gmail.com>

Reviewers: Damian Guy, Sriram Subramanian

Closes #2482 from guozhangwang/KMinor-streams-docs-first-pass
2017-02-02 10:35:58 -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
Vahid Hashemian 0c83eddcda MINOR: Escape '<' and '>' symbols in quickstart streams code snippet
This was missing from [an earlier PR](https://github.com/apache/kafka/pull/2247) that escaped these symbols in another section of the doc.

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

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

Closes #2453 from vahidhashemian/doc/escape_lt_gt_in_streams_code
2017-01-26 15:04:35 -08:00
Manikumar Reddy O 3c02e5a20f MINOR: Remove duplicate doc headers
Author: Manikumar Reddy O <manikumar.reddy@gmail.com>

Reviewers: Jason Gustafson <jason@confluent.io>

Closes #2021 from omkreddy/LATEST-DOC-CHANGE
2016-10-18 14:09:09 -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
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 179d069857 MINOR: Update Quickstart in documentation to account for Windows platforms
Author: Vahid Hashemian <vahidhashemian@us.ibm.com>

Reviewers: Jason Gustafson <jason@confluent.io>

Closes #1990 from vahidhashemian/doc/quickstart_update_windows
2016-10-09 10:32:01 -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
Matthias J. Sax b8683026ea HOTFIX: changed quickstart donwload from 0.10.0.0 to 0.10.0.1
Author: Matthias J. Sax <matthias@confluent.io>

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

Closes #1869 from mjsax/hotfix-doc
2016-09-17 22:45:29 +01:00
Alex Glikson 87b3ce16c0 MINOR: Fix few documentation errors in streams quickstart
Plus a minor enhancement

Author: glikson <glikson@il.ibm.com>

Reviewers: Guozhang Wang <wangguoz@gmail.com>

Closes #1571 from glikson/patch-1
2016-07-04 19:56:09 -07:00
Guozhang Wang 6cd031e7cf HOTFIX: Remove Java verion 1.6 in quick-start docs
Author: Guozhang Wang <wangguoz@gmail.com>

Reviewers: Guozhang Wang

Closes #1546 from guozhangwang/KHotfix-remove-JDK6-docs
2016-06-23 14:42:20 -07:00
Satendra Kumar 98928f7ad0 Minor: Fix ps command example in docs
Process grep command has been updated. Previous "ps  | grep server-1.properties"  command is showing nothing.

Author: Satendra Kumar <satendra@knoldus.com>

Reviewers: Gwen Shapira

Closes #1386 from satendrakumar06/patch-1
2016-05-24 17:07:45 -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
Grant Henke d578476410 KAFKA-3441: 0.10.0 documentation still says "0.9.0"
Author: Grant Henke <granthenke@gmail.com>

Reviewers: Gwen Shapira

Closes #1122 from granthenke/docs-10
2016-03-23 12:54:26 -07:00
Duncan Sands ae1fd08587 KAFKA-3325: Out of date instructions in quickstart guide
Adjust the listeners property rather than the port.  Following the original instructions would result in all of the brokers being started with the same listeners setting, and so fail to work.

Author: Duncan Sands <baldrick@free.fr>

Reviewers: Ismael Juma, Gwen Shapira

Closes #1002 from CunningBaldrick/quickstart
2016-03-03 11:47:33 -08:00
Sasaki Toru 1faab034b1 MINOR: Remove multi-byte charactor in docs
There are multi-byte characters In quickstart.html and security.html.
This PR will fix it.

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

Reviewers: Grant Henke

Closes #897 from sasakitoa/remove_multi_byte_character
2016-02-10 12:50:57 -07: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
Ismael Juma 2cf6218849 MINOR: Use Kafka artifact compiled with Scala 2.11 in quickstart.html
Author: Ismael Juma <ismael@juma.me.uk>

Reviewers: Jun Rao <junrao@gmail.com>

Closes #505 from ijuma/scala-2.11-in-quickstart
2015-11-12 07:21:45 -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
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