From 2078396197a2fd1bc1834afed24dd5467c474d8b Mon Sep 17 00:00:00 2001 From: Nafer Sanabria Date: Mon, 18 Jul 2016 03:33:44 -0500 Subject: [PATCH] =doc Akka & GitHub appearances in docs (#20968) * =doc capitalize akka word * Capitalize GitHub appearances in docs --- CONTRIBUTING.md | 2 +- README.md | 2 +- akka-docs/rst/intro/why-akka.rst | 2 +- akka-docs/rst/java/cluster-metrics.rst | 2 +- akka-docs/rst/java/io-tcp.rst | 2 +- akka-docs/rst/java/lambda-fsm.rst | 2 +- akka-docs/rst/java/remoting.rst | 2 +- akka-docs/rst/java/stream/migration-guide-2.0-2.4-java.rst | 2 +- akka-docs/rst/project/migration-guide-2.3.x-2.4.x.rst | 4 ++-- .../migration-guide-persistence-experimental-2.3.x-2.4.x.rst | 2 +- akka-docs/rst/scala/camel.rst | 2 +- akka-docs/rst/scala/cluster-metrics.rst | 2 +- akka-docs/rst/scala/fsm.rst | 2 +- akka-docs/rst/scala/io-tcp.rst | 2 +- akka-docs/rst/scala/remoting.rst | 2 +- akka-docs/rst/scala/stream/migration-guide-2.0-2.4-scala.rst | 2 +- 16 files changed, 17 insertions(+), 17 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 4d41c6a848..d66cc596e5 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -224,7 +224,7 @@ Example: Akka uses [Jenkins GitHub pull request builder plugin](https://wiki.jenkins-ci.org/display/JENKINS/GitHub+pull+request+builder+plugin) that automatically merges the code, builds it, runs the tests and comments on the Pull Request in GitHub. -Upon a submission of a Pull Request the Github pull request builder plugin will post a following comment: +Upon a submission of a Pull Request the GitHub pull request builder plugin will post a following comment: Can one of the repo owners verify this patch? diff --git a/README.md b/README.md index 0e8fee2420..4b6c42c083 100644 --- a/README.md +++ b/README.md @@ -43,7 +43,7 @@ Contributions are *very* welcome! If you see an issue that you'd like to see fixed, the best way to make it happen is to help out by submitting a PullRequest implementing it. Refer to the [CONTRIBUTING.md](https://github.com/akka/akka/blob/master/CONTRIBUTING.md) file for more details about the workflow, -and general hints how to prepare your pull request. You can also chat ask for clarifications or guidance in github issues directly, +and general hints how to prepare your pull request. You can also chat ask for clarifications or guidance in GitHub issues directly, or in the akka/dev chat if a more real time communication would be of benefit. A chat room is available for all questions related to *developing and contributing* to Akka: diff --git a/akka-docs/rst/intro/why-akka.rst b/akka-docs/rst/intro/why-akka.rst index f5556bbf1c..c25e982ef2 100644 --- a/akka-docs/rst/intro/why-akka.rst +++ b/akka-docs/rst/intro/why-akka.rst @@ -19,7 +19,7 @@ but also in the size of applications it is useful for. The core of Akka, akka-ac is very small and easily dropped into an existing project where you need asynchronicity and lockless concurrency without hassle. -You can choose to include only the parts of akka you need in your application. +You can choose to include only the parts of Akka you need in your application. With CPUs growing more and more cores every cycle, Akka is the alternative that provides outstanding performance even if you're only running it on one machine. Akka also supplies a wide array of concurrency-paradigms, allowing users to choose diff --git a/akka-docs/rst/java/cluster-metrics.rst b/akka-docs/rst/java/cluster-metrics.rst index 68e70effbb..3f8dfeaa13 100644 --- a/akka-docs/rst/java/cluster-metrics.rst +++ b/akka-docs/rst/java/cluster-metrics.rst @@ -14,7 +14,7 @@ Cluster metrics information is primarily used for load-balancing routers, and can also be used to implement advanced metrics-based node life cycles, such as "Node Let-it-crash" when CPU steal time becomes excessive. -Cluster Metrics Extension is a separate akka module delivered in ``akka-cluster-metrics`` jar. +Cluster Metrics Extension is a separate Akka module delivered in ``akka-cluster-metrics`` jar. To enable usage of the extension you need to add the following dependency to your project: :: diff --git a/akka-docs/rst/java/io-tcp.rst b/akka-docs/rst/java/io-tcp.rst index 5ea30571f5..1ad4b7b51d 100644 --- a/akka-docs/rst/java/io-tcp.rst +++ b/akka-docs/rst/java/io-tcp.rst @@ -189,7 +189,7 @@ For back-pressuring writes there are three modes of operation These write models (with the exception of the second which is rather specialised) are demonstrated in complete examples below. The full and contiguous source is -available `on github <@github@/akka-docs/rst/java/code/docs/io/japi>`_. +available `on GitHub <@github@/akka-docs/rst/java/code/docs/io/japi>`_. For back-pressuring reads there are two modes of operation diff --git a/akka-docs/rst/java/lambda-fsm.rst b/akka-docs/rst/java/lambda-fsm.rst index 63b4ef6e9e..18a2dc15f0 100644 --- a/akka-docs/rst/java/lambda-fsm.rst +++ b/akka-docs/rst/java/lambda-fsm.rst @@ -9,7 +9,7 @@ Overview ======== The FSM (Finite State Machine) is available as an abstract base class that implements -an akka Actor and is best described in the `Erlang design principles +an Akka Actor and is best described in the `Erlang design principles `_ A FSM can be described as a set of relations of the form: diff --git a/akka-docs/rst/java/remoting.rst b/akka-docs/rst/java/remoting.rst index 7fb1cbc8e4..8423d5007c 100644 --- a/akka-docs/rst/java/remoting.rst +++ b/akka-docs/rst/java/remoting.rst @@ -490,7 +490,7 @@ Akka behind NAT or in a Docker container ---------------------------------------- In setups involving Network Address Translation (NAT), Load Balancers or Docker -containers the hostname and port pair that akka binds to will be different than the "logical" +containers the hostname and port pair that Akka binds to will be different than the "logical" host name and port pair that is used to connect to the system from the outside. This requires special configuration that sets both the logical and the bind pairs for remoting. diff --git a/akka-docs/rst/java/stream/migration-guide-2.0-2.4-java.rst b/akka-docs/rst/java/stream/migration-guide-2.0-2.4-java.rst index b00fe25d92..4d483116c7 100644 --- a/akka-docs/rst/java/stream/migration-guide-2.0-2.4-java.rst +++ b/akka-docs/rst/java/stream/migration-guide-2.0-2.4-java.rst @@ -42,7 +42,7 @@ completion but there is no actual value attached to the completion. It is used t occurrences of ``Future`` with ``Future`` in Java and ``Future[Unit]`` with ``Future[Done]`` in Scala. -All previous usage of ``Unit`` and ``BoxedUnit`` for these two cases in the akka streams APIs +All previous usage of ``Unit`` and ``BoxedUnit`` for these two cases in the Akka Streams APIs has been updated. This means that Java code like this:: diff --git a/akka-docs/rst/project/migration-guide-2.3.x-2.4.x.rst b/akka-docs/rst/project/migration-guide-2.3.x-2.4.x.rst index afc46c3176..c19b5a6854 100644 --- a/akka-docs/rst/project/migration-guide-2.3.x-2.4.x.rst +++ b/akka-docs/rst/project/migration-guide-2.3.x-2.4.x.rst @@ -191,7 +191,7 @@ i.e. if defined it takes precedence over ``max-total-nr-of-instances``. Logger names use full class name ================================ -Previously, few places in akka used "simple" logger names, such as ``Cluster`` or ``Remoting``. +Previously, few places in Akka used "simple" logger names, such as ``Cluster`` or ``Remoting``. Now they use full class names, such as ``akka.cluster.Cluster`` or ``akka.remote.Remoting``, in order to allow package level log level definitions and ease source code lookup. In case you used specific "simple" logger name based rules in your ``logback.xml`` configurations, @@ -226,7 +226,7 @@ Please see :ref:`deployment-scenarios` for more information. New Cluster Metrics Extension ============================= Previously, cluster metrics functionality was located in the ``akka-cluster`` jar. -Now it is split out and moved into a separate akka module: ``akka-cluster-metrics`` jar. +Now it is split out and moved into a separate Akka module: ``akka-cluster-metrics`` jar. The module comes with few enhancements, such as use of Kamon sigar-loader for native library provisioning as well as use of statistical averaging of metrics data. Note that both old and new metrics configuration entries in the ``reference.conf`` diff --git a/akka-docs/rst/project/migration-guide-persistence-experimental-2.3.x-2.4.x.rst b/akka-docs/rst/project/migration-guide-persistence-experimental-2.3.x-2.4.x.rst index f8060314a1..051f7158d3 100644 --- a/akka-docs/rst/project/migration-guide-persistence-experimental-2.3.x-2.4.x.rst +++ b/akka-docs/rst/project/migration-guide-persistence-experimental-2.3.x-2.4.x.rst @@ -201,5 +201,5 @@ Persistence extension uses LevelDB based plugins for own development and keeps r However previously LevelDB was a ``compile`` scope dependency, and now it is an ``optional;provided`` dependency. To continue using LevelDB based persistence plugins it is now required for related user projects to include an additional explicit dependency declaration for the LevelDB artifacts. -This change allows production akka deployments to avoid need for the LevelDB provisioning. +This change allows production Akka deployments to avoid need for the LevelDB provisioning. Please see persistence extension ``reference.conf`` for details. diff --git a/akka-docs/rst/scala/camel.rst b/akka-docs/rst/scala/camel.rst index bed43d22c9..84cc196554 100644 --- a/akka-docs/rst/scala/camel.rst +++ b/akka-docs/rst/scala/camel.rst @@ -415,7 +415,7 @@ Here's an actor endpoint URI example containing an actor path:: akka://some-system/user/myconsumer?autoAck=false&replyTimeout=100+millis In the following example, a custom route to an actor is created, using the -actor's path. the akka camel package contains an implicit ``toActorRouteDefinition`` that allows for a route to +actor's path. the Akka camel package contains an implicit ``toActorRouteDefinition`` that allows for a route to reference an ``ActorRef`` directly as shown in the below example, The route starts from a `Jetty`_ endpoint and ends at the target actor. diff --git a/akka-docs/rst/scala/cluster-metrics.rst b/akka-docs/rst/scala/cluster-metrics.rst index e0e3d67a3d..e894b5e234 100644 --- a/akka-docs/rst/scala/cluster-metrics.rst +++ b/akka-docs/rst/scala/cluster-metrics.rst @@ -14,7 +14,7 @@ Cluster metrics information is primarily used for load-balancing routers, and can also be used to implement advanced metrics-based node life cycles, such as "Node Let-it-crash" when CPU steal time becomes excessive. -Cluster Metrics Extension is a separate akka module delivered in ``akka-cluster-metrics`` jar. +Cluster Metrics Extension is a separate Akka module delivered in ``akka-cluster-metrics`` jar. To enable usage of the extension you need to add the following dependency to your project: :: diff --git a/akka-docs/rst/scala/fsm.rst b/akka-docs/rst/scala/fsm.rst index 1b8636eee0..ea20f39540 100644 --- a/akka-docs/rst/scala/fsm.rst +++ b/akka-docs/rst/scala/fsm.rst @@ -8,7 +8,7 @@ FSM Overview ======== -The FSM (Finite State Machine) is available as a mixin for the akka Actor and +The FSM (Finite State Machine) is available as a mixin for the Akka Actor and is best described in the `Erlang design principles `_ diff --git a/akka-docs/rst/scala/io-tcp.rst b/akka-docs/rst/scala/io-tcp.rst index 87acb50dd5..c8772f4bce 100644 --- a/akka-docs/rst/scala/io-tcp.rst +++ b/akka-docs/rst/scala/io-tcp.rst @@ -190,7 +190,7 @@ For back-pressuring writes there are three modes of operation These write back-pressure models (with the exception of the second which is rather specialised) are demonstrated in complete examples below. The full and contiguous source is -available `on github <@github@/akka-docs/rst/scala/code/docs/io/EchoServer.scala>`_. +available `on GitHub <@github@/akka-docs/rst/scala/code/docs/io/EchoServer.scala>`_. For back-pressuring reads there are two modes of operation diff --git a/akka-docs/rst/scala/remoting.rst b/akka-docs/rst/scala/remoting.rst index ea9e449dc9..7849ebf879 100644 --- a/akka-docs/rst/scala/remoting.rst +++ b/akka-docs/rst/scala/remoting.rst @@ -495,7 +495,7 @@ Akka behind NAT or in a Docker container ---------------------------------------- In setups involving Network Address Translation (NAT), Load Balancers or Docker -containers the hostname and port pair that akka binds to will be different than the "logical" +containers the hostname and port pair that Akka binds to will be different than the "logical" host name and port pair that is used to connect to the system from the outside. This requires special configuration that sets both the logical and the bind pairs for remoting. diff --git a/akka-docs/rst/scala/stream/migration-guide-2.0-2.4-scala.rst b/akka-docs/rst/scala/stream/migration-guide-2.0-2.4-scala.rst index 7d0bb64d8d..01bdef1380 100644 --- a/akka-docs/rst/scala/stream/migration-guide-2.0-2.4-scala.rst +++ b/akka-docs/rst/scala/stream/migration-guide-2.0-2.4-scala.rst @@ -23,7 +23,7 @@ completion but there is no actual value attached to the completion. It is used t occurrences of ``Future`` with ``Future`` in Java and ``Future[Unit]`` with ``Future[Done]`` in Scala. -All previous usage of ``Unit`` and ``BoxedUnit`` for these two cases in the akka streams APIs +All previous usage of ``Unit`` and ``BoxedUnit`` for these two cases in the Akka Streams APIs has been updated. This means that Scala code like this::