Commit Graph

63 Commits

Author SHA1 Message Date
TengYao Chi 7e86bd8281
KAFKA-18229: Move configs out of "kraft" directory (#18389)
Reviewers: Mickael Maison <mickael.maison@gmail.com>, Ismael Juma <ismael@juma.me.uk>, José Armando García Sancio <jsancio@apache.org>
2025-01-22 15:47:57 +01:00
Mickael Maison 13d9a199f2
KAFKA-18011 Remove ZooKeeper sections from the docs (#17813)
Reviewers: Chia-Ping Tsai <chia7712@gmail.com>
2024-11-26 01:58:48 +08:00
Ken Huang e01f6a5c1e
KAFKA-17740 Update Readme and documentation (#17435)
Reviewers: Chia-Ping Tsai <chia7712@gmail.com>
2024-10-18 10:54:02 +08:00
Colin P. McCabe 3636afb737 HOTFIX: add file that was missed from KAFKA-17048 commit 2024-09-18 11:33:14 -07:00
José Armando García Sancio aee44efd40
KAFKA-17048; Update docs for KIP-853 (#17076)
Change the configurations under config/kraft to use controller.quorum.bootstrap.servers instead of controller.quorum.voters. Add comments explaining how to use the older static quorum configuration where appropriate.

In docs/ops.html, remove the reference to "tentative timelines for ZooKeeper removal" and "Tiered storage is considered as an early access feature" since they are no longer up-to-date. Add KIP-853 information.

In docs/quickstart.html, move the ZK instructions to be after the KRaft instructions. Update the KRaft instructions to use KIP-853.

In docs/security.html, add an explanation of --bootstrap-controller and document controller.quorum.bootstrap.servers instead of controller.quorum.voters.

Reviewers: Mickael Maison <mickael.maison@gmail.com>, Alyssa Huang <ahuang@confluent.io>, Colin P. McCabe <cmccabe@apache.org>
2024-09-18 11:23:58 -07: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
Krishna Agarwal bcf781230e
KAFKA-16932: Add documentation for the native docker image (#16338)
This PR contains the the following documentation changes for the native docker image:

in the docker/README.md: How to build, release and promote the native docker image.
in the tests/README.md: How to run system tests by bringing up kafka in the native mode.
added docker/native/README.md
added html changes for the kafka-site
added native docker image support in the docker compose files examples.

Testing:
Tested all the docker compose files with both the docker images - jvm and native
Tested the html changes locally with the kafka-site

Reviewers: Manikumar Reddy <manikumar.reddy@gmail.com>, Vedarth Sharma <vesharma@confluent.io>
2024-06-16 14:01:13 +05:30
Josep Prat f54975c331
MINOR: Fix code listings in quickstart.html (#10767)
* MINOR: Fix code listings in quickstart

Uses the right syntax highlighting

Reviewers: Mickael Maison <mickael.maison@gmail.com>, Luke Chen <showuon@gmail.com>
2024-02-05 16:43:53 +01:00
Lokesh Kumar 72aa099b22
MINOR: Fixed typo in quickstart documentation (#15037)
Reviewers: Divij Vaidya <diviv@amazon.com>
2023-12-18 13:51:36 +01:00
Vedarth Sharma 0cd2be8718
KAFKA-15879: Add documentation and examples for docker image (#14938)
Reviewers: Manikumar Reddy <manikumar.reddy@gmail.com>
2023-12-12 10:29:05 +05:30
Mickael Maison 74be72a559
MINOR: Various fixes in the docs (#14914)
- Only use https links
- Fix broken HTML tags
- Replace usage of <tt> which is deprecated with <code>
- Replace hardcoded version numbers

Reviewers: Chris Egerton <fearthecellos@gmail.com>, Greg Harris <gharris1727@gmail.com>
2023-12-04 22:06:49 +01:00
José Armando García Sancio 12c0ddc9c0
KAFKA-14188; Getting started for Kafka with KRaft (#12604)
Update the quickstart HTML pages for Kafka and Kafka Stream to include how to quickly start and
experiment with a Kafka cluster using KRaft in addition to ZooKeeper.

Reviews: Colin Patrick McCabe <cmccabe@apache.org>,  Chase Thomas <forlack@users.noreply.github.com>, Luke Chen <showuon@gmail.com>
2022-09-08 16:22:09 -07:00
Janik Dotzel ae3f48b699
MINOR: Fix invalid link to plugin.path property docs in quickstart (#12523)
Reviewers: Chris Egerton <fearthecellos@gmail.com>
2022-08-17 13:25:35 -04:00
Mickael Maison df899a2d08
MINOR: Fix broken link to Streams tutorial (#12426)
Also fix Transforming Data Pt. 2 video title

Reviewer: Bruno Cadonna <cadonna@apache.org>
2022-07-21 15:09:31 +02:00
Richard Joerger 6ff2bf03a9
KAFKA-13875 Adjusted the output the topic describe output to include TopicID & se… (#12170)
Reviewers: Luke Chen <showuon@gmail.com>
2022-06-05 15:13:02 +08:00
JK-Wang 04f23688e7
MINOR: Fix plugin path in quickstart.html (#12252)
Reviewers: Luke Chen <showuon@gmail.com>
2022-06-05 15:08:37 +08:00
Bruno Cadonna 816d63b908
MINOR: Fix link to old doc in quickstart (#12129)
In Kafka's quickstart a link points to the 2.5 Kafka Streams demo.
This PR fixes this link.
2022-05-06 11:43:30 +02:00
Bruno Cadonna 2d2926cf81
MINOR: Make link in quickstart dynamic (#12057)
Reviewer: Matthias J. Sax <mjsax@apache.org>
2022-04-15 16:22:16 +02:00
Konstantine Karantasis dd62ef2eda
KAFKA-13748: Do not include file stream connectors in Connect's CLASSPATH and plugin.path by default (#11908)
With this change we stop including the non-production grade connectors that are meant to be used for demos and quick starts by default in the CLASSPATH and plugin.path of Connect deployments. The package of these connector will still be shipped with the Apache Kafka distribution and will be available for explicit inclusion. 

The changes have been tested through the system tests and the existing unit and integration tests. 

Reviewers: Mickael Maison <mickael.maison@gmail.com>, Randall Hauch <rhauch@gmail.com>
2022-03-30 13:15:42 -07:00
David Jacot fd9fdd8dac
MINOR: Update doc for 3.1 (#11539)
* Update main version of main documentation and add link to previous version;
* Update quick start guide (links do not work yet obviously);
* Add upgrade section.

Reviewers: Luke Chen <showuon@gmail.com>, Manikumar Reddy <manikumar.reddy@gmail.com>
2021-12-03 09:55:33 +01:00
Kate Stanley c0b2afb353
KAFKA-13455: Add steps to run Kafka Connect to quickstart (#11500)
Signed-off-by: Katherine Stanley <11195226+katheris@users.noreply.github.com>
Reviewers: Mickael Maison <mickael.maison@gmail.com>
2021-11-22 14:41:24 +01:00
Andrew Lee c9edb8ad84
MINOR: Fix typo in docs (#10423)
Reviewers: Matthias J. Sax <matthias@confluent.io>
2021-04-09 12:12:52 -07:00
Luke Chen b17f70ed66
MINOR: Fix broken link in quickstart.html (#10161)
Update the old anchor #intro_topic to #intro_concepts_and_terms

Reviewers: Mickael Maison <mickael.maison@gmail.com>
2021-02-19 11:36:12 +00:00
Matthias J. Sax e3b0ea81ca
MINOR: add missing quickstart.html file (#9722)
Reviewers: Guozhang Wang <guozhang@confluent.io>, Bill Bejeck <bill@confluent.io>
2020-12-22 16:45:50 -08: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
Alaa Zbair 5ccd3cd46d
KAFKA-8842: : Reading/Writing confused in Connect QuickStart Guide
In step 7 of the QuickStart guide, "Writing data from the console and writing it back to the console" should be "Reading data from the console and writing it back to the console".

Co-authored-by: Alaa Zbair <alaa.zbair@grenoble-inp.org>

Reviewer: Konstantine Karantasis <konstantine@confluent.io>
2020-03-21 22:00:33 -07:00
Mitch 96c69da8c1
KAFKA-8507; Unify connection name flag for command line tool [KIP-499] (#8023)
This change updates ConsoleProducer, ConsumerPerformance, VerifiableProducer, and VerifiableConsumer classes to add and prefer the --bootstrap-server flag for defining the connection point of the Kafka cluster. This change is part of KIP-499: https://cwiki.apache.org/confluence/display/KAFKA/KIP-499+-+Unify+connection+name+flag+for+command+line+tool.

Reviewers: Ron Dagostino <rdagostino@confluent.io>, Stanislav Kozlovski <stanislav_kozlovski@outlook.com>,  Chia-Ping Tsai <chia7712@gmail.com>, Jason Gustafson <jason@confluent.io>
2020-02-13 13:44:51 -08:00
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