From 3aefbbd0e5dc43d9fb5dd5b840beff34e35a9b53 Mon Sep 17 00:00:00 2001 From: spalger Date: Mon, 19 Oct 2015 08:04:14 -0700 Subject: [PATCH] [docs] added info about the http-aws-es extension --- docs/extending_core_components.asciidoc | 2 ++ docs/extensions.asciidoc | 11 +++++++++++ docs/index.asciidoc | 2 ++ 3 files changed, 15 insertions(+) create mode 100644 docs/extensions.asciidoc diff --git a/docs/extending_core_components.asciidoc b/docs/extending_core_components.asciidoc index f80449c7b..749c9a24c 100644 --- a/docs/extending_core_components.asciidoc +++ b/docs/extending_core_components.asciidoc @@ -2,6 +2,8 @@ == Extending We decided to make this client low-level, and as such we probably have not implemented all the features you are looking for. For this reason, we made extending or even replacing the core components simple. +Check out the <> page for a list of known extensions. + === Connection Extending a connection provides the powerful ability to change requests as they go out to the ElasticSearch REST API. diff --git a/docs/extensions.asciidoc b/docs/extensions.asciidoc new file mode 100644 index 000000000..90af9ccaa --- /dev/null +++ b/docs/extensions.asciidoc @@ -0,0 +1,11 @@ +[[extensions]] +== Extensions + +This page aims to list useful extensions for the elasticsearch.js client provided by the elasticsearch community. If you would like to list your extension here please submit a pull request against https://github.com/elastic/elasticsearch-js/blob/master/docs/extending_core_components.asciidoc[the source code for this page]. + +For information about writing extensions, check out the <> page. + +=== http-aws-es +Makes elasticsearch-js compatible with https://aws.amazon.com/elasticsearch-service/[Amazon ES]. It uses the https://www.npmjs.com/package/aws-sdk[aws-sdk] to make signed requests to an Amazon ES endpoint. + +http-aws-es is available on https://www.npmjs.com/package/http-aws-es[npm]. diff --git a/docs/index.asciidoc b/docs/index.asciidoc index 3a5089f11..483f87a48 100644 --- a/docs/index.asciidoc +++ b/docs/index.asciidoc @@ -14,6 +14,8 @@ include::ssl_authentication.asciidoc[] include::extending_core_components.asciidoc[] +include::extensions.asciidoc[] + include::logging.asciidoc[] include::development.asciidoc[]