Repository navigation
[1.7.x] docs: fix wrong config keys, class names, artifact name and defaults - #3586
Merged
Merged
Conversation
Motivation: Several config examples and setting names in the docs use keys or class names that do not exist, so copying them has no effect or fails. Modification: - persistence-plugins.md: auto-start-journals and auto-start-snapshot-stores take plugin config paths (pekko.persistence.journal.leveldb, pekko.persistence.snapshot-store.local), not class-style names - remoting.md: pekko.remote.classic.retry-gate-closed-for - multi-jvm-testing.md: -Dpekko.remote.artery.canonical.port instead of the non-existent pekko.remote.port - typed/cluster.md: pekko.cluster.failure-detector.implementation-class - remoting-artery.md: pekko.remote.artery.advanced.aeron.aeron-dir - cluster-client.md: pekko.actor.provider; fully qualified org.apache.pekko.cluster.client.ClusterClientReceptionist extension - cluster-metrics.md: fully qualified org.apache.pekko.cluster.metrics.ClusterMetricsExtension extension Result: Config copied from these examples works. Tests: - Not run - docs only; each key and class name checked against the 1.7.x reference.conf files and sources References: Refs apache#3583 (subset of the config key and class name fixes)
…efaults Motivation: More docs give wrong config keys, a wrong artifact name or wrong default values. Modification: - mapWithResource.md, fromOutputStream.md: the blocking dispatcher key is pekko.stream.materializer.blocking-io-dispatcher (no org.apache. prefix); these operators are a Flow and a Sink, not a Source - typed/guide/modules.md: typed Cluster Singleton ships in pekko-cluster-typed; there is no pekko-cluster-singleton artifact - typed/cluster-concepts.md: monitored by up to 9 nodes by default (monitored-by-nr-of-members = 9) - typed/persistence.md: stash-capacity defaults to 4096 (10000 is an example) and commands are only dropped with the default stash-overflow-strategy = "drop" Result: Copied keys, artifact names and stated defaults match 1.7.x. Tests: - Not run - docs only; checked against the 1.7.x reference.conf files and build References: Refs apache#3583
pjfanning
changed the title
pjfanning
added a commit
to pjfanning/incubator-pekko
that referenced
this pull request
Oct 8, 2026
…tStream Motivation: The mapWithResource and fromOutputStream operator pages give the blocking dispatcher setting as org.apache.pekko.stream.materializer.blocking-io-dispatcher, which does not exist, and call these operators a Source. Modification: Use pekko.stream.materializer.blocking-io-dispatcher, and call them a Flow and a Sink. Result: The documented key matches stream reference.conf. Tests: - Not run - docs only References: Refs apache#3586
He-Pin
pushed a commit
to pjfanning/incubator-pekko
that referenced
this pull request
Oct 9, 2026
…tStream Motivation: The mapWithResource and fromOutputStream operator pages give the blocking dispatcher setting as org.apache.pekko.stream.materializer.blocking-io-dispatcher, which does not exist, and call these operators a Source. Modification: Use pekko.stream.materializer.blocking-io-dispatcher, and call them a Flow and a Sink. Result: The documented key matches stream reference.conf. Tests: - Not run - docs only References: Refs apache#3586
He-Pin
added a commit
that referenced
this pull request
Oct 9, 2026
* docs: fix outdated content and wrong config keys and API names Motivation: A review of the docs found statements that are out of date for Pekko 2.0 (JDK 8 advice, removed features described as current, old build tool versions and syntax, deprecated APIs described as the main way) and config keys, class names and method names that do not exist and would fail if copied. Modification: - Outdated for 2.0: auto-down, the pekko-cluster script, async-dns default, binary compatibility and may-change notes, container JVM flags, packaging tool versions and Gradle Shadow snippets, Lombok version, typesafehub links, Java 8/9 qualifiers and javadoc links, sbt colon/`in` syntax and procedure syntax in multi-jvm testing, JDK paths in multi-node testing, LevelDB dependencies, Props.create, Akka version references, the SecurityManager UDP note, pre-fork issue and Activator links, the pre-1.0 Pekko Management migration section, the -2.3 sharding data flag, Java pattern matching versions, stream docs (MaterializedMap, flatMap note, mapConcat signatures, stubs, SI-2712/Dotty, deprecated Source.queue prose, TestSink/TestSource.probe, Source.actorRef completion, Sink.collection Factory, ActorFlow timeout exception, javaCollectorParallelUnordered description) - Wrong config keys: auto-start-journals/snapshot-stores values, classic retry-gate-closed-for, artery canonical port, failure detector implementation-class, aeron-dir, actor.provider, extension FQCNs, monitored-by-nr-of-members default, stash-capacity default, JMX MBean name - Wrong API names: ProducerController, CurrentShardRegionState, extractShardId, Backoff options, DeleteFailure/StoreFailure, RefreshInterval, typed ActorSystem, pekko-cluster-typed artifact, Pekko Projections version, Compression.inflate, RunnableGraph and BidiFlow in stream composition Result: The docs match the 2.0 code and copied config/API names work. Tests: - Not run - docs only References: None - found during a review of the docs * docs: fix blocking-io-dispatcher key in mapWithResource and fromOutputStream Motivation: The mapWithResource and fromOutputStream operator pages give the blocking dispatcher setting as org.apache.pekko.stream.materializer.blocking-io-dispatcher, which does not exist, and call these operators a Source. Modification: Use pekko.stream.materializer.blocking-io-dispatcher, and call them a Flow and a Sink. Result: The documented key matches stream reference.conf. Tests: - Not run - docs only References: Refs #3586 * docs: fix more wrong facts, settings and API names Motivation: More doc pages state facts, settings and API names that do not match the code. Modification: - remoting.md: classic remoting needs netty-transport and netty-handler - cluster-metrics.md: name moving-average-half-life and link this page - routing.md: fork-join-executor - split-brain-resolver.md: stable-after; keep-majority is described above - logging.md: dead letter logging during shutdown is off by default - persistence-schema-evolution.md: Java serialization is disabled by default - fsm.md: UnsubscribeTransitionCallBack - testing.md: ignoreNoMsg, int, remove duplicated sentence - persistence-query.md: getReadJournalFor, Offset, newer events, title, ReadJournalProvider label - io-udp.md: Udp.Bind in Scala - includes/cluster.md: remembered entities - discovery/index.md: _service._tcp.pekko.test - general/addressing.md: root down - project/downstream-upgrade-strategy.md: patch example 1.1.1 - common/circuitbreaker.md: not an actor; CompletionStage - typed/dispatchers.md: org.apache.pekko.dispatch.ExecutorServiceConfigurator - ExtensionDocSpec.scala (typed/extending.md snippet): real DatabasePool class name - typed/guide/tutorial_1.md: typed tell takes one argument - typed/durable-state/persistence.md: DurableStateBehavior names, state not events - typed/mailboxes.md: fromConfig selects a mailbox; classic Settings - typed/routers.md: preferLocalRoutees is only for group routers - typed/interaction-patterns.md: typed TimerScheduler links and startTimer* names; askWithStatus links ActorContext - typed/replicated-eventsourcing-auction.md: WinnerDecided, Finish Result: These pages match the code. Tests: - Not run - docs only (plus a string in a doc snippet source) References: None - found during a review of the docs * docs: fix StatusReply.ack javadoc anchor and fromOutputStream result Motivation: Two fixes were held back from #3587 because they touch files this PR also changes. Modification: - typed/interaction-patterns.md: the Java StatusReply.ack() link used a Scaladoc-style StatusReply$ target; use pekko.pattern.StatusReply#ack() - StreamConverters/fromOutputStream.md: the IOResult carries the number of bytes written, not the size of a file (OutputStreamGraphStage) Result: The link resolves and the description matches the code. Tests: - Not run - docs only References: Refs #3587 * docs: fix typos next to lines changed in this PR Motivation: #3588 fixes typos across the docs but skipped the ones next to lines this PR changes, to avoid merge conflicts. Modification: - split-brain-resolver.md: stray asterisk, "its self" -> "itself" - discovery/index.md: "which i configured" -> "which is configured", "which two hosts" -> "with two hosts" Result: These typos are fixed without conflicting with #3588. Tests: - Not run - docs only References: Refs #3588 * docs: keep -2.3 in the RemoveInternalClusterShardingData example * docs: fix the broken Array[Byte] scaladoc link and the leftover observed-removed typo --------- Co-authored-by: 虎鸣 <hepin.p@alibaba-inc.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Motivation
Several config examples and setting names in the docs use keys or
class names that do not exist, so copying them has no effect or fails.
Some pages also give a wrong artifact name or wrong default values.
Modification
auto-start-snapshot-stores take plugin config paths
(pekko.persistence.journal.leveldb,
pekko.persistence.snapshot-store.local), not class-style names
of the non-existent pekko.remote.port
org.apache.pekko.cluster.client.ClusterClientReceptionist extension
org.apache.pekko.cluster.metrics.ClusterMetricsExtension extension
is pekko.stream.materializer.blocking-io-dispatcher (no org.apache.
prefix); these operators are a Flow and a Sink, not a Source
pekko-cluster-typed; there is no pekko-cluster-singleton artifact
(monitored-by-nr-of-members = 9)
example) and commands are only dropped with the default
stash-overflow-strategy = "drop"
Result
Config copied from these examples works.
Tests
1.7.x reference.conf files and sources
References
Refs #3583 (subset of the config key and class name fixes, plus the
blocking-io-dispatcher key fix which is not in #3583)