Commit Graph

18 Commits

Author SHA1 Message Date
Jinyong Choi e2060204fe
KAFKA-15302: Stale value returned when using store.all() with key deletion [docs] (#15495)
Reviewers: Matthias J. Sax <matthias@confluent.io>
2024-06-18 17:45:19 -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
Victoria Xia 7c74f3983b
KAFKA-14491: [21/N] Docs updates for versioned state stores (#13444)
Add docs for KIP-889.

Reviewers: Matthias J. Sax <matthias@confluent.io>
2023-04-12 11:31:27 -07:00
Luke Chen 908461a07e
MINOR: Update rocksDb memory management doc (#11528)
In the RocksDb memory management doc, we mentioned in the footnote that there's a rocksdb bug caused the strict_capacity_limit boolean parameter in the LRUCache constructor can't be set to true. However, the bug is already fixed in 6.11.4, and we're using 6.22 now, so the note can be removed.

Reviewer: Bruno Cadonna <cadonna@apache.org>
2021-11-25 10:20:32 +01: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
Matthias J. Sax 016128c920
MINOR: Extends RocksDB docs (#10046)
We recommend users to switch to jemalloc for RocksDB.

Co-authored-by: Jim Galasyn <jim.galasyn@confluent.io>

Reviewers: Jim Galasyn <jim.galasyn@confluent.io>, Rohan Desai <rohan@confluent.io>, A. Sophie Blee-Goldman <sophie@confluent.io>
2021-02-04 18:50:19 -08: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
A. Sophie Blee-Goldman 9b30276e58
KAFKA-9161: add docs for KIP-441 and KIP-613 and other configs that need fixing (#9027)
Add docs for KIP-441 and KIP-613.
Fixed some miscellaneous unrelated issues in the docs:
* Adds some missing configs to the Streams config docs: max.task.idle.ms,topology.optimization, default.windowed.key.serde.inner.class, and default.windowed.value.serde.inner.class
* Defines the previously-undefined default windowed serde class configs, including choosing a default (null) and giving them a doc string, so the yshould nwo show up in the auto-generated general Kafka config docs
* Adds a note to warn users about the rocksDB bug that prevents setting a strict capacity limit and counting write buffer memory against the block cache

Reviewers: Bruno Cadonna <bruno@confluent.io>, John Roesler <vvcephei@apache.org>
2020-07-20 16:27:28 -05:00
A. Sophie Blee-Goldman 102490ea0c MINOR: improve RocksDBConfigSetter docs (#7009)
Users often use the RocksDBConfigSetter to modify parameters such as cache or block size, which must be set through the BlockBasedTableConfig object. Rather than creating a new object in the config setter, however, users should most likely retrieve a reference to the existing one so as to not lose the other defaults (eg the BloomFilter)

There have been notes from the community that it is not obvious this should be done, nor is it immediately clear how to do so. This PR updates the RocksDBConfigSetter docs to hopefully improve things.

I also piggybacked a few minor cleanups in the docs

Reviewers: Kamal Chandraprakash, Jim Galasyn <jim.galasyn@confluent.io>,  Bruno Cadonna <bruno@confluent.io>, Bill Bejeck <bbejeck@gmail.com>
2019-07-08 19:11:17 -04:00
A. Sophie Blee-Goldman cfea95343d MINOR: Fix typos in upgrade guide (#7005)
Reviewers: Bill Bejeck <bbejeck@gmail.com>, Guozhang Wang <wangguoz@gmail.com>
2019-06-27 09:08:49 -07:00
A. Sophie Blee-Goldman a03b5037df HOTFIX: removed extra footnote (#6996)
Reviewers: Guozhang Wang <wangguoz@gmail.com>
2019-06-24 19:18:10 -07:00
A. Sophie Blee-Goldman 932a1b7d7e MINOR: Extend RocksDB section of Memory Management Docs (#6793)
Now that we can configure RocksDB to bound the total memory we should include docs describing how, as well as touching on some possible options that should be considered when taking advantage of this feature.

Reviewers: Guozhang Wang <wangguoz@gmail.com>, Jim Galasyn <jim.galasyn@confluent.io>, Bill Bejeck <bbejeck@gmail.com>
2019-05-30 07:28:43 -04:00
A. Sophie Blee-Goldman e62e23099b Fixed docs regarding caching default (#6375)
The current docs are out of date regarding the default caching state.

Reviewers: Guozhang Wang <wangguoz@gmail.com>,  Bill Bejeck <bbejeck@gmail.com>
2019-03-06 13:54:36 -05: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
ro7m 8434d494e6 KAFKA-6790: Fix Streams processor node broken link (#4874)
The page here https://kafka.apache.org/11/documentation/streams/developer-guide/memory-mgmt.html talks about processor nodes and refers to non existing links.

Broken link (appears twice in the same document):

https://kafka.apache.org/11/documentation/streams/concepts.html#streams-concepts-processor

To find this search for the word "processor node" on the page memory-management , the ones which are links are broken.

Reviewers: Guozhang Wang <wangguoz@gmail.com>
2018-04-15 09:56:12 -07: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 d63f94797c MINOR: fix image 404s in streams doc
Fixes image 404s in streams docs (e.g. https://kafka.apache.org/documentation/streams/developer-guide/interactive-queries.html).

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

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

Reviewers: Guozhang Wang <wangguoz@gmail.com>

Closes #4389 from joel-hamill/fix-404-streams
2018-01-08 09:38:58 -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