Merge branch 'enhancement/2.x-great-docs-update' into 2.x

Author: russcam

build/scripts/Building.fsx

@@ -53,8 +53,8 @@ module Build =
         )
 
     let private compileDesktop() =
-        Tooling.MsBuild.Rebuild DotNetFramework.Net45.Identifier
-        Tooling.MsBuild.Rebuild DotNetFramework.Net46.Identifier
+        Tooling.MsBuild.Rebuild DotNetFramework.Net45
+        Tooling.MsBuild.Rebuild DotNetFramework.Net46
 
     let private gitLink() =
         DotNetProject.AllPublishable
@@ -70,7 +70,7 @@ module Build =
 
     let Compile() = 
         match quickBuild with 
-        | true ->  Tooling.MsBuild.Build DotNetFramework.Net45.Identifier
+        | true ->  Tooling.MsBuild.Build DotNetFramework.Net45
         | false ->  
             compileDesktop()
             compileCore()

build/scripts/Tooling.fsx

@@ -158,9 +158,16 @@ module Tooling =
     let DotNet = new DotNetTooling("dotnet.exe")
 
     type MsBuildTooling() =
-
-        member this.Build (framework:Projects.DotNetFrameworkIdentifier) =
-            let solution = Paths.Source "Elasticsearch.sln";
+        // Exclude DocGenerator from .NET 4.5 build as it depends on a Roslyn library
+        // that is built against .NET 4.5.2
+        let solutionForFramework framework =
+            match framework with
+            | Net45 -> Paths.Source "Elasticsearch.Net45.sln"
+            | _ -> Paths.Source "Elasticsearch.sln"  
+
+        member this.Build (framework:Projects.DotNetFramework) =            
+            let solution = solutionForFramework framework 
+            let identifier = framework.Identifier
             let setParams defaults =
                 { defaults with
                     Verbosity = Some(Quiet)
@@ -169,14 +176,15 @@ module Tooling =
                         [
                             "Optimize", "True"
                             "Configuration", "Release"
-                            "TargetFrameworkVersion", framework.MSBuild
-                            "DefineConstants", framework.DefineConstants
+                            "TargetFrameworkVersion", identifier.MSBuild
+                            "DefineConstants", identifier.DefineConstants
                         ]
                  }
             build setParams solution 
 
-        member this.Rebuild (framework:Projects.DotNetFrameworkIdentifier) =
-            let solution = Paths.Source "Elasticsearch.sln";
+        member this.Rebuild (framework:Projects.DotNetFramework) = 
+            let solution = solutionForFramework framework              
+            let identifier = framework.Identifier               
             let setParams defaults =
                 { defaults with
                     Verbosity = Some(Quiet)
@@ -186,8 +194,8 @@ module Tooling =
                             "OutputPathBaseDir", Path.GetFullPath "build\\output"
                             "Optimize", "True"
                             "Configuration", "Release"
-                            "TargetFrameworkVersion", framework.MSBuild
-                            "DefineConstants", framework.DefineConstants
+                            "TargetFrameworkVersion", identifier.MSBuild
+                            "DefineConstants", identifier.DefineConstants
                         ]
                  }
 

docs/2.0-breaking-changes/elasticsearch-net-breaking-changes.asciidoc

@@ -1,5 +1,4 @@
 :github: https://github.com/elastic/elasticsearch-net
-
 :stackoverflow: http://stackoverflow.com
 
 [[elasticsearch-net-breaking-changes]]
@@ -8,6 +7,7 @@
 This document rudimentally documents the breaking changes from 1.x to 2.x; Our 2.0 refactor comprises 1000+ commits and nearly six months of work, so if we missed anything
 {github}/issues[feel free to give us a shout]!
 
+[float]
 === Dependency graph changes
 
 The first thing you might notice is that the dependency graph for the client has changed slightly.  It has also been renamed from `IElasticsearchClient` to `ILowLevelElasticClient`, to align better with the high level (NEST) client and better differentiate itself.
@@ -61,12 +61,13 @@ var client = new ElasticLowLevelClient(pool);
 ----
 
 This is what we call internally if you use the previous `ElasticLowLevelClient` constructor.
-Our implementation of <<transports,`ITransport`>> can be injected with a custom <<request-pipeline,`IRequestPipelineFactory`>>, <<date-time-providers,`IDateTimeProvider`>> and `IMemoryStreamFactory`.
+Our implementation of <<transports,`ITransport`>> can be injected with a custom <<request-pipelines,`IRequestPipelineFactory`>>, <<date-time-providers,`IDateTimeProvider`>> and `IMemoryStreamFactory`.
 
 <<transports,`Transport`>> is in control of managing our request pipelining, asking connection pools for other nodes to fall over to and marking nodes dead or alive.
 
 Each individual moving part is further explained in the index.html[documentation].
 
+[float]
 === ConnectionSettings Changes
 
 This lists the methods that have been renamed or removed on ConnectionConfiguration
@@ -140,6 +141,7 @@ interface IConnectionConfigurationValues
 +     prop: PrettyJson
 ----
 
+[float]
 ==== IConnectionPool
 
 The interface for `IConnectionPool` has been greatly simplified, its no longer in charge of mark nodes alive or dead
@@ -156,6 +158,7 @@ interface IConnectionPool
 +     method: Reseed
 ----
 
+[float]
 ==== IConnection
 
 The connection interface has been stripped to the bare minimum it now only has a `Request` and `RequestAsync` method
@@ -180,6 +183,7 @@ interface IConnection
 
 The methods take a `RequestData` a new state object that holds all the information to build the request.
 
+[float]
 ==== Renamed Types
 
 This lists the types that have been renamed
@@ -244,6 +248,7 @@ This lists the types that have been renamed
 + class IndexTemplateExistsRequestParameters
 ----
 
+[float]
 ==== Removed Types
 
 This lists the removed types
@@ -296,6 +301,7 @@ This lists the removed types
 - class UpdateSettingsRequestParameters
 ----
 
+[float]
 ==== Member Changes
 
 This lists changes of class members that might bite you during the upgrade
@@ -496,3 +502,4 @@ class UpdateRequestParameters
 class ValidateQueryRequestParameters
 -     method: Q
 ----
+

docs/2.0-breaking-changes/nest-breaking-changes.asciidoc

@@ -1,13 +1,10 @@
-:github: https://github.com/elastic/elasticsearch-net
-
-:stackoverflow: http://stackoverflow.com
-
 [[nest-breaking-changes]]
 == NEST breaking changes
 
 This document rudimentally documents the breaking changes from 1.x to 2.x; Our 2.0 refactor comprises 1000+ commits and nearly six months of work, so if we missed anything
 {github}/issues[feel free to give us a shout]!
 
+[float]
 === Dependency graph changes
 
 The first thing you might notice is that the dependency graph for the client has changed slightly
@@ -61,15 +58,16 @@ var client = new ElasticClient(pool);
 ----
 
 This is what we call internally if you use the previous `ElasticClient` constructor.
-Our implementation of <<transports,`ITransport`>> can be injected with a custom <<request-pipeline,`IRequestPipelineFactory`>>, <<date-time-providers,`IDateTimeProvider`>> and `IMemoryStreamFactory`.
+Our implementation of <<transports,`ITransport`>> can be injected with a custom <<request-pipelines,`IRequestPipelineFactory`>>, <<date-time-providers,`IDateTimeProvider`>> and `IMemoryStreamFactory`.
 
 <<transports,`Transport`>> is in control of managing our request pipelining, asking connection pools for other nodes to fall over to and marking nodes dead or alive.
 
 Each individual moving part is further explained in the index.html[documentation].
 
+[float]
 === Inferred types
 
-Many places that only took a string now take a more strongly typed object, <<`Id`,ids-inference>>, <<field-inference,`Field`>>, <<field-inference,`Fields`>>, <<index-name-inference,`Index`>>, <<indices-paths,`Indices`>>, `Type`, `Types`, <<document-paths,`DocumentPath<T>`>>. It's good to know that in most cases you can still implicitly convert to them from `string`, `long`, `Guid` where it makes sense.
+Many places that only took a string now take a more strongly typed object, <`Id`,ids-inference>>, <<field-inference,`Field`>>, <<field-inference,`Fields`>>, <<index-name-inference,`Index`>>, <<indices-paths,`Indices`>>, `Type`, `Types`, <<document-paths,`DocumentPath<T>`>>. It's good to know that in most cases you can still implicitly convert to them from `string`, `long`, `Guid` where it makes sense.
 
 If you are using `C# 6` you can also staticly import `using static Nest.Infer`. This will allow you to write 
 
@@ -96,11 +94,13 @@ for `Index` and so on and so forth.
 
 If you are using the fluent API, using these is not required (but still possible), as the fluent API is already expression based.
 
+[float]
 === Filters are **GONE**
 
 In `Elasticsearch 2.0` https://www.elastic.co/guide/en/elasticsearch/reference/2.3/breaking_20_query_dsl_changes.html#_queries_and_filters_merged[queries and filter constructs have merged into one concept called queries], `NEST 2.0` reflects this, so if you are looking for the `AndFilter` it is now
 called the `AndQuery` but beware that some of these filters have been obsoleted and chances are high https://www.elastic.co/blog/all-about-elasticsearch-filter-bitsets[you were using them wrong!].
 
+[float]
 === Isolated descriptors
 
 In `NEST 1.x` we took pride in being a 1 to 1 mapping with the Elasticsearch API, however in some cases we hid the real depth of parameters.
@@ -133,10 +133,12 @@ This encapsulates all of the sort options properly and adheres stricter to the 1
 
 This happens in more places e.g index settings and mappings.
 
+[float]
 === Aggregator
 
 If you are using the object initializer syntax `*Aggregator` is now `*Aggregation`
 
+[float]
 === Attribute-based mapping
 
 The single `ElasticPropertyAttribute` has been broken up into individual attributes per property type.
@@ -199,6 +201,7 @@ Aside from a simpler and cleaner API, this allows each attribute to only reflect
 
 `MapFromAttributes()` has also been renamed to `AutoMap()` to better reflect that it doesn't only depend on properties being marked with attributes.  It will also infer the type based on the CLR type if no attribute is present.
 
+[float]
 === `TimeSpan` automapped as `long` (ticks)
 
 `System.TimeSpan` is now automatically mapped as a `long` representing the number of ticks within the timeSpan, allowing for range  in addition to term queries. NEst 1.x automatically mapped `TimeSpan` as a string and whilst NEST 2.0 is able to deserialize strings into `TimeSpan` instances as before, it will not automatically serialize `TimeSpan` ***into*** strings when indexing. In order to achieve this, you will need to register a json converter, either by deriving from `JsonNetSerializer` and overriding `ContractConverters` or by attributing the property with `[JsonConverter(typeof(ConverterTypeName))]`. A example of a converter for serializing/deserializing string values for `TimeSpan` is
@@ -239,11 +242,11 @@ public class StringTimeSpanConverter : JsonConverter
 }
 ----
 
+[float]
 === Serialization settings
 
 Serialization settings are now configurable through `ConnectionSettings` constructor taking a factory function that returns an instance of `IElasticsearchSerializer`.
 
-
 [source,csharp]
 ----
 var setting = new ConnectionSettings(/** settings */);
@@ -278,6 +281,7 @@ public class MyJsonNetSerializer : JsonNetSerializer
 }
 ----
 
+[float]
 === Renamed Types
 
 [source,diff]
@@ -706,6 +710,7 @@ public class MyJsonNetSerializer : JsonNetSerializer
 + class ValueCountAggregation
 ----
 
+[float]
 ==== Removed Types
 
 [source,diff]
@@ -1399,6 +1404,7 @@ public class MyJsonNetSerializer : JsonNetSerializer
 - class YesNoBoolConverter
 ----
 
+[float]
 ==== Member Changes
 
 [source,diff]
@@ -3225,3 +3231,4 @@ class VerifyRepositoryResponse
 +     prop: ApiCall
 -     prop: Infer
 ----
+