This is an automated email from the ASF dual-hosted git repository.
chia7712 pushed a commit to branch trunk
in repository https://gitbox.apache.org/repos/asf/kafka.git
The following commit(s) were added to refs/heads/trunk by this push:
new 16306d9475d KAFKA-20592 Fix typos in Streams documentation (#22299)
16306d9475d is described below
commit 16306d9475de9abe3f71ef49261fe84289849209
Author: akhil-sabu-ibm <[email protected]>
AuthorDate: Sun May 17 13:16:59 2026 +0530
KAFKA-20592 Fix typos in Streams documentation (#22299)
This PR fixes several small typos in the Streams documentation.
Changes:
- Fix `previouss` -> `previous` in
`docs/streams/developer-guide/dsl-api.md`
- Fix `so-call` -> `so-called` in `docs/streams/upgrade-guide.md`
- Fix `ofTimeDifferencWithNoGrace` -> `ofTimeDifferenceWithNoGrace`
- Fix `intend` -> `intent`
- Fix `effected` -> `affected`
- Fix `need to updated` -> `need to update`
JIRA: https://issues.apache.org/jira/browse/KAFKA-20592
This is a documentation-only change with no functional impact.
Reviewers: Sanskar Jhajharia <[email protected]>, Chia-Ping Tsai
<[email protected]>
---
docs/streams/developer-guide/dsl-api.md | 2 +-
docs/streams/upgrade-guide.md | 8 ++++----
2 files changed, 5 insertions(+), 5 deletions(-)
diff --git a/docs/streams/developer-guide/dsl-api.md
b/docs/streams/developer-guide/dsl-api.md
index 0a981f680c9..88956f9209c 100644
--- a/docs/streams/developer-guide/dsl-api.md
+++ b/docs/streams/developer-guide/dsl-api.md
@@ -5024,7 +5024,7 @@ It is recommended, that you compare the output of
`Topology.describe()` for the
### Migration Examples
-To migrate from the deprecated `transform`, `transformValues`,
`flatTransform`, and `flatTransformValues` methods to the Processor API (PAPI)
in Kafka Streams, let's resume the previouss examples. The new `process` and
`processValues` methods enable a more flexible and reusable approach by
requiring implementations of the `Processor` or `FixedKeyProcessor` interfaces.
+To migrate from the deprecated `transform`, `transformValues`,
`flatTransform`, and `flatTransformValues` methods to the Processor API (PAPI)
in Kafka Streams, let's resume the previous examples. The new `process` and
`processValues` methods enable a more flexible and reusable approach by
requiring implementations of the `Processor` or `FixedKeyProcessor` interfaces.
<table>
<tr>
diff --git a/docs/streams/upgrade-guide.md b/docs/streams/upgrade-guide.md
index 3f38449bfc4..51e9b1cca23 100644
--- a/docs/streams/upgrade-guide.md
+++ b/docs/streams/upgrade-guide.md
@@ -339,8 +339,8 @@ The Kafka Streams DSL may insert so-called repartition
topics for certain DSL op
## Streams API changes in 3.1.0
-The semantics of left/outer stream-stream join got improved via
[KIP-633](https://cwiki.apache.org/confluence/x/Ho2NCg). Previously,
left-/outer stream-stream join might have emitted so-call spurious left/outer
results, due to an eager-emit strategy. The implementation was changed to emit
left/outer join result records only after the join window is closed. The old
API to specify the join window, i.e., `JoinWindows.of()` that enables the
eager-emit strategy, was deprecated in favor of a ` [...]
-Additionally, KIP-633 makes setting a grace period also mandatory for windowed
aggregations, i.e., for `TimeWindows` (hopping/tumbling), `SessionWindows`, and
`SlidingWindows`. The corresponding builder methods `.of(...)` were deprecated
in favor of the new `.ofTimeDifferenceAndGrace()` and
`.ofTimeDifferencWithNoGrace()` methods.
+The semantics of left/outer stream-stream join got improved via
[KIP-633](https://cwiki.apache.org/confluence/x/Ho2NCg). Previously,
left-/outer stream-stream join might have emitted so-called spurious left/outer
results, due to an eager-emit strategy. The implementation was changed to emit
left/outer join result records only after the join window is closed. The old
API to specify the join window, i.e., `JoinWindows.of()` that enables the
eager-emit strategy, was deprecated in favor of a [...]
+Additionally, KIP-633 makes setting a grace period also mandatory for windowed
aggregations, i.e., for `TimeWindows` (hopping/tumbling), `SessionWindows`, and
`SlidingWindows`. The corresponding builder methods `.of(...)` were deprecated
in favor of the new `.ofTimeDifferenceAndGrace()` and
`.ofTimeDifferenceWithNoGrace()` methods.
[KIP-761](https://cwiki.apache.org/confluence/x/vAUBCw) adds new metrics that
allow to track blocking times on the underlying consumer and producer clients.
Check out the section on [Kafka Streams
metrics](/documentation/#kafka_streams_monitoring) for more details.
@@ -440,7 +440,7 @@ We changed the default value of `default.key.serde` and
`default.value.serde` to
## Streams API changes in 2.7.0
-In `KeyQueryMetadata` we deprecated `getActiveHost()`, `getStandbyHosts()` as
well as `getPartition()` and replaced them with `activeHost()`,
`standbyHosts()` and `partition()` respectively. `KeyQueryMetadata` was
introduced in Kafka Streams 2.5 release with getter methods having prefix
`get`. The intend of this change is to bring the method names to Kafka custom
to not use the `get` prefix for getter methods. The old methods are deprecated
and is not effected. (Cf. [KIP-648](https://cwi [...]
+In `KeyQueryMetadata` we deprecated `getActiveHost()`, `getStandbyHosts()` as
well as `getPartition()` and replaced them with `activeHost()`,
`standbyHosts()` and `partition()` respectively. `KeyQueryMetadata` was
introduced in Kafka Streams 2.5 release with getter methods having prefix
`get`. The intent of this change is to bring the method names to Kafka custom
to not use the `get` prefix for getter methods. The old methods are deprecated
and is not affected. (Cf. [KIP-648](https://cwi [...]
The `StreamsConfig` variable for configuration parameter
`"topology.optimization"` is renamed from `TOPOLOGY_OPTIMIZATION` to
`TOPOLOGY_OPTIMIZATION_CONFIG`. The old variable is deprecated. Note, that the
parameter name itself is not affected. (Cf.
[KIP-626](https://cwiki.apache.org/confluence/x/gBB4CQ).)
@@ -497,7 +497,7 @@ Kafka Streams `test-utils` got improved via
[KIP-470](https://cwiki.apache.org/c
In 2.4.0, we deprecated `WindowStore#put(K key, V value)` that should never be
used. Instead the existing `WindowStore#put(K key, V value, long
windowStartTimestamp)` should be used
([KIP-474](https://cwiki.apache.org/confluence/pages/viewpage.action?pageId=115526545)).
-Furthermore, the `PartitionGrouper` interface and its corresponding
configuration parameter `partition.grouper` were deprecated
([KIP-528](https://cwiki.apache.org/confluence/x/BwzABw)) and will be removed
in the next major release
([KAFKA-7785](https://issues.apache.org/jira/browse/KAFKA-7785). Hence, this
feature won't be supported in the future any longer and you need to updated
your code accordingly. If you use a custom `PartitionGrouper` and stop to use
it, the created tasks might c [...]
+Furthermore, the `PartitionGrouper` interface and its corresponding
configuration parameter `partition.grouper` were deprecated
([KIP-528](https://cwiki.apache.org/confluence/x/BwzABw)) and will be removed
in the next major release
([KAFKA-7785](https://issues.apache.org/jira/browse/KAFKA-7785). Hence, this
feature won't be supported in the future any longer and you need to update your
code accordingly. If you use a custom `PartitionGrouper` and stop using it, the
created tasks might cha [...]
For Streams API changes in version older than 2.4.x, please check [3.9 upgrade
document](/39/documentation/streams/upgrade-guide).
