=doc Akka & GitHub appearances in docs (#20968)
* =doc capitalize akka word * Capitalize GitHub appearances in docs
This commit is contained in:
parent
12fadfe8e5
commit
2078396197
16 changed files with 17 additions and 17 deletions
|
|
@ -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)
|
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.
|
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?
|
Can one of the repo owners verify this patch?
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -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.
|
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,
|
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.
|
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:
|
A chat room is available for all questions related to *developing and contributing* to Akka:
|
||||||
|
|
|
||||||
|
|
@ -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
|
is very small and easily dropped into an existing project where you need
|
||||||
asynchronicity and lockless concurrency without hassle.
|
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
|
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.
|
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
|
Akka also supplies a wide array of concurrency-paradigms, allowing users to choose
|
||||||
|
|
|
||||||
|
|
@ -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,
|
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.
|
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:
|
To enable usage of the extension you need to add the following dependency to your project:
|
||||||
::
|
::
|
||||||
|
|
|
||||||
|
|
@ -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
|
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
|
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
|
For back-pressuring reads there are two modes of operation
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -9,7 +9,7 @@ Overview
|
||||||
========
|
========
|
||||||
|
|
||||||
The FSM (Finite State Machine) is available as an abstract base class that implements
|
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
|
||||||
<http://www.erlang.org/documentation/doc-4.8.2/doc/design_principles/fsm.html>`_
|
<http://www.erlang.org/documentation/doc-4.8.2/doc/design_principles/fsm.html>`_
|
||||||
|
|
||||||
A FSM can be described as a set of relations of the form:
|
A FSM can be described as a set of relations of the form:
|
||||||
|
|
|
||||||
|
|
@ -490,7 +490,7 @@ Akka behind NAT or in a Docker container
|
||||||
----------------------------------------
|
----------------------------------------
|
||||||
|
|
||||||
In setups involving Network Address Translation (NAT), Load Balancers or Docker
|
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
|
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.
|
special configuration that sets both the logical and the bind pairs for remoting.
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -42,7 +42,7 @@ completion but there is no actual value attached to the completion. It is used t
|
||||||
occurrences of ``Future<BoxedUnit>`` with ``Future<Done>`` in Java and ``Future[Unit]`` with
|
occurrences of ``Future<BoxedUnit>`` with ``Future<Done>`` in Java and ``Future[Unit]`` with
|
||||||
``Future[Done]`` in Scala.
|
``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.
|
has been updated.
|
||||||
|
|
||||||
This means that Java code like this::
|
This means that Java code like this::
|
||||||
|
|
|
||||||
|
|
@ -191,7 +191,7 @@ i.e. if defined it takes precedence over ``max-total-nr-of-instances``.
|
||||||
|
|
||||||
Logger names use full class name
|
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``,
|
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 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,
|
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
|
New Cluster Metrics Extension
|
||||||
=============================
|
=============================
|
||||||
Previously, cluster metrics functionality was located in the ``akka-cluster`` jar.
|
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
|
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.
|
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``
|
Note that both old and new metrics configuration entries in the ``reference.conf``
|
||||||
|
|
|
||||||
|
|
@ -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.
|
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 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.
|
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.
|
Please see persistence extension ``reference.conf`` for details.
|
||||||
|
|
|
||||||
|
|
@ -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
|
akka://some-system/user/myconsumer?autoAck=false&replyTimeout=100+millis
|
||||||
|
|
||||||
In the following example, a custom route to an actor is created, using the
|
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
|
reference an ``ActorRef`` directly as shown in the below example, The route starts from a `Jetty`_ endpoint and
|
||||||
ends at the target actor.
|
ends at the target actor.
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -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,
|
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.
|
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:
|
To enable usage of the extension you need to add the following dependency to your project:
|
||||||
::
|
::
|
||||||
|
|
|
||||||
|
|
@ -8,7 +8,7 @@ FSM
|
||||||
Overview
|
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
|
is best described in the `Erlang design principles
|
||||||
<http://www.erlang.org/documentation/doc-4.8.2/doc/design_principles/fsm.html>`_
|
<http://www.erlang.org/documentation/doc-4.8.2/doc/design_principles/fsm.html>`_
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -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
|
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
|
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
|
For back-pressuring reads there are two modes of operation
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -495,7 +495,7 @@ Akka behind NAT or in a Docker container
|
||||||
----------------------------------------
|
----------------------------------------
|
||||||
|
|
||||||
In setups involving Network Address Translation (NAT), Load Balancers or Docker
|
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
|
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.
|
special configuration that sets both the logical and the bind pairs for remoting.
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -23,7 +23,7 @@ completion but there is no actual value attached to the completion. It is used t
|
||||||
occurrences of ``Future<BoxedUnit>`` with ``Future<Done>`` in Java and ``Future[Unit]`` with
|
occurrences of ``Future<BoxedUnit>`` with ``Future<Done>`` in Java and ``Future[Unit]`` with
|
||||||
``Future[Done]`` in Scala.
|
``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.
|
has been updated.
|
||||||
|
|
||||||
This means that Scala code like this::
|
This means that Scala code like this::
|
||||||
|
|
|
||||||
Loading…
Add table
Add a link
Reference in a new issue