Skip to content

Commit

Permalink
clean up language
Browse files Browse the repository at this point in the history
  • Loading branch information
SimonCropp committed Mar 4, 2016
1 parent 922fd6c commit 77ea83a
Show file tree
Hide file tree
Showing 74 changed files with 250 additions and 243 deletions.
12 changes: 6 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,8 +14,8 @@ For simple changes the GitHub web UI should suffice.

1. Find the page you want to edit on http://docs.particular.net/.
1. Click the `Improve this doc`. This will automatically fork the project so you can edit the file.
1. Make the changes you require. Ensure you verify your changes in the `Preview` tab.
1. Add a description of your changes.
1. Make the changes you require. Ensure you verify the changes in the `Preview` tab.
1. Add a description of the changes.
1. Click `Propose File Changes`.


Expand All @@ -24,8 +24,8 @@ For simple changes the GitHub web UI should suffice.
For more complex changes you should fork and then submit a pull request. This is useful if you are proposing multiple file changes

1. [Fork](https://help.github.com/forking/) on GitHub.
1. Clone your fork locally.
1. Work on your feature.
1. Clone the fork locally.
1. Work on the feature.
1. Push the up to GitHub.
1. Send a Pull Request on GitHub.

Expand Down Expand Up @@ -228,7 +228,7 @@ The site is rendered using [GitHub Flavored Markdown](https://help.github.com/ar

### [MarkdownPad](http://markdownpad.com/)

For editing markdown on your desktop (after cloning locally with Git) try [MarkdownPad](http://markdownpad.com/).
For editing markdown on the desktop (after cloning locally with Git) try [MarkdownPad](http://markdownpad.com/).


#### Markdown flavor
Expand Down Expand Up @@ -284,7 +284,7 @@ Endpoint1\Endpoint1.csproj

At the moment the best way to get started on a sample is to copy an existing one. Ideally one that has similarities to what you are trying to achieve.

A good sample to start with is the [Default Logging Sample](https://github.com/Particular/docs.particular.net/tree/master/samples/logging/default), since all it does is enable logging. You can then add the various moving pieces to your copy.
A good sample to start with is the [Default Logging Sample](https://github.com/Particular/docs.particular.net/tree/master/samples/logging/default), since all it does is enable logging. You can then add the various moving pieces to the copy.


### Screenshots
Expand Down
2 changes: 1 addition & 1 deletion nservicebus/architecture/nservicebus-and-biztalk.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,6 @@ As you can see, the use of BizTalk behind a service boundary is something of an

Sometimes you need a hammer, sometimes you need a screwdriver, and sometimes you need both. While a Swiss army knife may appear to do both, it is a poor choice for any but the most trivial undertakings.

To learn more about dividing up your architecture into high-level business services, see the [presentation Udi gave on SOA](principles.md).
To learn more about dividing up an architecture into high-level business services, see the [presentation Udi gave on SOA](principles.md).

[This download from Microsoft](http://download.microsoft.com/download/B/0/6/B0678433-88EA-44D4-8C4C-F4AA5DFC4C58/nServiceBus%20and%20BizTalk%20Server.docx) describes the details of getting NServiceBus and BizTalk to work together, including a whitepaper, code samples, and videos to get you up and running in no time.
4 changes: 2 additions & 2 deletions nservicebus/architecture/principles.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,9 +22,9 @@ In this presentation, Udi Dahan explains the disadvantages of classical web serv

One of the problems with the distributed systems built today is that they are fragile. As one part of the system slows down, the effect tends to ripple out and cripple the entire system. One of the primary design goals of NServiceBus is to eliminate that, guiding developers to write code that is robust in production environments. That robustness prevents data loss under failure conditions.

To make effective use of NServiceBus, you need to understand the distributed systems architecture it is designed to support. In other words, if you design your system according to the principles laid out below, NServiceBus will make your life a lot easier. On the other hand, if you do not follow these principles, NServiceBus will probably make it harder.
To make effective use of NServiceBus, you need to understand the distributed systems architecture it is designed to support. In other words, if you design the system according to the principles laid out below, NServiceBus will make life a lot easier. On the other hand, if you do not follow these principles, NServiceBus will probably make it harder.

The extensibility features in NServiceBus enable you to tweak its behavior to suit your specific needs, yet they are documented separately.
The extensibility features in NServiceBus enable you to tweak its behavior to suit the specific needs, yet they are documented separately.

The communications pattern that enables robustness is one-way messaging, also known as "fire and forget". This is discussed in more detail shortly.

Expand Down
6 changes: 3 additions & 3 deletions nservicebus/azure/azure-servicebus-transport.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,9 +26,9 @@ Note: Publish/Subscribe and Timeouts (including message deferral) are supported

## Enabling the Transport

First, ensure you're using Standard Messaging Tier for Azure Service Bus when creating your namespace at Azure portal.
First, ensure that Standard Messaging Tier is being used for Azure Service Bus when creating the namespace in the Azure portal.

Second, reference the assembly that contains the Azure Service Bus transport definition. The recommended method is to add a NuGet package reference to the `NServiceBus.Azure.Transports.WindowsAzureServiceBus` package to your project.
Second, reference the assembly that contains the Azure Service Bus transport definition. The recommended method is to add a NuGet package reference to the `NServiceBus.Azure.Transports.WindowsAzureServiceBus` package to the project.

```
PM> Install-Package NServiceBus.Azure.Transports.WindowsAzureServiceBus
Expand Down Expand Up @@ -80,7 +80,7 @@ Using this configuration setting you can change the following values. NOTE: Most

NOTE: `QueueName` and `QueuePerInstance` are obsoleted. Instead, use bus configuration object to specify endpoint name and scale-out option.

Defaults are just starting values. You should always measure and test these values against your solution and adjust those accordingly.
Defaults are just starting values. You should always measure and test these values against the solution and adjust those accordingly.


### BrokeredMessage body conventions
Expand Down
10 changes: 5 additions & 5 deletions nservicebus/azure/azure-storage-persistence.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ Various features of NServiceBus require persistence. Among them are subscription

## How To enable persistence with Azure storage services

First you need to reference the assembly that contains the Azure storage persisters. The recommended way of doing this is by adding a NuGet package reference to the `NServiceBus.Azure` package to your project.
First you need to reference the assembly that contains the Azure storage persisters. The recommended way of doing this is by adding a NuGet package reference to the `NServiceBus.Azure` package to the project.

If self hosting, you can configure the persistence technology using the configuration API and the extension method found in the `NServiceBus.Azure` assembly

Expand All @@ -36,7 +36,7 @@ NOTE: In Version 4, when hosting in the Azure role entrypoint provided by `NServ

## Detailed Configuration

You can get more control on the behavior of each persister by specifying one of the respective configuration sections in your app.config and changing one of the available properties, or through code.
You can get more control on the behavior of each persister by specifying one of the respective configuration sections in the app.config and changing one of the available properties, or through code.


### Detailed Configuration with Configuration Section
Expand Down Expand Up @@ -68,17 +68,17 @@ For more information see [Configuring Azure Connection Strings](https://azure.mi

## Additional performance tips

Azure storage persistence is network IO intensive, every operation performed against storage implies one or more network hops, most of which are small http requests to a single IP address (of your storage cluster). By default the .NET framework has been configured to be very restrictive when it comes to this kind of communication:
Azure storage persistence is network IO intensive, every operation performed against storage implies one or more network hops, most of which are small http requests to a single IP address (of the storage cluster). By default the .NET framework has been configured to be very restrictive when it comes to this kind of communication:
- It only allows 2 simultaneous connections to a single IP address by default
- It's algorithm stack has been optimized for larger payload exchanges, not for small requests
- It doesn't trust the remote servers by default, so it verifies for revoked certificates on every request

You can drastically improve performance by overriding these settings. You can leverage the ServicePointManager class for this end and change it's settings, but this must be done before your application makes any outbound connection, so ideally it's done very early in your application's startup routine.
You can drastically improve performance by overriding these settings. You can leverage the ServicePointManager class for this end and change it's settings, but this must be done before the application makes any outbound connection, so ideally it's done very early in the application's startup routine.

ServicePointManager.DefaultConnectionLimit = 5000; // default settings only allows 2 concurrent requests per process to the same host
ServicePointManager.UseNagleAlgorithm = false; // optimize for small requests
ServicePointManager.Expect100Continue = false; // reduces number of http calls
ServicePointManager.CheckCertificateRevocationList = false; // optional, only if you trust all your dependencies
ServicePointManager.CheckCertificateRevocationList = false; // optional, only if you trust all dependencies


### Detailed Configuration with Code
Expand Down
6 changes: 3 additions & 3 deletions nservicebus/azure/azure-transport.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ As part of the Azure support for NServiceBus, you can choose between two options
* Azure Storage Queues
* Azure Service Bus

Each of these two options has separate features, capabilities, and usage characteristics. A detailed comparison and discussion of when to select which is beyond the scope of this document. To help decide which option best suits your application's needs, review the Azure article [Azure Queues and Azure Service Bus Queues - Compared and Contrasted](https://azure.microsoft.com/en-us/documentation/articles/service-bus-azure-and-service-bus-queues-compared-contrasted/).
Each of these two options has separate features, capabilities, and usage characteristics. A detailed comparison and discussion of when to select which is beyond the scope of this document. To help decide which option best suits the application's needs, review the Azure article [Azure Queues and Azure Service Bus Queues - Compared and Contrasted](https://azure.microsoft.com/en-us/documentation/articles/service-bus-azure-and-service-bus-queues-compared-contrasted/).


## Configuring for cloud service hosting
Expand Down Expand Up @@ -65,7 +65,7 @@ Alternatively, you can use the Azure development environment emulator by using t

UseDevelopmentStorage=True;

In your NServiceBus solution, specify the Endpoint Configuration to use AzureStorageQueue transport:
In the NServiceBus solution, specify the Endpoint Configuration to use AzureStorageQueue transport:

public class EndpointConfig : IConfigureThisEndpoint, AsA_Worker
{
Expand Down Expand Up @@ -102,7 +102,7 @@ schemaVersion="2013-03.2.0">

The "AzureServiceBusQueueConfig.ConnectionString" for Azure Service Bus namespace connection string can be retrieved from the Azure portal using an authorized account.

In your NServiceBus solution, specify the endpoint configuration to use AzureServiceBus transport:
In the NServiceBus solution, specify the endpoint configuration to use AzureServiceBus transport:

public class EndpointConfig : IConfigureThisEndpoint, AsA_Worker
{
Expand Down
6 changes: 3 additions & 3 deletions nservicebus/azure/faq.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ This document combines frequently asked questions related to the Azure transport

The short answer is no! The longer answer is: Queues are remote, instead of local, and this has several implications.

* Your message has to cross the network boundaries before it is persisted, this implies that it is subject to all kinds network related issues like latency, timeouts, connection loss, network partitioning etc.
* A message has to cross the network boundaries before it is persisted, this implies that it is subject to all kinds network related issues like latency, timeouts, connection loss, network partitioning etc.
* Remote queues do not play along in transactions, as transactions are very brittle because of the possible network issues mentioned in the previous point, but also because they would require server side locks to function properly and allowing anyone to take unbound locks on a service is a very good way to get yourself in a denial of service situation. Hence Azure services typically don't allow transactions.


Expand Down Expand Up @@ -46,7 +46,7 @@ By default it does not, it's an at least once delivery model. But you can enable

There is a known issue when enabling NServiceBus in a website that is hosted in the Microsoft Azure compute emulator and when performance counters have been installed (either via the installer or via PowerShell). There are 2 possible workarounds:

* Do not host your website in the compute emulator, but outside of it
* Do not host the website in the compute emulator, but outside of it
* Remove the performance counters using PowerShell `([Diagnostics.PerformanceCounterCategory]::Delete( "NServiceBus" ))`


Expand All @@ -57,4 +57,4 @@ This is almost always related to an exception happening at startup of the roleen

### Exceptions occurring at startup are not visible in the logs

When using the diagnostics service in cloud services, this service starts in parallel with your own startup code. If an exception occurs at this point in time, your code may not be able to call the diagnostics service yet and your exception information may get lost. Use intellitrace and historical debugging instead to learn more about the cause of the exception.
When using the diagnostics service in cloud services, this service starts in parallel with the startup code. If an exception occurs at this point in time, the code may not be able to call the diagnostics service yet and the exception information may get lost. Use intellitrace and historical debugging instead to learn more about the cause of the exception.
Loading

0 comments on commit 77ea83a

Please sign in to comment.