Made building documentation part of the build redesign to clearly indicate the difference between elasticsearch.net and nest

Author: Mpdreamz

.gitignore

@@ -42,7 +42,7 @@ build/tools/*
 !build/tools/ilmerge
 /dep/Newtonsoft.Json.4.0.2
 !new_docs/build
-
+new_docs/node_modules
 
 /src/Nest.Tests.Unit/*.ncrunchproject
 *.ncrunchproject

build.bat

@@ -1,17 +1,43 @@
 @echo off
+REM we need nuget to install tools locally
 if not exist build\tools\nuget\nuget.exe (
     ECHO Nuget not found.. Downloading..
 	mkdir build\tools\nuget
     PowerShell -NoProfile -ExecutionPolicy Bypass -Command "& 'build\download-nuget.ps1'"
 )
+
+REM we need FAKE to process our build scripts
 if not exist build\tools\FAKE\tools\Fake.exe (
     ECHO FAKE not found.. Installing..
     "build\tools\nuget\nuget.exe" "install" "FAKE" "-OutputDirectory" "build\tools" "-ExcludeVersion" "-Prerelease"
 )
+
+REM we need nunit-console to run our tests
 if not exist build\tools\NUnit.Runners\tools\nunit-console.exe (
     ECHO Nunit not found.. Installing
     "build\tools\nuget\nuget.exe" "install" "NUnit.Runners" "-OutputDirectory" "build\tools" "-ExcludeVersion" "-Prerelease"
 )
+
+REM we need wintersmith to build our documentation which in turn needs npm/node
+REM installing and calling this locally so that yours and CI's systems do not need to be configured prior to running build.bat
+if not exist build\tools\Node.js\node.exe (
+    ECHO Local node not found.. Installing..
+    "build\tools\nuget\nuget.exe" "install" "node.js" "-OutputDirectory" "build\tools" "-ExcludeVersion" "-Prerelease"
+)
+if not exist build\tools\Npm\node_modules\npm\cli.js (
+    ECHO Local npm not found.. Installing..
+    "build\tools\nuget\nuget.exe" "install" "npm" "-OutputDirectory" "build\tools" "-ExcludeVersion" "-Prerelease"
+)
+if not exist build\tools\node_modules\wintersmith\bin\wintersmith (
+    ECHO wintersmith not found.. Installing.. 
+    cd build\tools
+
+    "Node.js\node.exe" "Npm\node_modules\npm\cli.js" install wintersmith
+
+    cd ..\..
+)
+
+
 SET TARGET="Build"
 
 IF NOT [%1]==[] (set TARGET="%1")

build/build.fsx

@@ -31,14 +31,14 @@ Target "Test" (fun _ ->
 )
 
 let keyFile = "build/keys/keypair.snk"
-let validateSignedAssembly = fun (name) ->
+let validateSignedAssembly = fun name ->
     let sn = "build/tools/sn/sn.exe"
     ExecProcess(fun p ->
       p.FileName <- sn
       p.Arguments <- sprintf @"-v build\output\%s.dll" name
     ) (TimeSpan.FromMinutes 5.0)
 
-let signAssembly = fun (name) ->
+let signAssembly = fun name ->
     let ilmerge = "build/tools/ilmerge/ILMerge.exe"
     let platform =  @"/targetplatform:v4,C:\Windows\Microsoft.NET\Framework64\v4.0.30319"
     let i = sprintf "build\\output\\%s\\%s" name name
@@ -64,7 +64,7 @@ let signAssembly = fun (name) ->
       | _ ->
         failwithf "Failed to sign {0}" name
 
-let nugetPack = fun (name) ->
+let nugetPack = fun name ->
 
     CreateDir nugetOutDir
 
@@ -80,6 +80,16 @@ let nugetPack = fun (name) ->
 
     MoveFile nugetOutDir (buildDir + (sprintf "%s/%s.%s.nupkg" name name version)) 
 
+let buildDocs = fun action ->
+    let node = @"build\tools\Node.js\node.exe"
+    let wintersmith = @"..\build\tools\node_modules\wintersmith\bin\wintersmith"
+    ExecProcess (fun p ->
+      p.WorkingDirectory <- "new_docs"  
+      p.FileName <- node
+      p.Arguments <- sprintf "\"%s\" %s" wintersmith action
+    ) (TimeSpan.FromMinutes (if action = "preview" then 300.0 else 5.0))
+
+
 Target "Release" (fun _ -> 
     if not <| fileExists keyFile 
       then failwithf "{0} does not exist to sign the assemblies" keyFile 
@@ -94,6 +104,13 @@ Target "Release" (fun _ ->
 
 )
 
+Target "Docs" (fun _ -> buildDocs "build" |> ignore)
+Target "DocsPreview" (fun _ -> 
+  buildDocs "plugin install livereload" |> ignore
+  buildDocs "preview" |> ignore
+)
+
+
 // Dependencies
 "Clean" 
   ==> "BuildApp"
@@ -103,5 +120,7 @@ Target "Release" (fun _ ->
 "Build"
   ==> "Release"
 
+"DocsPreview"
+
 // start build
 RunTargetOrDefault "Build"

new_docs/build/cluster/health.html

@@ -1,15 +1,15 @@
-<!DOCTYPE html><html><head><title>Nest - Connecting</title><meta http-equiv="cache-control" content="no-cache"><meta http-equiv="pragma" content="no-cache"><meta http-equiv="content-type" content="text/html;charset=utf-8"><meta http-equiv="expires" content="0"><meta name="description" content="elasticsearch"><meta name="keywords" content="nest, elasticsearch, .net, client"><meta name="author" content="martijn laarman"><link rel="stylesheet" type="text/css" href="/styles/layout.css"><link rel="stylesheet" type="text/css" href="/styles/pygments.css"><link href="http://fonts.googleapis.com/css?family=Ubuntu+Mono|Ubuntu" rel="stylesheet" type="text/css"><link href="/prettify/prettify.css" type="text/css" rel="stylesheet"><link href="/prettify/sunburst.css" type="text/css" rel="stylesheet"><script src="http://code.jquery.com/jquery.min.js" type="text/javascript"></script><script type="text/javascript" src="/prettify/prettify.js"></script><script type="text/javascript" src="/prettify/fix_code_tags.js"></script></head><body><section id="site"><div class="actions"><iframe src="http://ghbtns.com/github-btn.html?user=Mpdreamz&amp;repo=NEST&amp;type=fork&amp;count=true" allowtransparency="true" frameborder="0" scrolling="0" width="95" height="20"></iframe><iframe src="http://ghbtns.com/github-btn.html?user=Mpdreamz&amp;repo=NEST&amp;type=watch&amp;count=true" allowtransparency="true" frameborder="0" scrolling="0" width="110" height="20"></iframe></div><aside><ul id="top_left_menu"><h4>External</h4><li><a href="http://www.elasticsearch.org" target="_blank">Elasticsearch Docs</a></li><li><a href="http://mpdreamz.mit-license.org/" target="_blank">MIT license</a></li></ul></aside><section id="content"><aside id="menu"><ul id="top_left_menu"><li><a href="/">+ Concepts</a></li><li><a href="/core/" class="">+ Core</a></li><li><a href="/indices/aliases.html" class="">+ Indices</a></li><h4>- Cluster</h4><ul><li><a href="/cluster/health.html" class="selected">Health</a></li><li><a href="/cluster/state.html" class="">State</a></li><li><a href="/cluster/update-settings.html" class="">Update Settings</a></li><li><a href="/cluster/nodes-info.html" class="">Nodes Info</a></li><li><a href="/cluster/nodes-stats.html" class="">Nodes Stats</a></li><li><a href="/cluster/nodes-shutdown.html" class="">Nodes Shutdown</a></li></ul><li><a href="/search/basics.html" class="">+ Search</a></li><li><a href="/facets/handling.html" class="">+ Facets</a></li><li><a href="/query/text.html" class="">+ Query DSL</a></li><li><a href="/filter/and.html" class="">+ Filter DSL</a></li></ul></aside><article><div id="content-margin-fix"><h1>Health</h1>
+<html><head><title>Nest - Connecting</title><meta http-equiv="cache-control" content="no-cache"/><meta http-equiv="pragma" content="no-cache"/><meta http-equiv="content-type" content="text/html;charset=utf-8"/><meta http-equiv="expires" content="0"/><meta name="description" content="elasticsearch"/><meta name="keywords" content="nest, elasticsearch, .net, client"/><meta name="author" content="martijn laarman"/><link rel="stylesheet" type="text/css" href="/styles/layout.css"/><link rel="stylesheet" type="text/css" href="/styles/pygments.css"/><link href="http://fonts.googleapis.com/css?family=Ubuntu+Mono|Ubuntu" rel="stylesheet" type="text/css"/><link href="/prettify/prettify.css" type="text/css" rel="stylesheet"/><link href="/prettify/sunburst.css" type="text/css" rel="stylesheet"/><script src="http://code.jquery.com/jquery.min.js" type="text/javascript"></script><script type="text/javascript" src="/prettify/prettify.js"></script><script type="text/javascript" src="/prettify/fix_code_tags.js"></script></head><body><section id="site"><div class="actions"><iframe src="http://ghbtns.com/github-btn.html?user=Mpdreamz&amp;repo=NEST&amp;type=fork&amp;count=true" allowtransparency="true" frameborder="0" scrolling="0" width="95" height="20"></iframe><iframe src="http://ghbtns.com/github-btn.html?user=Mpdreamz&amp;repo=NEST&amp;type=watch&amp;count=true" allowtransparency="true" frameborder="0" scrolling="0" width="110" height="20"></iframe></div><aside><ul id="top_left_menu"><h4>External</h4><li><a href="http://www.elasticsearch.org" target="_blank">Elasticsearch Docs</a></li><li><a href="http://mpdreamz.mit-license.org/" target="_blank">MIT license</a></li></ul></aside><section id="content"><aside id="menu"><ul id="top_left_menu"><li><a href="/">+ Concepts</a></li><li><a href="/core/">+ Core</a></li><li><a href="/indices/aliases.html">+ Indices</a></li><h4>- Cluster</h4><ul><li><a href="/cluster/health.html" class="selected">Health</a></li><li><a href="/cluster/state.html">State</a></li><li><a href="/cluster/update-settings.html">Update Settings</a></li><li><a href="/cluster/nodes-info.html">Nodes Info</a></li><li><a href="/cluster/nodes-stats.html">Nodes Stats</a></li><li><a href="/cluster/nodes-shutdown.html">Nodes Shutdown</a></li></ul><li><a href="/search/basics.html">+ Search</a></li><li><a href="/facets/handling.html">+ Facets</a></li><li><a href="/query/text.html">+ Query DSL</a></li><li><a href="/filter/and.html">+ Filter DSL</a></li></ul></aside><article><div id="content-margin-fix"><h1 id="health">Health</h1>
 <p>Get cluster health simple</p>
-<pre><code>var r = this._client.Health(HealthLevel.Cluster);</code></pre>
-<p>Cluster health just for one (or more) index</p>
-<pre><code>var r = this._client.Health(new[] { Test.Default.DefaultIndex }, HealthLevel.Cluster);</code></pre>
-<p>Advanced options are mapped as well</p>
+<pre><code>var r = this._client.Health(HealthLevel.Cluster);
+</code></pre><p>Cluster health just for one (or more) index</p>
+<pre><code>var r = this._client.Health(new[] { Test.Default.DefaultIndex }, HealthLevel.Cluster);
+</code></pre><p>Advanced options are mapped as well</p>
 <pre><code>var r = this._client.Health(new HealthParams
 {
     CheckLevel = HealthLevel.Shards,
     Timeout = &quot;30s&quot;,
     WaitForMinNodes = 1,
     WaitForRelocatingShards = 0,
     WaitForStatus = HealthStatus.Green
-});</code></pre>
-</div></article></section></section></body></html>
+});
+</code></pre></div></article></section></section></body></html>

new_docs/build/cluster/nodes-info.html

@@ -1,6 +1,6 @@
-<!DOCTYPE html><html><head><title>Nest - Connecting</title><meta http-equiv="cache-control" content="no-cache"><meta http-equiv="pragma" content="no-cache"><meta http-equiv="content-type" content="text/html;charset=utf-8"><meta http-equiv="expires" content="0"><meta name="description" content="elasticsearch"><meta name="keywords" content="nest, elasticsearch, .net, client"><meta name="author" content="martijn laarman"><link rel="stylesheet" type="text/css" href="/styles/layout.css"><link rel="stylesheet" type="text/css" href="/styles/pygments.css"><link href="http://fonts.googleapis.com/css?family=Ubuntu+Mono|Ubuntu" rel="stylesheet" type="text/css"><link href="/prettify/prettify.css" type="text/css" rel="stylesheet"><link href="/prettify/sunburst.css" type="text/css" rel="stylesheet"><script src="http://code.jquery.com/jquery.min.js" type="text/javascript"></script><script type="text/javascript" src="/prettify/prettify.js"></script><script type="text/javascript" src="/prettify/fix_code_tags.js"></script></head><body><section id="site"><div class="actions"><iframe src="http://ghbtns.com/github-btn.html?user=Mpdreamz&amp;repo=NEST&amp;type=fork&amp;count=true" allowtransparency="true" frameborder="0" scrolling="0" width="95" height="20"></iframe><iframe src="http://ghbtns.com/github-btn.html?user=Mpdreamz&amp;repo=NEST&amp;type=watch&amp;count=true" allowtransparency="true" frameborder="0" scrolling="0" width="110" height="20"></iframe></div><aside><ul id="top_left_menu"><h4>External</h4><li><a href="http://www.elasticsearch.org" target="_blank">Elasticsearch Docs</a></li><li><a href="http://mpdreamz.mit-license.org/" target="_blank">MIT license</a></li></ul></aside><section id="content"><aside id="menu"><ul id="top_left_menu"><li><a href="/">+ Concepts</a></li><li><a href="/core/" class="">+ Core</a></li><li><a href="/indices/aliases.html" class="">+ Indices</a></li><h4>- Cluster</h4><ul><li><a href="/cluster/health.html" class="">Health</a></li><li><a href="/cluster/state.html" class="">State</a></li><li><a href="/cluster/update-settings.html" class="">Update Settings</a></li><li><a href="/cluster/nodes-info.html" class="selected">Nodes Info</a></li><li><a href="/cluster/nodes-stats.html" class="">Nodes Stats</a></li><li><a href="/cluster/nodes-shutdown.html" class="">Nodes Shutdown</a></li></ul><li><a href="/search/basics.html" class="">+ Search</a></li><li><a href="/facets/handling.html" class="">+ Facets</a></li><li><a href="/query/text.html" class="">+ Query DSL</a></li><li><a href="/filter/and.html" class="">+ Filter DSL</a></li></ul></aside><article><div id="content-margin-fix"><h1>Nodes info</h1>
+<html><head><title>Nest - Connecting</title><meta http-equiv="cache-control" content="no-cache"/><meta http-equiv="pragma" content="no-cache"/><meta http-equiv="content-type" content="text/html;charset=utf-8"/><meta http-equiv="expires" content="0"/><meta name="description" content="elasticsearch"/><meta name="keywords" content="nest, elasticsearch, .net, client"/><meta name="author" content="martijn laarman"/><link rel="stylesheet" type="text/css" href="/styles/layout.css"/><link rel="stylesheet" type="text/css" href="/styles/pygments.css"/><link href="http://fonts.googleapis.com/css?family=Ubuntu+Mono|Ubuntu" rel="stylesheet" type="text/css"/><link href="/prettify/prettify.css" type="text/css" rel="stylesheet"/><link href="/prettify/sunburst.css" type="text/css" rel="stylesheet"/><script src="http://code.jquery.com/jquery.min.js" type="text/javascript"></script><script type="text/javascript" src="/prettify/prettify.js"></script><script type="text/javascript" src="/prettify/fix_code_tags.js"></script></head><body><section id="site"><div class="actions"><iframe src="http://ghbtns.com/github-btn.html?user=Mpdreamz&amp;repo=NEST&amp;type=fork&amp;count=true" allowtransparency="true" frameborder="0" scrolling="0" width="95" height="20"></iframe><iframe src="http://ghbtns.com/github-btn.html?user=Mpdreamz&amp;repo=NEST&amp;type=watch&amp;count=true" allowtransparency="true" frameborder="0" scrolling="0" width="110" height="20"></iframe></div><aside><ul id="top_left_menu"><h4>External</h4><li><a href="http://www.elasticsearch.org" target="_blank">Elasticsearch Docs</a></li><li><a href="http://mpdreamz.mit-license.org/" target="_blank">MIT license</a></li></ul></aside><section id="content"><aside id="menu"><ul id="top_left_menu"><li><a href="/">+ Concepts</a></li><li><a href="/core/">+ Core</a></li><li><a href="/indices/aliases.html">+ Indices</a></li><h4>- Cluster</h4><ul><li><a href="/cluster/health.html">Health</a></li><li><a href="/cluster/state.html">State</a></li><li><a href="/cluster/update-settings.html">Update Settings</a></li><li><a href="/cluster/nodes-info.html" class="selected">Nodes Info</a></li><li><a href="/cluster/nodes-stats.html">Nodes Stats</a></li><li><a href="/cluster/nodes-shutdown.html">Nodes Shutdown</a></li></ul><li><a href="/search/basics.html">+ Search</a></li><li><a href="/facets/handling.html">+ Facets</a></li><li><a href="/query/text.html">+ Query DSL</a></li><li><a href="/filter/and.html">+ Filter DSL</a></li></ul></aside><article><div id="content-margin-fix"><h1 id="nodes-info">Nodes info</h1>
 <pre><code>var r = this._client.NodeInfo(NodesInfo.All);
-var node = r.Nodes.Values.First();</code></pre>
-<p>You can then traverse all the stats i.e:</p>
-<pre><code>node.OS.CPU.Idle</code></pre>
-</div></article></section></section></body></html>
+var node = r.Nodes.Values.First();
+</code></pre><p>You can then traverse all the stats i.e:</p>
+<pre><code>node.OS.CPU.Idle
+</code></pre></div></article></section></section></body></html>