Merge pull request #23 from alexwlchan/master

Fix spelling, capitalization and make other small tweaks

docs/All_in_one_OVF_Installation.md

@@ -21,7 +21,7 @@ To install the OVF, you must first download it from [http://vm-images.cw-ngv.com
 Then, you must import it into your virtualization platform.  The process for this varies.
 
 *   On VMware Player, choose **File->Open a Virtual Machine** from the menu and select the cw-aio.ova file you downloaded.  On the Import Virtual Machine dialog that appears, the defaults are normally fine, so you can just click **Import**.
-*   On VirtualBox, choose **File->Import Applicance...** from the menu.  In the Appliance Import Wizard, click **Choose...**, select the cw-aio.ova file you downloaded and click **Next**.  On the next tab, you can view the settings and then click **Import**.
+*   On VirtualBox, choose **File->Import Appliance...** from the menu.  In the Appliance Import Wizard, click **Choose...**, select the cw-aio.ova file you downloaded and click **Next**.  On the next tab, you can view the settings and then click **Import**.
 *   On VMware ESXi, using the VMware vSphere Client, choose **File->Deploy OVF Template...** from the menu.  Select the cw-aio.ova file you downloaded and click through assigning it a suitable name, location and attached network (which must support DHCP) before finally clicking **Finish** to create the virtual machine.
 
 ## Running and Using the Image

docs/Backups.md

@@ -165,7 +165,7 @@ Ellis will produce output of the following form.
     /*!40111 SET SQL_NOTES=@OLD_SQL_NOTES */
     --------------
 
-Homestead, homer or mememnto will produce output of the following form.
+Homestead, homer or memento will produce output of the following form.
 
     Will attempt to backup from backup 1372336442947
     Will attempt to backup from directory /home/ubuntu/bkp_test/
@@ -190,7 +190,7 @@ At this point, this node has been restored.
 It is possible (and likely) that when backups are taken on different
 boxes the data will be out of sync, e.g. ellis will know about a
 subscriber, but there will no digest in homestead. To restore the system
-to a consistent state we have a syncronization tool within ellis, which
+to a consistent state we have a synchronization tool within ellis, which
 can be run over a deployment to get the databases in sync. To run, log
 into an ellis box and execute:
 

docs/CDF_Integration.md

@@ -43,7 +43,7 @@ Then restart Ralf to pick up the change:
 
 ### Selecting a specific CDF in the realm
 
-_Note:_ Bono only has support for selecting CDF identies based of static configuration of a single identity.  Other P-CSCFs may have support for load-balancing or enabling backup CDF identities.
+_Note:_ Bono only has support for selecting CDF identities based of static configuration of a single identity.  Other P-CSCFs may have support for load-balancing or enabling backup CDF identities.
 
 If you have a CDF set up to receive Rf billing messages from your deployment, you will need to modify the `/etc/clearwater/config` file on your Bono node to contain the following line:
 

docs/Clearwater_Architecture.md

@@ -15,7 +15,7 @@ The following diagram shows a Clearwater deployment.
 
 ### Bono (Edge Proxy)
 
-The Bono nodes form a horizontally scalable SIP edge proxy providing both a SIP IMS Gm compliant interface and a WebRTC interface to clients.  Client connections are load balanced across the nodes.  The Bono node provides the anchor point for the client's connection to the Clearwater system, including support for various NAT traveral mechanisms.  A client is therefore anchored to a particular Bono node for the duration of its registration, but can move to another Bono node if the connection or client fails.
+The Bono nodes form a horizontally scalable SIP edge proxy providing both a SIP IMS Gm compliant interface and a WebRTC interface to clients.  Client connections are load balanced across the nodes.  The Bono node provides the anchor point for the client's connection to the Clearwater system, including support for various NAT traversal mechanisms.  A client is therefore anchored to a particular Bono node for the duration of its registration, but can move to another Bono node if the connection or client fails.
 
 ### Sprout (SIP Router)
 

docs/Clearwater_CPP_Coding_Guidelines.md

@@ -9,7 +9,7 @@
 
 *   We assume a C++11-compliant compiler, so C++11 features are allowed with some exceptions.
 *   No use of `auto` type declarations.
-*   No use of `using namespace ...`, if the namespace is partiularly lengthy, consider using namespace aliasing (e.g. `namespace po = boost::program_options`).
+*   No use of `using namespace ...`, if the namespace is particularly lengthy, consider using namespace aliasing (e.g. `namespace po = boost::program_options`).
 *   Avoid using Boost (or similar) libraries that return special library-specific pointers, to minimize "infection" of the code-base.  Consider using the C++11 equivalents instead.
 
 ## Formatting

docs/Clearwater_Call_Diversion_Support.md

@@ -42,7 +42,7 @@ of 3GPP TS 24.604 with the following exceptions.
     -   We support up to 5 diversions and then reject the call.
         -   Total number of call diversions for each communication = 5
         -   AS behavior when the maximum number of diversions for a
-            communicaton is reached = Reject the communication
+            communication is reached = Reject the communication
 
     -   The default no-reply timer before Communication Forwarding on no
         Reply occurs is hard-coded to 20s. This is still overridable on

docs/Clearwater_Configuration_Options_Reference.md

@@ -24,7 +24,7 @@ This section describes options for the basic configuration of a Clearwater deplo
 * `public_hostname` - this should be set to a hostname which resolves to `public_ip`, and will communicate with only this node (i.e. not be round-robined to other nodes). It can be set to `public_ip` if necessary.
 * `hss_hostname` - the hostname of your external HSS, if you have one. The port defaults to 3868 - this cannot be set by static configuration, but can be controlled by setting `hss_realm` and having appropriate NAPTR/SRV records for Diameter.
 * `signup_key` - this sets the password which Ellis will require before allowing self-sign-up.
-* `turn_workaround` - if your STUN/TURN clients are not able to authenticate properly (for example, because they can't send the @ sign), this specifies an additional password which will autenticate clients even without a correct username.
+* `turn_workaround` - if your STUN/TURN clients are not able to authenticate properly (for example, because they can't send the @ sign), this specifies an additional password which will authenticate clients even without a correct username.
 * `smtp_smarthost` - Ellis allows password recovery by email. This sets the SMTP server used to send those emails.
 * `smtp_username` - Ellis allows password recovery by email. This sets the username used to log in to the SMTP server.
 * `smtp_password` - Ellis allows password recovery by email. This sets the password used to log in to the SMTP server.
@@ -92,7 +92,7 @@ This section describes optional configuration options, particularly for ensuring
 
 ## Experimental options
 
-This section describes optional configuration options which may be useful, but are not heavily-used or well-tested by the main Clearwater developent team. These options should be set in the `/etc/clearwater/config` file (in the format `name=value`, e.g. `cassandra_hostname=db.example.com`).
+This section describes optional configuration options which may be useful, but are not heavily-used or well-tested by the main Clearwater development team. These options should be set in the `/etc/clearwater/config` file (in the format `name=value`, e.g. `cassandra_hostname=db.example.com`).
 
 * `cassandra_hostname` - if using an external Cassandra cluster (which is a fairly uncommon configuration), a hostname that resolves to one or more Cassandra nodes.
 * `ralf_secure_listen_port` - this determines the port Ralf listens on for TLS-secured Diameter connections.

docs/Clearwater_Ruby_Coding_Guidelines.md

@@ -46,7 +46,7 @@ Strongly based on https://github.com/chneukirchen/styleguide/ with some local ch
 *     Use one-letter variables for short block/method parameters, according to this scheme:
   *     a,b,c: any object
   *     d: directory names
-  *     e: elements of an Enumerable or a resuced Exception
+  *     e: elements of an Enumerable or a rescued Exception
   *     f: files and file names
   *     i,j: indexes or integers
   *     k: the key part of a hash entry

docs/Clearwater_SNMP_Statistics.md

@@ -6,7 +6,7 @@ These SNMP statistics require the clearwater-snmp-handler-bono, clearwater-snmp-
 
 ## Usage
 
-Clearwater nodes provide SNMP statistics over port 161 using SNMP v2c and community `clearwater`. The MIB definition file can be downloaded from [here](https://github.com/Metaswitch/clearwater-snmp-handlers/blob/master/PROJECT-CLEARWATER-MIB), or (for Clearwater nodes on relases before Halo, when the MIB file was updated to support IPv6) [here](https://github.com/Metaswitch/clearwater-snmp-handlers/blob/release-48/PROJECT-CLEARWATER-MIB).
+Clearwater nodes provide SNMP statistics over port 161 using SNMP v2c and community `clearwater`. The MIB definition file can be downloaded from [here](https://github.com/Metaswitch/clearwater-snmp-handlers/blob/master/PROJECT-CLEARWATER-MIB), or (for Clearwater nodes on releases before Halo, when the MIB file was updated to support IPv6) [here](https://github.com/Metaswitch/clearwater-snmp-handlers/blob/release-48/PROJECT-CLEARWATER-MIB).
 
 Our SNMP statistics are provided through plugins to the standard SNMPd packaged with Ubuntu, so querying port 161 (the standard SNMP port) on a Clearwater node will provide system-level stats like CPU% as well as any available Clearwater stats.
 

docs/Configuring_the_native_Android_SIP_client.md

@@ -1,5 +1,5 @@
 These instructions detail how to enable the stock Android SIP client.
-These instruction are tested in a Samaung Galay Nexus running 4.2.2. If
+These instruction are tested in a Samsung Galaxy Nexus running 4.2.2. If
 you get them working on another device, please add to the list below.
 Equally, if they do not work, please add your device to the unsupported
 list.
@@ -22,7 +22,7 @@ list.
         following options.
     -   Set **Transport type** to TCP
     -   Set **Authentication username** to
-        "sip:*<username\>*@*<server\>*", subsituting (note: once we
+        "sip:*<username\>*@*<server\>*", substituting (note: once we
         switch to storing user digest by private id, this will change)
 
 7.  Once done, choose **Save**

docs/ENUM.md

@@ -55,7 +55,7 @@ following points/omissions.
     UTF-8 replacements for SIP URIs as SIP URIs themselves must be
     ASCII.
 -   RFC 3761 section 6.1 says that a deployed ENUM service SHOULD
-    include mechanisms to ameloriate security threats and mentions using
+    include mechanisms to ameliorate security threats and mentions using
     DNSSEC. We don't support DNSSEC, so other security approaches (such
     as private ENUM servers) must be used.
 -   RFC 4769 describes ENUM rules that output TEL URIs. Since we have no
@@ -191,7 +191,7 @@ On the new node,
     -   service must be "E2U+SIP", indicating ENUM rather than other
         services
     -   regexp must be a regular expression to apply and is of the form
-        !<pattern\>!<replacement\>! - note that the "!" delimeter is
+        !<pattern\>!<replacement\>! - note that the "!" delimiter is
         only by convention and can be replaced with other symbols (such
         as "/") if "!" occurs within the pattern or replacement.
 

docs/External_HSS_Integration.md

@@ -1,6 +1,6 @@
 # External HSS Integration
 
-All Clearwater deployments include a [Homestead](https://github.com/Metaswitch/crest) cluster.  Homestead presents an HTTP REST-ful [interface](https://github.com/Metaswitch/homestead/blob/dev/docs/homestead_api.md) to HSS data.  This HSS data can be stored in either
+All Clearwater deployments include a [Homestead](https://github.com/Metaswitch/crest) cluster.  Homestead presents an HTTP RESTful [interface](https://github.com/Metaswitch/homestead/blob/dev/docs/homestead_api.md) to HSS data.  This HSS data can be stored in either
 
 *   a Cassandra database located on the Homestead cluster
 *   an external HSS, accessible over a standard IMS [Cx/Diameter](http://www.3gpp.org/ftp/Specs/html-info/29228.htm) interface.

docs/Installation_Instructions.md

@@ -6,7 +6,7 @@ These pages will guide you through installing a Clearwater deployment from scrat
 
 ### What are my choices?
 
-1. All-in-one image, either using an [AMI](https://aws.amazon.com/amis/) on [Amazon EC2](http://aws.amazon.com/ec2/) or an [OVF](http://dmtf.org/standards/ovf) image on a private virtualization platform such as [VMware](http://www.vmware.com/) or [Virtualbox](https://www.virtualbox.org/).  This is the recommended method for trying Clearwater out.
+1. All-in-one image, either using an [AMI](https://aws.amazon.com/amis/) on [Amazon EC2](http://aws.amazon.com/ec2/) or an [OVF](http://dmtf.org/standards/ovf) image on a private virtualization platform such as [VMware](http://www.vmware.com/) or [VirtualBox](https://www.virtualbox.org/).  This is the recommended method for trying Clearwater out.
 
     This installation method is very easy but offers no redundancy or scalability and relatively limited performance.  As a result, it is great for familiarizing yourself with Clearwater before moving up to a larger-scale deployment using one of the following methods.
 

docs/Making_your_first_call.md

@@ -70,7 +70,7 @@ Client configuration methods vary by client, but the following information shoul
 If you are using an All-in-One node, you will also need to configure an outbound proxy at your client.
 
 * Outbound Proxy address: `<aio-identity>`
-* Port: 5060 (or 8060 if installed in Virtualbox)
+* Port: 5060 (or 8060 if installed in VirtualBox)
 
 Once these settings have been applied, your client will register with Clearwater. Note that X-Lite may need to be restarted before it will set up a STUN connection.
 
@@ -82,7 +82,7 @@ Configure a second SIP client with the new number's credentials as above.
 
 ## Make the call
 
-From one client (Zoiper if running an All-in-One node in Virtualbox), dial the `<username>` of the other client to make the call.  Answer the call and check you have two-way media.
+From one client (Zoiper if running an All-in-One node in VirtualBox), dial the `<username>` of the other client to make the call.  Answer the call and check you have two-way media.
 
 ## Next steps
 

docs/Manual_Install.md

@@ -138,7 +138,7 @@ Install the Ellis package with:
 
     sudo DEBIAN_FRONTEND=noninteractive apt-get install ellis --yes
 
-Provision a pool of numbers in Ellis.  The command given here will generate 1000 numbers starting at `sip:6505550000@<zone>`, meaning none of the generated numbers will be routeable outside of the Clearwater deployment.  For more details on creating numbers, see the [create_numbers.py documentation](https://github.com/Metaswitch/ellis/blob/dev/docs/create-numbers.md).
+Provision a pool of numbers in Ellis.  The command given here will generate 1000 numbers starting at `sip:6505550000@<zone>`, meaning none of the generated numbers will be routable outside of the Clearwater deployment.  For more details on creating numbers, see the [create_numbers.py documentation](https://github.com/Metaswitch/ellis/blob/dev/docs/create-numbers.md).
 
     sudo bash -c "export PATH=/usr/share/clearwater/ellis/env/bin:$PATH ;
                   cd /usr/share/clearwater/ellis/src/metaswitch/ellis/tools/ ;

docs/Pull_request_process.md

@@ -11,28 +11,28 @@ Features or any changes to the codebase should be done as follows:
     * If the codebase doesn't have a dev branch, branch off `master`.
 
 2. Implement your feature (including any necessary UTs etc). Commits are cheap in git, try to split up your code into many, it makes reviewing easier as well as for saner merging.
-* If your commit fixes an existing issue #123, include the text "fixes #123" in at least one of your commit messages. This ensures the pull request is [attached to the existing issue](http://stackoverflow.com/questions/4528869/how-do-you-attach-a-new-pull-request-to-an-existing-issue-on-github</a>).
+    * If your commit fixes an existing issue #123, include the text "fixes #123" in at least one of your commit messages. This ensures the pull request is [attached to the existing issue](http://stackoverflow.com/questions/4528869/how-do-you-attach-a-new-pull-request-to-an-existing-issue-on-github</a>).
 
 3. Once complete, ensure the following check pass (where relevant):
     * All UTs (including coverage and valgrind) pass.
-    * Your code builds cleanly into a debian package on the repo server.
+    * Your code builds cleanly into a Debian package on the repo server.
     * The resulting package installs cleanly using the clearwater-infrastructure script.
     * The live tests pass.
 
-4. Push your feature branch to Github.
+4. Push your feature branch to GitHub.
 
-5. Create a pull request using Github, from your branch to `dev` (never `master`, unless the codebase has no dev branch).
+5. Create a pull request using GitHub, from your branch to `dev` (never `master`, unless the codebase has no dev branch).
 
 6. Await review.
     * Address code review issues on your feature branch.
-    * Push your changes to the feature branch on github. This automatically updates the pull request.
+    * Push your changes to the feature branch on GitHub. This automatically updates the pull request.
     * If necessary, make a top-level comment along the lines "Please re-review", assign back to the reviewer, and repeat the above.
     * If no further review is necessary and you have the necessary privileges, merge the pull request and close the branch.  Otherwise, make a top-level comment and assign back to the reviewer as above.
 
 
 # Reviewer process:
 
-* Receive notice of review by Github email, Github notification, or by checking [all your Metaswitch Github issues](https://github.com/organizations/Metaswitch/dashboard/issues/assigned?direction=desc&amp;state=open).
+* Receive notice of review by GitHub email, GitHub notification, or by checking [all your Metaswitch GitHub issues](https://github.com/organizations/Metaswitch/dashboard/issues/assigned?direction=desc&amp;state=open).
 * Make comments on the pull request (either line comments or top-level comments).
 * Make a top-level comment saying something along the lines of "Fine; some minor comments" or "Some issues to address before merging".
 * If there are no issues, merge the pull request and close the branch. Otherwise, assign the pull request to the developer and leave this to them.

docs/Running_the_live_tests.md

@@ -29,7 +29,7 @@ Run the following to download and install the Clearwater test suite
     cd clearwater-live-test
     bundle install
 
-Make sure that you have an ssh key - if not, see the [github instructions](https://help.github.com/articles/generating-ssh-keys) for how to create one.
+Make sure that you have an SSH key - if not, see the [GitHub instructions](https://help.github.com/articles/generating-ssh-keys) for how to create one.
 
 ## Work out your signup code