Skip to content

Commit c583a48

Browse files
committed
now builds docs on release as well and opens a help page after installing the package in visual studio. Appearantly its web control still runs IE8 mode :( add html5shiv to make the docs somewhat readable on IE8
added init powershell scripts that open a breaking-changes page, will most likely be removed later
1 parent a2358b1 commit c583a48

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

55 files changed

+440
-128
lines changed

build/Elasticsearch.Net.Connection.Thrift.nuspec

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
<package xmlns="http://schemas.microsoft.com/packaging/2010/07/nuspec.xsd">
33
<metadata>
44
<id>Elasticsearch.Net.Connection.Thrift</id>
5-
<version>@version@</version>
5+
<version>1.0.0-beta4</version>
66
<title>Elasticsearch.Net.Connection.Thrift - Thrift support for Elasticsearch.Net</title>
77
<authors>Martijn Laarman and contributors</authors>
88
<owners>Martijn Laarman</owners>
@@ -13,7 +13,7 @@
1313
<requireLicenseAcceptance>false</requireLicenseAcceptance>
1414
<description>An IConnection implementation that utilizes Apache Thrift to talk with elasticsearch</description>
1515
<dependencies>
16-
<dependency id="Elasticsearch.Net" version="@version@"/>
16+
<dependency id="Elasticsearch.Net" version="1.0.0-beta4"/>
1717
<dependency id="NetReflector" />
1818
</dependencies>
1919
<tags>elasticsearch elastic search lucene thrift nest</tags>

build/Elasticsearch.Net.nuspec

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
<package xmlns="http://schemas.microsoft.com/packaging/2010/07/nuspec.xsd">
33
<metadata>
44
<id>Elasticsearch.Net</id>
5-
<version>@version@</version>
5+
<version>1.0.0-beta4</version>
66
<title>Elasticsearch.Net - official low level elasticsearch client</title>
77
<authors>Martijn Laarman and contributors</authors>
88
<owners>Martijn Laarman</owners>
@@ -20,5 +20,6 @@
2020
<file src="output\Elasticsearch.Net\Elasticsearch.Net.dll" target="lib"/>
2121
<file src="output\Elasticsearch.Net\Elasticsearch.Net.pdb" target="lib"/>
2222
<file src="output\Elasticsearch.Net\Elasticsearch.Net.XML" target="lib"/>
23+
<file src="output\Elasticsearch.Net\init.ps1" target="tools"/>
2324
</files>
2425
</package>

build/NEST.nuspec

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
<package xmlns="http://schemas.microsoft.com/packaging/2010/07/nuspec.xsd">
33
<metadata>
44
<id>NEST</id>
5-
<version>@version@</version>
5+
<version>1.0.0-beta4</version>
66
<title>NEST - Elasticsearch Client</title>
77
<authors>Martijn Laarman and contributors</authors>
88
<owners>Martijn Laarman</owners>
@@ -13,7 +13,7 @@
1313
<requireLicenseAcceptance>false</requireLicenseAcceptance>
1414
<description>Elasticsearch client, strongly typed interface to Elasticsearch. Fluent request builder, mapped responses and powerful query dsl. Uses and exposes Elasticsearch.Net</description>
1515
<dependencies>
16-
<dependency id="Elasticsearch.Net" version="@version@"/>
16+
<dependency id="Elasticsearch.Net" version="1.0.0-beta4"/>
1717
<dependency id="Newtonsoft.Json" version="6.0.1" />
1818
</dependencies>
1919
<tags>elasticsearch elastic search lucene nest</tags>
@@ -22,5 +22,6 @@
2222
<file src="output\Nest\Nest.dll" target="lib"/>
2323
<file src="output\Nest\Nest.pdb" target="lib"/>
2424
<file src="output\Nest\Nest.XML" target="lib"/>
25+
<file src="output\Nest\init.ps1" target="tools"/>
2526
</files>
2627
</package>

build/build.fsx

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -43,6 +43,10 @@ Target "BuildApp" (fun _ ->
4343
//Scan for xml docs and patch them to replace <inheritdoc /> with the documentation
4444
//from their interfaces
4545
!! "build/output/Nest/Nest.xml" |> Seq.iter(fun f -> PatchXmlDoc f)
46+
47+
CopyFile "build/output/Nest/init.ps1" "build/nest-init.ps1"
48+
CopyFile "build/output/Elasticsearch.Net/init.ps1" "build/elasticsearch-init.ps1"
49+
4650
)
4751

4852
Target "Test" (fun _ ->
@@ -196,6 +200,7 @@ Target "DocsPreview" (fun _ ->
196200
==> "Build"
197201

198202
"Build"
203+
==> "Docs"
199204
==> "Release"
200205

201206
"DocsPreview"

build/elasticsearch-init.ps1

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
$DTE.ItemOperations.Navigate("http://nest.azurewebsites.net/elasticsearch-net/quick-start.html")

build/nest-init.ps1

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
$DTE.ItemOperations.Navigate("http://nest.azurewebsites.net/nest/quick-start.html")

new_docs/build/elasticsearch-net/building-requests.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
<html><head><title>Nest - Building Requests</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"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" type="text/css" href="/styles/normalize.css"/><link rel="stylesheet" type="text/css" href="/styles/layout.css"/><link rel="stylesheet" type="text/css" href="/styles/pygments.css"/><link rel="stylesheet" type="text/css" href="/styles/pygments.css"/><link rel="stylesheet" type="text/css" href="//netdna.bootstrapcdn.com/font-awesome/4.0.3/css/font-awesome.css"/><link href="//fonts.googleapis.com/css?family=Ubuntu+Mono|Open+Sans" 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="//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><div class="wrapper"><header class="header"><div class="actions"><iframe src="//ghbtns.com/github-btn.html?user=elasticsearch&amp;repo=elasticsearch-net&amp;type=fork&amp;count=true" allowtransparency="true" frameborder="0" scrolling="0" width="95" height="20"></iframe><iframe src="//ghbtns.com/github-btn.html?user=elasticsearch&amp;repo=elasticsearch-net&amp;type=watch&amp;count=true" allowtransparency="true" frameborder="0" scrolling="0" width="110" height="20"></iframe></div><img src="/images/elasticsearch-net-nuget-icon.png" width="48" height="48"/><h1>Elasticsearch.Net </h1><p>Documentation</p></header><div class="divide"></div><div class="middle"><div class="container"><main class="content"><h1 id="building-requests">Building Requests</h1>
2-
<p>This section decribes how to build requests to elasticsearch.</p>
2+
<p>This section decribes how to build requests to Elasticsearch.</p>
33
<h2 id="calling-an-api-endpoint">Calling an API endpoint</h2>
44
<p><code>Elasticsearch.Net</code> maps <strong>all</strong> the <code>Elasticsearch</code> API endpoints to methods. The reason it can do this is because all these methods are generated from
55
<a href="https://github.com/elasticsearch/elasticsearch/tree/master/rest-api-spec/api">the official client rest specification</a>. This specification documents all

new_docs/build/elasticsearch-net/cluster-failover.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
<html><head><title>Nest - Cluster Failover</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"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" type="text/css" href="/styles/normalize.css"/><link rel="stylesheet" type="text/css" href="/styles/layout.css"/><link rel="stylesheet" type="text/css" href="/styles/pygments.css"/><link rel="stylesheet" type="text/css" href="/styles/pygments.css"/><link rel="stylesheet" type="text/css" href="//netdna.bootstrapcdn.com/font-awesome/4.0.3/css/font-awesome.css"/><link href="//fonts.googleapis.com/css?family=Ubuntu+Mono|Open+Sans" 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="//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><div class="wrapper"><header class="header"><div class="actions"><iframe src="//ghbtns.com/github-btn.html?user=elasticsearch&amp;repo=elasticsearch-net&amp;type=fork&amp;count=true" allowtransparency="true" frameborder="0" scrolling="0" width="95" height="20"></iframe><iframe src="//ghbtns.com/github-btn.html?user=elasticsearch&amp;repo=elasticsearch-net&amp;type=watch&amp;count=true" allowtransparency="true" frameborder="0" scrolling="0" width="110" height="20"></iframe></div><img src="/images/elasticsearch-net-nuget-icon.png" width="48" height="48"/><h1>Elasticsearch.Net </h1><p>Documentation</p></header><div class="divide"></div><div class="middle"><div class="container"><main class="content"><h1 id="connection-pooling-cluster-failover">Connection pooling &amp; Cluster failover</h1>
2-
<p>One of the major benefits of <code>elasticsearch</code> is that it can handle dying and respawning nodes.
2+
<p>One of the major benefits of <code>Elasticsearch</code> is that it can handle dying and respawning nodes.
33
As long as enough nodes agree that the cluster is healthy, the cluster will continue to operate.
44
<code>Elasticsearch.net</code> comes with builtin support to handle falling over to a different node when the requested node failed.</p>
55
<h2 id="configuring">Configuring</h2>
@@ -21,7 +21,7 @@ <h4 id="setdeadtimeout-">SetDeadTimeout()</h4>
2121
<h4 id="setmaxdeadtimeout-">SetMaxDeadTimeout()</h4>
2222
<p>Sets the maximum time a node may be marked dead.</p>
2323
<h4 id="disablepings-">DisablePings()</h4>
24-
<p>By default before a previously dead node is retried a short ping will be send to the node to make sure the node will respond.
24+
<p>By default before a previously dead node is retried a short ping will be sent to the node to make sure the node will respond.
2525
The reason for a separate call is that a ping will call an elasticsearch endpoint that won&#39;t stress the JVM. If a node is having issues retrying a possible heavy search operation on it might cause the request to fail later rather then asap. This setting allows you to disable these pings before retries.</p>
2626
<h4 id="setmaxretries-int-retries-">SetMaxRetries(int retries)</h4>
2727
<p>By default an <code>IConnectionPool</code> itself will decide how many times to retry (usually all the registered nodes) if you wish to
Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
<html><head><title>Nest - Quick Start</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"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" type="text/css" href="/styles/normalize.css"/><link rel="stylesheet" type="text/css" href="/styles/layout.css"/><link rel="stylesheet" type="text/css" href="/styles/pygments.css"/><link rel="stylesheet" type="text/css" href="/styles/pygments.css"/><link rel="stylesheet" type="text/css" href="//netdna.bootstrapcdn.com/font-awesome/4.0.3/css/font-awesome.css"/><link href="//fonts.googleapis.com/css?family=Ubuntu+Mono|Open+Sans" 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="//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><div class="wrapper"><header class="header"><div class="actions"><iframe src="//ghbtns.com/github-btn.html?user=elasticsearch&amp;repo=elasticsearch-net&amp;type=fork&amp;count=true" allowtransparency="true" frameborder="0" scrolling="0" width="95" height="20"></iframe><iframe src="//ghbtns.com/github-btn.html?user=elasticsearch&amp;repo=elasticsearch-net&amp;type=watch&amp;count=true" allowtransparency="true" frameborder="0" scrolling="0" width="110" height="20"></iframe></div><img src="/images/elasticsearch-net-nuget-icon.png" width="48" height="48"/><h1>Elasticsearch.Net </h1><p>Documentation</p></header><div class="divide"></div><div class="middle"><div class="container"><main class="content"><h1 id="errors">Errors</h1>
2-
<p><code>Elasticsearch.Net</code> will not throw if gets a http response other then 200 from Elasticsearch. The response object&#39;s <code>Success</code> property will be false and <code>.Error</code> will contain information on the failed response.</p>
2+
<p><code>Elasticsearch.Net</code> will not throw if it gets an http response other then 200 from Elasticsearch. The response object&#39;s <code>Success</code> property will be false and <code>.Error</code> will contain information on the failed response.</p>
33
<p>You can throw custom exceptions if you need too by specifying a custom connectionhandler</p>
44
<pre><code>var settings = new ConnectionConfiguration()
55
.SetConnectionStatusHandler(r=&gt; {
66
if (r.HttpStatusCode == 403)
77
throw new MyApplicationNotLoggedInException();
88
});
99
</code></pre><h2 id="exceptions">Exceptions</h2>
10-
<p>If a request has been retried the maximum amount of times a <code>MaxRetryException</code> is thrown. Note that requests are only retried when elasticsearch responds with a <code>503</code> or an unspecified connection exception (i.e timeout) occured on a node. </p>
10+
<p>If a request has been retried the maximum amount of times a <code>MaxRetryException</code> is thrown. Note that requests are only retried when elasticsearch responds with a <code>503</code> or an unspecified connection exception (i.e timeout) has occured on a node. </p>
1111
<p><code>MaxRetryException</code> will hold the original exception as <code>.InnerException</code>.</p>
1212
</main></div><aside class="left-sidebar"><aside id="menu"><ul><li><a href="/">Home</a></li></ul><ul id="elasticsearch-net"><h4 class="title">Elasticsearch.Net</h4><ul><li><a href="/elasticsearch-net/quick-start.html">Quick Start</a></li><li><a href="/elasticsearch-net/connecting.html">Connecting</a></li><li><a href="/elasticsearch-net/cluster-failover.html">Cluster failover</a></li><li><a href="/elasticsearch-net/building-requests.html">Building requests</a></li><li><a href="/elasticsearch-net/handling-responses.html">Handling responses</a></li><li><a href="/elasticsearch-net/errors.html" class="selected">Errors</a></li></ul></ul><ul id="nest"><h4 class="title">NEST</h4><ul><li><a href="/nest/quick-start.html">Quick Start</a></li><li><a href="/nest/connecting.html">Connecting</a></li><li><a href="/nest/index-type-inference.html">Type/Index Inference</a></li><li><a href="/nest/handling-responses.html">Handling responses</a></li><li><a href="/nest/writing-queries.html">Writing queries</a></li></ul><li><h4><a href="/nest/core/"><i class="fa fa-chevron-right"></i>Core</a></h4></li><li><h4><a href="/nest/indices/aliases.html"><i class="fa fa-chevron-right"></i>Indices</a></h4></li><li><h4><a href="/nest/cluster/health.html"><i class="fa fa-chevron-right"></i>Cluster</a></h4></li><li><h4><a href="/nest/search/basics.html"><i class="fa fa-chevron-right"></i>Search</a></h4></li><li><h4><a href="/nest/facets/handling.html"><i class="fa fa-chevron-right"></i>Facets</a></h4></li><li><h4><a href="/nest/query/text.html"><i class="fa fa-chevron-right"></i>Query DSL</a></h4></li><li><h4><a href="/nest/filter/and.html"><i class="fa fa-chevron-right"></i>Filter DSL</a></h4></li></ul></aside></aside></div><footer class="footer"></footer></div></body></html>

new_docs/build/elasticsearch-net/quick-start.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
<html><head><title>Nest - Quick Start</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"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" type="text/css" href="/styles/normalize.css"/><link rel="stylesheet" type="text/css" href="/styles/layout.css"/><link rel="stylesheet" type="text/css" href="/styles/pygments.css"/><link rel="stylesheet" type="text/css" href="/styles/pygments.css"/><link rel="stylesheet" type="text/css" href="//netdna.bootstrapcdn.com/font-awesome/4.0.3/css/font-awesome.css"/><link href="//fonts.googleapis.com/css?family=Ubuntu+Mono|Open+Sans" 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="//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><div class="wrapper"><header class="header"><div class="actions"><iframe src="//ghbtns.com/github-btn.html?user=elasticsearch&amp;repo=elasticsearch-net&amp;type=fork&amp;count=true" allowtransparency="true" frameborder="0" scrolling="0" width="95" height="20"></iframe><iframe src="//ghbtns.com/github-btn.html?user=elasticsearch&amp;repo=elasticsearch-net&amp;type=watch&amp;count=true" allowtransparency="true" frameborder="0" scrolling="0" width="110" height="20"></iframe></div><img src="/images/elasticsearch-net-nuget-icon.png" width="48" height="48"/><h1>Elasticsearch.Net </h1><p>Documentation</p></header><div class="divide"></div><div class="middle"><div class="container"><main class="content"><h1 id="quick-start">Quick Start</h1>
2-
<p><code>Elasticsearch.Net</code> is a low level client to talk to elasticsearch.</p>
2+
<p><code>Elasticsearch.Net</code> is a low level client to talk to Elasticsearch.</p>
33
<h2 id="installing">Installing</h2>
44
<p>From the package manager console inside visual studio </p>
55
<pre><code>PM &gt; Install Package Elasticsearch.Net -PreRelease

0 commit comments

Comments
 (0)