raboof/pekko
1
0
Fork 0
Code Issues Pull requests Projects Releases 6 Packages Wiki Activity Actions 10

fix up some doc usage where 'the' is repeated

Browse source
This commit is contained in:
PJ Fanning 2023-02-17 13:31:05 +01:00 • committed by kerr
parent 04154da3cc
commit 864ee821b9
6 changed files with 9 additions and 9 deletions
Download patch file Download diff file Expand all files Collapse all files

4
docs/src/main/paradox/remoting-artery.md
View file

@ -319,7 +319,7 @@ as well as the [Oracle documentation on creating KeyStore and TrustStores](https
are both great resources to research when setting up security on the JVM. Please consult those resources when troubleshooting are both great resources to research when setting up security on the JVM. Please consult those resources when troubleshooting
and configuring SSL. and configuring SSL.
Mutual authentication between TLS peers is enabled by default. Mutual authentication means that the the passive side Mutual authentication between TLS peers is enabled by default. Mutual authentication means that the passive side
(the TLS server side) of a connection will also request and verify a certificate from the connecting peer. (the TLS server side) of a connection will also request and verify a certificate from the connecting peer.
Without this mode only the client side is requesting and verifying certificates. While Pekko is a peer-to-peer Without this mode only the client side is requesting and verifying certificates. While Pekko is a peer-to-peer
technology, each connection between nodes starts out from one side (the "client") towards the other (the "server"). technology, each connection between nodes starts out from one side (the "client") towards the other (the "server").
@ -652,7 +652,7 @@ The selection of lane is based on consistent hashing of the recipient ActorRef t
Note that lowest latency can be achieved with `inbound-lanes=1` and `outbound-lanes=1` because multiple lanes introduce an asynchronous boundary. Note that lowest latency can be achieved with `inbound-lanes=1` and `outbound-lanes=1` because multiple lanes introduce an asynchronous boundary.
Also note that the total amount of parallel tasks are bound by the `remote-dispatcher` and the thread pool size should not exceed the number of CPU cores minus headroom for actually processing the messages in the application, i.e. in practice the the pool size should be less than half of the number of cores. Also note that the total amount of parallel tasks are bound by the `remote-dispatcher` and the thread pool size should not exceed the number of CPU cores minus headroom for actually processing the messages in the application, i.e. in practice the pool size should be less than half of the number of cores.
See `inbound-lanes` and `outbound-lanes` in the @ref:[reference configuration](general/configuration-reference.md#config-pekko-remote-artery) for default values. See `inbound-lanes` and `outbound-lanes` in the @ref:[reference configuration](general/configuration-reference.md#config-pekko-remote-artery) for default values.

2
docs/src/main/paradox/serialization-jackson.md
View file

@ -518,7 +518,7 @@ other purposes, such as persistence or distributed data.
## Additional features ## Additional features
Additional Jackson serialization features can be enabled/disabled in configuration. The default values from Additional Jackson serialization features can be enabled/disabled in configuration. The default values from
Jackson are used aside from the the following that are changed in Pekko's default configuration. Jackson are used aside from the following that are changed in Pekko's default configuration.
@@snip [reference.conf](/serialization-jackson/src/main/resources/reference.conf) { #features } @@snip [reference.conf](/serialization-jackson/src/main/resources/reference.conf) { #features }

6
docs/src/main/paradox/typed/cluster.md
View file

@ -203,7 +203,7 @@ Scala
Java Java
: @@snip [BasicClusterExampleTest.java](/cluster-typed/src/test/java/jdocs/org/apache/pekko/cluster/typed/BasicClusterExampleTest.java) { #join-seed-nodes } : @@snip [BasicClusterExampleTest.java](/cluster-typed/src/test/java/jdocs/org/apache/pekko/cluster/typed/BasicClusterExampleTest.java) { #join-seed-nodes }
The seed node address list has the same semantics as the configured `seed-nodes`, and the the underlying The seed node address list has the same semantics as the configured `seed-nodes`, and the underlying
implementation of the process is the same, see @ref:[Joining configured seed nodes](#joining-configured-seed-nodes). implementation of the process is the same, see @ref:[Joining configured seed nodes](#joining-configured-seed-nodes).
When joining to seed nodes you should not include the node itself, except for the node that is supposed to be the When joining to seed nodes you should not include the node itself, except for the node that is supposed to be the
@ -251,7 +251,7 @@ There are a few ways to remove a member from the cluster.
This is performed by @ref:[Coordinated Shutdown](../coordinated-shutdown.md) when the @apidoc[typed.ActorSystem] This is performed by @ref:[Coordinated Shutdown](../coordinated-shutdown.md) when the @apidoc[typed.ActorSystem]
is terminated and also when a SIGTERM is sent from the environment to stop the JVM process. is terminated and also when a SIGTERM is sent from the environment to stop the JVM process.
1. Graceful exit can also be performed using @ref:[HTTP](../additional/operations.md#http) or @ref:[JMX](../additional/operations.md#jmx). 1. Graceful exit can also be performed using @ref:[HTTP](../additional/operations.md#http) or @ref:[JMX](../additional/operations.md#jmx).
1. When a graceful exit is not possible, for example in case of abrupt termination of the the JVM process, the node 1. When a graceful exit is not possible, for example in case of abrupt termination of the JVM process, the node
will be detected as unreachable by other nodes and removed after @ref:[Downing](#downing). will be detected as unreachable by other nodes and removed after @ref:[Downing](#downing).
Graceful leaving offers faster hand off to peer nodes during node shutdown than abrupt termination and downing. Graceful leaving offers faster hand off to peer nodes during node shutdown than abrupt termination and downing.
@ -269,7 +269,7 @@ be necessary to set the node’s status to `Down` in order to complete the remov
In many cases a member can gracefully exit from the cluster, as described in @ref:[Leaving](#leaving), but In many cases a member can gracefully exit from the cluster, as described in @ref:[Leaving](#leaving), but
there are scenarios when an explicit downing decision is needed before it can be removed. For example in case there are scenarios when an explicit downing decision is needed before it can be removed. For example in case
of abrupt termination of the the JVM process, system overload that doesn't recover, or network partitions of abrupt termination of the JVM process, system overload that doesn't recover, or network partitions
that don't heal. In such cases, the node(s) will be detected as unreachable by other nodes, but they must also that don't heal. In such cases, the node(s) will be detected as unreachable by other nodes, but they must also
be marked as `Down` before they are removed. be marked as `Down` before they are removed.

2
docs/src/main/paradox/typed/logging.md
View file

@ -130,7 +130,7 @@ Java
## MDC ## MDC
[MDC](https://logback.qos.ch/manual/mdc.html) allows for adding additional context dependent attributes to log entries. [MDC](https://logback.qos.ch/manual/mdc.html) allows for adding additional context dependent attributes to log entries.
Out of the box, Pekko will place the path of the actor in the the MDC attribute `pekkoSource`. Out of the box, Pekko will place the path of the actor in the MDC attribute `pekkoSource`.
One or more tags can also be added to the MDC using the @apidoc[ActorTags$] props. The tags will be rendered as a comma separated One or more tags can also be added to the MDC using the @apidoc[ActorTags$] props. The tags will be rendered as a comma separated
list and be put in the MDC attribute `pekkoTags`. This can be used to categorize log entries from a set of different actors list and be put in the MDC attribute `pekkoTags`. This can be used to categorize log entries from a set of different actors

2
docs/src/main/paradox/typed/persistence-testing.md
View file

@ -145,7 +145,7 @@ Event storage has the following operations:
Snapshot storage has the following operations: Snapshot storage has the following operations:
* @apidoc[ReadSnapshot] Read the snapshot from the storage. * @apidoc[ReadSnapshot] Read the snapshot from the storage.
* @apidoc[WriteSnapshot] Writhe the snapshot to the storage. * @apidoc[WriteSnapshot] Write the snapshot to the storage.
* @apidoc[DeleteSnapshotsByCriteria] Delete snapshots in the storage by criteria. * @apidoc[DeleteSnapshotsByCriteria] Delete snapshots in the storage by criteria.
* @apidoc[DeleteSnapshotByMeta] Delete particular snapshot from the storage by its metadata. * @apidoc[DeleteSnapshotByMeta] Delete particular snapshot from the storage by its metadata.

2
docs/src/main/paradox/typed/routers.md
View file

@ -43,7 +43,7 @@ Scala
Java Java
: @@snip [RouterTest.java](/actor-typed-tests/src/test/java/jdocs/org/apache/pekko/typed/RouterTest.java) { #routee } : @@snip [RouterTest.java](/actor-typed-tests/src/test/java/jdocs/org/apache/pekko/typed/RouterTest.java) { #routee }
After having defined the routee, we can now concentrate on configuring the router itself. Note again the the router is an Actor in itself: After having defined the routee, we can now concentrate on configuring the router itself. Note again that the router is an Actor in itself:
Scala Scala
: @@snip [RouterSpec.scala](/actor-typed-tests/src/test/scala/docs/org/apache/pekko/typed/RouterSpec.scala) { #pool } : @@snip [RouterSpec.scala](/actor-typed-tests/src/test/scala/docs/org/apache/pekko/typed/RouterSpec.scala) { #pool }