Skip to content

Commit 746e2c8

Browse files
committed
Remove sections from docs
who's using, other resources and license sections from intro
1 parent 36bba33 commit 746e2c8

File tree

4 files changed

+29
-96
lines changed

4 files changed

+29
-96
lines changed

docs/asciidoc/client-concepts/low-level/lifetimes.asciidoc

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -7,18 +7,18 @@
77
[[lifetimes]]
88
== Lifetimes
99

10-
If you are using an IOC container its always useful to know the best practices around the lifetime of your objects
10+
If you are using an IOC container its always useful to know the best practices around the lifetime of your objects
1111

1212
In general we advise folks to register their ElasticClient instances as singletons. The client is thread safe
13-
so sharing an instance between threads is fine.
13+
so sharing an instance between threads is fine.
1414

1515
Zooming in however the actual moving part that benefits the most from being static for most of the duration of your
16-
application is `ConnectionSettings`; caches are __per__ `ConnectionSettings`.
16+
application is `ConnectionSettings`; caches are __per__ `ConnectionSettings`.
1717

1818
In some applications it could make perfect sense to have multiple singleton `ElasticClient`'s registered with different
1919
connection settings. e.g if you have 2 functionally isolated Elasticsearch clusters.
2020

21-
NOTE: Due to the semantic versioning of Elasticsearch.Net and NEST and their alignment to versions of Elasticsearch, all instances of `ElasticClient` and
21+
IMPORTANT: Due to the semantic versioning of Elasticsearch.Net and NEST and their alignment to versions of Elasticsearch, all instances of `ElasticClient` and
2222
Elasticsearch clusters that are connected to must be on the **same major version** i.e. it is not possible to have both an `ElasticClient` to connect to
2323
Elasticsearch 1.x _and_ 2.x in the same application as the former would require NEST 1.x and the latter, NEST 2.x.
2424

@@ -74,7 +74,7 @@ connectionPool.IsDisposed.Should().BeFalse();
7474
connection.IsDisposed.Should().BeFalse();
7575
----
7676

77-
Disposing `ConnectionSettings` will dispose the `IConnectionPool` and `IConnection` it has a hold of
77+
Disposing `ConnectionSettings` will also dispose the `IConnectionPool` and `IConnection` it uses
7878

7979
[source,csharp]
8080
----

docs/asciidoc/intro.asciidoc

Lines changed: 9 additions & 43 deletions
Original file line numberDiff line numberDiff line change
@@ -5,33 +5,19 @@
55
[[introduction]]
66
== Introduction
77

8-
You've reached the documentation page for `Elasticsearch.Net` and `NEST`. The two official .NET clients for Elasticsearch. So why two clients I hear you say?
8+
You've reached the documentation page for `Elasticsearch.Net` and `NEST`, The two official .NET clients for Elasticsearch.
99

10-
`Elasticsearch.Net` is a very low level, dependency free, client that has no opinions about how you build and represent your requests and responses. It has abstracted
11-
enough so that **all** the Elasticsearch API endpoints are represented as methods but not too much to get in the way of how you want to build your json/request/response objects. It also comes with builtin, configurable/overridable, cluster failover retry mechanisms. Elasticsearch is elastic so why not your client?
12-
13-
`NEST` is a high level client that has the advantage of having mapped all the request and response objects, comes with a strongly typed query DSL that maps 1 to 1 with the Elasticsearch query DSL, and takes advantage of specific .NET features such as covariant results. NEST internally uses, and still exposes, the low level `Elasticsearch.Net` client.
14-
15-
Please read the getting started guide for both.
16-
17-
=== Who's using Nest
18-
19-
* {stackoverflow}[stackoverflow.com] (and the rest of the stackexchange family).
20-
21-
* http://www.7digital.com[7digital.com] (run NEST on mono).
22-
23-
* https://www.rijksmuseum.nl/en[rijksmuseum.nl] (Elasticsearch is the only datastorage hit for each page).
24-
25-
* http://www.fogcreek.com/kiln/[Kiln] FogCreek's version control & code review tooling.
26-
They are so pleased with Elasticsearch that http://blog.fogcreek.com/kiln-powered-by-elasticsearch/[they made a video about how pleased they are!]
10+
=== Why two clients?
2711

28-
=== Other resources
12+
`Elasticsearch.Net` is a very low level, dependency free, client that has no opinions about how you build and represent your requests and responses. It has abstracted
13+
enough so that **all** the Elasticsearch API endpoints are represented as methods but not too much to get in the way of how you want to build
14+
your json/request/response objects. It also comes with built in, configurable/overridable, cluster failover retry mechanisms. Elasticsearch is _elastic_ so why not your client?
2915

30-
http://twitter.com/joelabrahamsson[@joelabrahamsson] wrote a great http://joelabrahamsson.com/entry/extending-aspnet-mvc-music-store-with-elasticsearch[intro into elasticsearch on .NET]
31-
using NEST.
16+
`NEST` is a high level client that has the advantage of having mapped all the request and response objects,
17+
comes with a strongly typed query DSL that maps 1 to 1 with the Elasticsearch query DSL, and takes advantage of specific .NET features such as
18+
<<covariant-search-results, covariant results>> and <<auto-map, auto mapping of POCOs>>. NEST internally uses and still exposes the low level `Elasticsearch.Net` client.
3219

33-
Also checkout the https://searchbox.io/[searchbox.io guys] rocking NEST http://blog.appharbor.com/2012/06/19/searchbox-elasticsearch-is-now-an-add-on[on AppHarbor]
34-
with their https://github.com/searchbox-io/.net-sample[demo project]
20+
Please read the getting started guide for both <<elasticsearch-net,Elasticsearch.Net>> and <<nest,NEST>>.
3521

3622
=== Questions, bugs, comments, requests
3723

@@ -40,23 +26,3 @@ All of these are more then welcome on the {github}/issues[github issues pages]!
4026
We also monitor question tagged with {stackoverflow}/questions/tagged/nest['nest' on stackoverflow] or
4127
{stackoverflow}/questions/tagged/elasticsearch-net['elasticsearch-net' on stackoverflow], as well as https://discuss.elastic.co[discussions on our discourse site]
4228

43-
=== License
44-
45-
....
46-
This software is licensed under the Apache 2 license, quoted below.
47-
48-
Copyright (c) 2014 Elasticsearch <http://www.elasticsearch.org>
49-
50-
Licensed under the Apache License, Version 2.0 (the "License");
51-
you may not use this file except in compliance with the License.
52-
You may obtain a copy of the License at
53-
54-
http://www.apache.org/licenses/LICENSE-2.0
55-
56-
Unless required by applicable law or agreed to in writing, software
57-
distributed under the License is distributed on an "AS IS" BASIS,
58-
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
59-
See the License for the specific language governing permissions and
60-
limitations under the License.
61-
....
62-

src/Tests/ClientConcepts/LowLevel/Lifetimes.doc.cs

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -15,24 +15,23 @@ public class Lifetimes
1515
{
1616
/**== Lifetimes
1717
*
18-
* If you are using an IOC container its always useful to know the best practices around the lifetime of your objects
18+
* If you are using an IOC container its always useful to know the best practices around the lifetime of your objects
1919
*
2020
* In general we advise folks to register their ElasticClient instances as singletons. The client is thread safe
21-
* so sharing an instance between threads is fine.
21+
* so sharing an instance between threads is fine.
2222
*
2323
* Zooming in however the actual moving part that benefits the most from being static for most of the duration of your
24-
* application is `ConnectionSettings`; caches are __per__ `ConnectionSettings`.
24+
* application is `ConnectionSettings`; caches are __per__ `ConnectionSettings`.
2525
*
2626
* In some applications it could make perfect sense to have multiple singleton `ElasticClient`'s registered with different
2727
* connection settings. e.g if you have 2 functionally isolated Elasticsearch clusters.
2828
*
29-
* NOTE: Due to the semantic versioning of Elasticsearch.Net and NEST and their alignment to versions of Elasticsearch, all instances of `ElasticClient` and
29+
* IMPORTANT: Due to the semantic versioning of Elasticsearch.Net and NEST and their alignment to versions of Elasticsearch, all instances of `ElasticClient` and
3030
* Elasticsearch clusters that are connected to must be on the **same major version** i.e. it is not possible to have both an `ElasticClient` to connect to
3131
* Elasticsearch 1.x _and_ 2.x in the same application as the former would require NEST 1.x and the latter, NEST 2.x.
3232
*
3333
* Let's demonstrate which components are disposed by creating our own derived `ConnectionSettings`, `IConnectionPool` and `IConnection` types
3434
*/
35-
3635
class AConnectionSettings : ConnectionSettings
3736
{
3837
public AConnectionSettings(IConnectionPool pool, IConnection connection)
@@ -82,7 +81,7 @@ [U] public void InitialDisposeState()
8281
}
8382

8483
/**
85-
* Disposing `ConnectionSettings` will dispose the `IConnectionPool` and `IConnection` it has a hold of
84+
* Disposing `ConnectionSettings` will also dispose the `IConnectionPool` and `IConnection` it uses
8685
*/
8786
[U] public void DisposingSettingsDisposesMovingParts()
8887
{

src/Tests/intro.asciidoc

Lines changed: 10 additions & 42 deletions
Original file line numberDiff line numberDiff line change
@@ -4,55 +4,23 @@
44
[[introduction]]
55
== Introduction
66

7-
You've reached the documentation page for `Elasticsearch.Net` and `NEST`. The two official .NET clients for Elasticsearch. So why two clients I hear you say?
7+
You've reached the documentation page for `Elasticsearch.Net` and `NEST`, The two official .NET clients for Elasticsearch.
88

9-
`Elasticsearch.Net` is a very low level, dependency free, client that has no opinions about how you build and represent your requests and responses. It has abstracted
10-
enough so that **all** the Elasticsearch API endpoints are represented as methods but not too much to get in the way of how you want to build your json/request/response objects. It also comes with builtin, configurable/overridable, cluster failover retry mechanisms. Elasticsearch is elastic so why not your client?
11-
12-
`NEST` is a high level client that has the advantage of having mapped all the request and response objects, comes with a strongly typed query DSL that maps 1 to 1 with the Elasticsearch query DSL, and takes advantage of specific .NET features such as covariant results. NEST internally uses, and still exposes, the low level `Elasticsearch.Net` client.
13-
14-
Please read the getting started guide for both.
15-
16-
=== Who's using Nest
17-
- {stackoverflow}[stackoverflow.com] (and the rest of the stackexchange family).
18-
- http://www.7digital.com[7digital.com] (run NEST on mono).
19-
- https://www.rijksmuseum.nl/en[rijksmuseum.nl] (Elasticsearch is the only datastorage hit for each page).
20-
- http://www.fogcreek.com/kiln/[Kiln] FogCreek's version control & code review tooling.
21-
They are so pleased with Elasticsearch that http://blog.fogcreek.com/kiln-powered-by-elasticsearch/[they made a video about how pleased they are!]
9+
=== Why two clients?
2210

23-
=== Other resources
11+
`Elasticsearch.Net` is a very low level, dependency free, client that has no opinions about how you build and represent your requests and responses. It has abstracted
12+
enough so that **all** the Elasticsearch API endpoints are represented as methods but not too much to get in the way of how you want to build
13+
your json/request/response objects. It also comes with built in, configurable/overridable, cluster failover retry mechanisms. Elasticsearch is _elastic_ so why not your client?
2414

25-
http://twitter.com/joelabrahamsson[@joelabrahamsson] wrote a great http://joelabrahamsson.com/entry/extending-aspnet-mvc-music-store-with-elasticsearch[intro into elasticsearch on .NET]
26-
using NEST.
15+
`NEST` is a high level client that has the advantage of having mapped all the request and response objects,
16+
comes with a strongly typed query DSL that maps 1 to 1 with the Elasticsearch query DSL, and takes advantage of specific .NET features such as
17+
<<covariant-search-results, covariant results>> and <<auto-map, auto mapping of POCOs>>. NEST internally uses and still exposes the low level `Elasticsearch.Net` client.
2718

28-
Also checkout the https://searchbox.io/[searchbox.io guys] rocking NEST http://blog.appharbor.com/2012/06/19/searchbox-elasticsearch-is-now-an-add-on[on AppHarbor]
29-
with their https://github.com/searchbox-io/.net-sample[demo project]
19+
Please read the getting started guide for both <<elasticsearch-net,Elasticsearch.Net>> and <<nest,NEST>>.
3020

3121
=== Questions, bugs, comments, requests
3222

3323
All of these are more then welcome on the {github}/issues[github issues pages]! We try to at least reply within the same day.
3424

3525
We also monitor question tagged with {stackoverflow}/questions/tagged/nest['nest' on stackoverflow] or
36-
{stackoverflow}/questions/tagged/elasticsearch-net['elasticsearch-net' on stackoverflow], as well as https://discuss.elastic.co[discussions on our discourse site]
37-
38-
=== License
39-
40-
....
41-
This software is licensed under the Apache 2 license, quoted below.
42-
43-
Copyright (c) 2014 Elasticsearch <http://www.elasticsearch.org>
44-
45-
Licensed under the Apache License, Version 2.0 (the "License");
46-
you may not use this file except in compliance with the License.
47-
You may obtain a copy of the License at
48-
49-
http://www.apache.org/licenses/LICENSE-2.0
50-
51-
Unless required by applicable law or agreed to in writing, software
52-
distributed under the License is distributed on an "AS IS" BASIS,
53-
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
54-
See the License for the specific language governing permissions and
55-
limitations under the License.
56-
....
57-
58-
26+
{stackoverflow}/questions/tagged/elasticsearch-net['elasticsearch-net' on stackoverflow], as well as https://discuss.elastic.co[discussions on our discourse site]

0 commit comments

Comments
 (0)