Commit Graph

25 Commits

Author SHA1 Message Date
Matthias J. Sax d8c98f2e82
MINOR: fix KafkaStreams archtype docs (#18469)
Reviewers: Chia-Ping Tsai <chia7712@gmail.com>
2025-01-13 11:19:32 -08: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
Matthias J. Sax 364bc3c5c4
MINOR: Fix directory name inconsistency in the Kafka Streams tutorial (#14541)
Reviewers: Bruno Cadonna <bruno@confluent.io>
2023-10-13 09:28:39 -07:00
Okada Haruki a39d447677
MINOR: fix streams tutorial (#12251)
Reviewers: Luke Chen <showuon@gmail.com>
2022-06-04 13:23:11 +08:00
Josep Prat aa25176e77
MINOR: Kafka Streams code samples formating unification (#10651)
Code samples are now unified and correctly formatted.
Samples under Streams use consistently the prism library.

Reviewers: Bruno Cadonna <cadonna@apache.org>
2021-05-21 17:27:42 +02:00
Bill Bejeck e847f057e3
KAFKA-10679: [Streams] migrate kafka-site updated docs to kafka/docs (#9554)
During the AK website upgrade, changes made to kafka-site weren't migrated back to kafka-docs.

This PR is an attempt at porting the streams changes to kafka/docs

For the most part, the bulk of the changes in the PR are cosmetic.

For testing:

I reviewed the PR diffs
Rendered the changes locally

Reviewers: John Roesler <john@confluent.io>
2020-11-04 08:30:10 -05:00
Kengo Seki fb3d26d5b7
MINOR: Fix an example in the Kafka Streams tutorial to be compilable (#6647)
Reviewers: Chia-Ping Tsai <chia7712@gmail.com>
2020-11-03 10:49:49 +08:00
Xin Wang 0ee9bf326d MINOR: Add missing parentheses in docs/streams/tutorial.html (#7696)
Reviewers: Jason Gustafson <jason@confluent.io>
2019-11-18 08:41:40 -08:00
Alice 07a154eee7 MINOR: Streams tutorial refers to code in the wrong directory (#7012)
The Pipe.java file should exist within the myapps package directory.

Reviewers: Boyang Chen <boyang@confluent.io>, Jason Gustafson <jason@confluent.io>
2019-07-03 11:45:01 -07:00
Matthias J. Sax 4cae4523fc MINOR: Add verification step for Streams archetype to Jenkins build (#6431)
Updates ./jenkins.sh to build stream archetype and install it in local maven cache. Afterward, archetype is used to create a new maven project and maven project is compiled for verification.

Reviewers: Guozhang Wang <wangguoz@gmail.com>, John Roesler <john@confluent.io>,  Bill Bejeck <bbejeck@gmail.com>
2019-03-21 15:51:18 -04:00
Guozhang Wang 718d6f2475
MINOR: Remove deprecated KafkaStreams constructors in docs (#5118)
Reviewers: Bill Bejeck <bill@confluent.io>, Matthias J. Sax <matthias@confluent.io>
2018-06-04 13:43:20 -07:00
Guozhang Wang de8a67b565 HOTFIX: fix streams tutorial code example 2018-05-04 09:59:36 -07:00
Joel Hamill 65aa1a0c3e KAFKA-6472 - Fix WordCount example code error (#4538)
Reviewers: Guozhang Wang <wangguoz@gmail.com>, Matthias J. Sax <mjsax@apache.org>
2018-02-12 16:54:52 -08:00
Joel Hamill 06597ba26b MINOR: Menu updates and navigation (#4405)
* Menu updates and navigation

Reviewers: Guozhang Wang <wangguoz@gmail.com>
2018-01-09 16:28:49 -08:00
Joel Hamill 26270983cd MINOR: Fix menu ordering in streams docs
https://issues.apache.org/jira/browse/KAFKA-6419

Related: https://github.com/apache/kafka-site/pull/115

Author: Joel Hamill <joel-hamill@users.noreply.github.com>

Reviewers: Guozhang Wang <wangguoz@gmail.com>

Closes #4390 from joel-hamill/fix-streams-menu-order
2018-01-08 11:43:38 -08:00
Joel Hamill 3e2fe17c08 MINOR: Improve Streams Dev Guide content on web docs
This PR migrates content from CP Streams Dev Guide.

Here is the top-level page:
![image](https://user-images.githubusercontent.com/11722533/33904945-df9cf804-df31-11e7-93aa-52385961522c.png)

Here is a child page:
![image](https://user-images.githubusercontent.com/11722533/33904976-f2eafabe-df31-11e7-918c-fbf95db0f76b.png)

See related: https://github.com/apache/kafka-site/pull/112

Author: Joel Hamill <joel-hamill@users.noreply.github.com>

Reviewers: Guozhang Wang <wangguoz@gmail.com>

Closes #4252 from joel-hamill/20171122-migrate-cp-dev-guide
2017-12-21 11:15:54 -08:00
Manjula K ca7f3dab04 MINOR: Adding secondary nav to Streams webpage
Added secondary navigation to Streams sub-pages:
 - quickstart.html
 - core-concepts.html
 - developer-guide.html
 - tutorial.html

Author: Manjula K <manjula@kafka-summit.org>

Reviewers: Joel Hamill <joel-hamill@users.noreply.github.com>, Guozhang Wang <wangguoz@gmail.com>

Closes #4222 from manjuapu/streams-nav
2017-11-15 14:43:11 -08:00
Bill Bejeck dac990aab3 KAFKA-6025: small fix for streams tutorial
Author: Bill Bejeck <bill@confluent.io>

Reviewers: Guozhang Wang <wangguoz@gmail.com>

Closes #4053 from bbejeck/KAFKA_6025_fix_streams_tutorial
2017-10-10 15:07:53 -07:00
Joel Hamill ff5fc9dd1e Rename streams tutorial and quickstart
Changed these topic titles:
- Write your own Streams Applications -> Tutorial: Write a Streams Application
- Play with a Streams Application -> Run the Streams Demo Application

Author: Joel Hamill <joel@Joel-Hamill-Confluent.local>
Author: Joel Hamill <11722533+joel-hamill@users.noreply.github.com>

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

Closes #4017 from joel-hamill/joel-hamill/streams-titles
2017-10-05 09:30:38 -07:00
Damian Guy 93b71e7dee MINOR: update streams quickstart for KIP-182
Author: Damian Guy <damian.guy@gmail.com>

Reviewers: Michael G. Noll <michael@confluent.io>, Bill Bejeck <bill@confluent.io>, Matthias J. Sax <matthias@confluent.io>, Guozhang Wang <wangguoz@gmail.com>

Closes #3984 from dguy/quickstart-update
2017-10-04 12:19:40 -07:00
Matthias J. Sax a96e28eac1 MINOR: Update Streams quickstart to create output topic with compaction enabled
Author: Matthias J. Sax <matthias@confluent.io>

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

Closes #3949 from mjsax/minor-update-streams-quickstart
2017-09-25 16:17:01 +08:00
Jakub Scholz a64fe2ed88 KAFKA-5918: Fix minor typos and errors in the Kafka Streams turotial
I found several minor issues with the Kafka Streams tutorial:
* Some typos
  * "As shown above, it illustrate that the constructed ..." instead of "As shown above, it illustrate_s_ that the constructed ..."
  * "same as Pipe.java below" instead of "same as Pipe.java _above_"
  * Wrong class name in the `LineSplit` example
* Incorrect imports for the code examples
  * Missing `import org.apache.kafka.streams.kstream.KStream;` in `LineSplit` and `WordCount` example
* Unnecessary (and potentially confusing) split by whitespaces in the `WorkCount` class (the split into words happened already in `LineSplit`)

Author: Jakub Scholz <www@scholzj.com>

Reviewers: Matthias J. Sax <matthias@confluent.io>, Guozhang Wang <wangguoz@gmail.com>

Closes #3883 from scholzj/stream-tutorial-typos
2017-09-19 07:58:06 +08:00
Damian Guy f7b1add686 MINOR: update tutorial doc to match ak-site
Author: Damian Guy <damian.guy@gmail.com>

Reviewers: Guozhang Wang <wangguoz@gmail.com>

Closes #3847 from dguy/minor-doc-update
2017-09-13 13:22:06 -07:00
Guozhang Wang b6102cf4b2 HOTFIX: missing imports and version on web docs 2017-08-11 13:53:47 -07:00
Guozhang Wang d2774e302f KAFKA-5727: Add Streams quickstart tutorial as an archetype project
0. Minor fixes on the existing examples to merge all on a single input topic; also do not use `common.utils.Exit` as it is for internal usage only.

1. Add the archetype project for the quickstart. Steps to try it out:

  a. `mvn install` on the quickstart directory.
  b. `mvn archetype:generate \
-DarchetypeGroupId=org.apache.kafka \
-DarchetypeArtifactId=streams-quickstart-java \
-DarchetypeVersion=1.0.0-SNAPSHOT \
-DgroupId=streams-quickstart \
-DartifactId=streams-quickstart \
-Dversion=0.1 \
-Dpackage=StreamsQuickstart \
-DinteractiveMode=false` at any directory to create the project.
  c. build the streams jar with version `1.0.0-SNAPSHOT` to local maven repository with `./gradlew installAll`; `cd streams-quickstart; mvn clean package`
  d. create the input / output topics, start the console producer and consumer.
  e. start the program: `mvn exec:java -Dexec.mainClass=StreamsQuickstart.Pipe/LineSplit/WordCount`.
  f. type data on console producer and observe data on console consumer.

Author: Guozhang Wang <wangguoz@gmail.com>

Reviewers: Damian Guy <damian.guy@gmail.com>, Bill Bejeck <bbejeck@gmail.com>, Ewen Cheslack-Postava <me@ewencp.org>, Eno Thereska <eno.thereska@gmail.com>

Closes #3630 from guozhangwang/KMinor-streams-quickstart-tutorial
2017-08-11 12:19:28 -07:00