Permalink
Browse files

Merge pull request #120 from norbertpotocki/doc-fixes

Documentation improvements for section 6.1
  • Loading branch information...
abuijze committed May 17, 2014
2 parents 5af06b4 + cc020b4 commit bb80d549840820d1b8a17d5fe28031ae39c684d5
@@ -37,7 +37,7 @@
constantly added, changed and (unfortunately not enough) removed. It can be
frustrating to find out that a seemingly easy-to-implement feature can require
development teams to take apart an entire application. Furthermore, today's
- webapplications target an audience of potentially billions of people, making
+ web applications target the audience of potentially billions of people, making
scalability an indisputable requirement.
</para>
<para>Although there are many applications and frameworks around that deal with
@@ -49,7 +49,7 @@
application, eventually this approach will cause complexity to increase and
development to slow down.
</para>
- <para>The Command Query Responsiblity Segregation (CQRS) pattern addresses these issues
+ <para>The Command Query Responsibility Segregation (CQRS) pattern addresses these issues
by drastically changing the way applications are architected. Instead of separating
logic into separate layers, logic is separated based on whether it is changing an
application's state or querying it. That means that executing commands (actions that
@@ -71,7 +71,7 @@
dominates the software landscape nowadays, it is quite hard to grasp. It is not
uncommon for developers to walk into a few traps while trying to find their way
around this architecture. That's why Axon Framework was conceived: to help
- developers implement CQRS applications while focussing on the business logic.
+ developers implement CQRS applications while focusing on the business logic.
</para>
</sect2>
<sect2>
@@ -81,7 +81,7 @@
architectural pattern. It does so by providing implementations of the most important
building blocks, such as aggregates, repositories and event buses (the dispatching
mechanism for events). Furthermore, Axon provides annotation support, which allows
- you to build aggregates and event listeners withouth tying your code to Axon
+ you to build aggregates and event listeners without tying your code to Axon
specific logic. This allows you to focus on your business logic, instead of the
plumbing, and helps you to make your code easier to test in isolation.
</para>
@@ -97,7 +97,7 @@
</para>
<para>The Axon Framework consists of a number of modules (jars) that provide the tools
and components to build a scalable infrastructure. The Axon Core module provides the
- basic API's for the different components, and simple implemenatinos that provide
+ basic APIs for the different components, and simple implementations that provide
solutions for single-JVM applications. The other modules address scalability or
high-performance issues, by providing specialized building blocks.
</para>
@@ -136,7 +136,7 @@
<para>The application presents data in many different formats. Many
applications nowadays don't stop when showing information on a web page.
Some applications, for example, send monthly emails to notify users of
- changes that occured that might be relevant to them. Search engines are
+ changes that occurred that might be relevant to them. Search engines are
another example. They use the same data your application does, but in a
way that is optimized for quick searching. Reporting tools aggregate
information into reports that show data evolution over time. This,
@@ -153,7 +153,7 @@
their order status. With Axon, these components can be deployed on
separate machines and scaled using different policies. They are kept
up-to-date using the events, which Axon will dispatch to all subscribed
- components, regardles of the machine they are deployed on.
+ components, regardless of the machine they are deployed on.
</para>
</listitem>
<listitem>
@@ -225,7 +225,7 @@
<title>When you're stuck</title>
<para>While implementing your application, you might run into problems, wonder about why
certain things are the way they are, or have some questions that need an answer. The
- Axon Users mailinglist is there to help. Just send an email to <link
+ Axon Users mailing list is there to help. Just send an email to <link
xmlns:xlink="http://www.w3.org/1999/xlink"
xlink:href="mailto:axonframework@googlegroups.com"
>axonframework@googlegroups.com</link>. Other users as well as contributors to
@@ -243,12 +243,12 @@
<title>Contributing to Axon Framework</title>
<para>Development on the Axon Framework is never finished. There will always be more
features that we like to include in our framework to continue making development of
- scalabale and extensible application easier. This means we are constantly looking for
+ scalable and extensible application easier. This means we are constantly looking for
help in developing our framework.
</para>
<para>There are a number of ways in which you can contribute to the Axon Framework: <itemizedlist>
<listitem>
- <para>You can report any bugs, feature requests or ideas about improvemens on
+ <para>You can report any bugs, feature requests or ideas for improvements on
our issue page: <link xmlns:ns1="http://www.w3.org/1999/xlink"
ns1:href="http://www.axonframework.org/issues"
>axonframework.org/issues</link>. All ideas are welcome. Please be as
@@ -266,7 +266,7 @@
<para>If you know of any other way you think you can help us, do not hesitate to
send a message to the <link xmlns:xlink="http://www.w3.org/1999/xlink"
xlink:href="mailto:axonframework@googlegroups.com">Axon Framework
- mailinglist</link>. </para>
+ mailing list</link>. </para>
</listitem>
</itemizedlist></para>
</sect1>
@@ -113,7 +113,7 @@
<para>The thin data layer in between the user interface and the data sources provides a
clearly defined interface to the actual query implementation used. This data layer
typically returns read-only DTO objects containing query results. The contents of
- these DTO's are typically driven by the needs of the User Interface. In most cases,
+ these DTOs are typically driven by the needs of the User Interface. In most cases,
they map directly to a specific view in the UI (also referred to as table-per-view). </para>
<para>Axon does not provide any building blocks for this part of the application. The
main reason is that this is very straightforward and doesn't differ from the layered
@@ -132,7 +132,7 @@
<code>org.joda.time</code>.</para>
<sect2>
<title>Main modules</title>
- <para>Axon's main modules are the modules that have been thorouhgly tested and are
+ <para>Axon's main modules are the modules that have been thoroughly tested and are
robust enough to use in demanding production environments. The maven groupId of all
these modules is <code>org.axonframework</code>.</para>
<simplesect>
@@ -180,7 +180,7 @@
<title>Axon Monitoring JMX</title>
<para>Several AxonFramework components provide monitoring information. This module
publishes that information over JMX. There is no configuration involved. If this
- module is on the classpath, statistics and monitoring informatin is
+ module is on the classpath, statistics and monitoring information is
automatically published over JMX.</para>
</simplesect>
</sect2>
@@ -199,7 +199,7 @@
</simplesect>
<simplesect>
<title>Axon Google App Engine</title>
- <para>The Google App Engine modules provides building blocks that use specific API's
+ <para>The Google App Engine modules provides building blocks that use specific APIs
provided by GAE, such as an Event Store that uses the DatastoreService and a
special XStream based serializer that works around some of the limitations of
the GAE platform.</para>
@@ -213,7 +213,7 @@
</sect2>
</sect1>
<sect1>
- <title>Working with Axon API's</title>
+ <title>Working with Axon APIs</title>
<annotation>
<para>CQRS is an architectural pattern, making it impossible to provide a single
solution that fits all projects. Axon Framework does not try to provide that one
@@ -229,7 +229,7 @@
ensures that these objects are safe to use in a multi-threaded environment, without
side-effects.</para>
</annotation>
- <para>To ensure maximum customizability, all Axon components are defined using interfaces.
+ <para>To ensure maximum customization, all Axon components are defined using interfaces.
Abstract and concrete implementations are provided to help you on your way, but will
nowhere be required by the framework. It is always possible to build a completely custom
implementation of any building block using that interface.</para>
Oops, something went wrong.

0 comments on commit bb80d54

Please sign in to comment.