Skip to content

Commit e4cfae0

Browse files
committed
Update intro doc
1 parent 9cea57c commit e4cfae0

File tree

2 files changed

+24
-14
lines changed

2 files changed

+24
-14
lines changed

docs/intro.asciidoc

Lines changed: 12 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -22,17 +22,22 @@ You've reached the documentation page for `Elasticsearch.Net` and `NEST`, The tw
2222
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
2323
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?
2424

25-
`NEST` is a high level client that has the advantage of having mapped all the request and response objects,
26-
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
27-
<<covariant-search-results, covariant results>> and <<auto-map, auto mapping of POCOs>>. NEST internally uses and still exposes the low level `Elasticsearch.Net` client.
25+
`NEST` is a high level client that maps all requests and responses as types, and
26+
comes with a strongly typed query DSL that maps 1 to 1 with the Elasticsearch query DSL. It takes advantage of specific .NET
27+
features to provide higher level abstractions such as <<auto-map, auto mapping of CLR types>>. Internally,
28+
NEST uses and still exposes the low level `Elasticsearch.Net` client, providing access to the power of NEST and allowing
29+
users to drop down to the low level client when wishing to.
2830

2931
Please read the getting started guide for both <<elasticsearch-net,Elasticsearch.Net>> and <<nest,NEST>>.
3032

3133
[float]
32-
=== Questions, bugs, comments, requests
34+
=== Questions, bugs, comments, feature requests
3335

34-
All of these are more then welcome on the {github}/issues[github issues pages]! We try to at least reply within the same day.
36+
Bug reports and Feature requests are more than welcome on the {github}/issues[github issues pages]!
37+
We try to at least reply within the same day.
3538

36-
We also monitor question tagged with {stackoverflow}/questions/tagged/nest['nest' on stackoverflow] or
37-
{stackoverflow}/questions/tagged/elasticsearch-net['elasticsearch-net' on stackoverflow], as well as https://discuss.elastic.co[discussions on our discourse site]
39+
For more general questions and comments, we monitor questions tagged with {stackoverflow}/questions/tagged/nest[`nest`] and
40+
{stackoverflow}/questions/tagged/elasticsearch-net[`elasticsearch-net` on Stackoverflow], as well as
41+
discussions opened on our Discourse site, https://discuss.elastic.co/c/elasticsearch[discuss.elastic.co]. By mentioning
42+
`NEST` or `Elasticsearch.Net` in the title will help folks quickly identify what the question is about.
3843

src/Tests/Tests/intro.asciidoc

Lines changed: 12 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -13,16 +13,21 @@ You've reached the documentation page for `Elasticsearch.Net` and `NEST`, The tw
1313
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
1414
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?
1515

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.
16+
`NEST` is a high level client that maps all requests and responses as types, and
17+
comes with a strongly typed query DSL that maps 1 to 1 with the Elasticsearch query DSL. It takes advantage of specific .NET
18+
features to provide higher level abstractions such as <<auto-map, auto mapping of CLR types>>. Internally,
19+
NEST uses and still exposes the low level `Elasticsearch.Net` client, providing access to the power of NEST and allowing
20+
users to drop down to the low level client when wishing to.
1921

2022
Please read the getting started guide for both <<elasticsearch-net,Elasticsearch.Net>> and <<nest,NEST>>.
2123

2224
[float]
23-
=== Questions, bugs, comments, requests
25+
=== Questions, bugs, comments, feature requests
2426

25-
All of these are more then welcome on the {github}/issues[github issues pages]! We try to at least reply within the same day.
27+
Bug reports and Feature requests are more than welcome on the {github}/issues[github issues pages]!
28+
We try to at least reply within the same day.
2629

27-
We also monitor question tagged with {stackoverflow}/questions/tagged/nest['nest' on stackoverflow] or
28-
{stackoverflow}/questions/tagged/elasticsearch-net['elasticsearch-net' on stackoverflow], as well as https://discuss.elastic.co[discussions on our discourse site]
30+
For more general questions and comments, we monitor questions tagged with {stackoverflow}/questions/tagged/nest[`nest`] and
31+
{stackoverflow}/questions/tagged/elasticsearch-net[`elasticsearch-net` on Stackoverflow], as well as
32+
discussions opened on our Discourse site, https://discuss.elastic.co/c/elasticsearch[discuss.elastic.co]. By mentioning
33+
`NEST` or `Elasticsearch.Net` in the title will help folks quickly identify what the question is about.

0 commit comments

Comments
 (0)