[druid] branch master updated: Improve doc of movingAverage (#11262)

[fr...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

frankchen pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/druid.git


The following commit(s) were added to refs/heads/master by this push:
     new e664bfd  Improve doc of movingAverage (#11262)
e664bfd is described below

commit e664bfd433c88cf78d64a5f2ecd877fc478acb70
Author: frank chen <fr...@outlook.com>
AuthorDate: Fri May 28 13:10:55 2021 +0800

    Improve doc of movingAverage (#11262)
    
    * Make doc more directive
    
    Signed-off-by: frank chen <fr...@outlook.com>
    
    * Add limitation
    
    Signed-off-by: frank chen <fr...@outlook.com>
    
    * Suppress spelling check error
---
 .../extensions-contrib/moving-average-query.md         | 18 +++++++++++++++++-
 website/.spelling                                      |  1 +
 2 files changed, 18 insertions(+), 1 deletion(-)

diff --git a/docs/development/extensions-contrib/moving-average-query.md b/docs/development/extensions-contrib/moving-average-query.md
index 9b9eff9..083d656 100644
--- a/docs/development/extensions-contrib/moving-average-query.md
+++ b/docs/development/extensions-contrib/moving-average-query.md
@@ -50,12 +50,28 @@ It runs the query in two main phases:
 
 
 ## Operations
-To use this extension, make sure to [load](../../development/extensions.md#loading-extensions) `druid-moving-average-query` only to the Broker.
+
+### Installation
+Use [pull-deps](../../operations/pull-deps.md) tool shipped with Druid to install this [extension](../../development/extensions.md#community-extensions) on all Druid broker nodes.
+
+```bash
+java -classpath "<your_druid_dir>/lib/*" org.apache.druid.cli.Main tools pull-deps -c org.apache.druid.extensions.contrib:druid-moving-average-query:{VERSION}
+```
+
+### Enabling
+After installation, to enable this extension, just add `druid-moving-average-query` to `druid.extensions.loadList` in brokers' `runtime.properties` file and then restart broker nodes.
+
+For example:
+
+```bash
+druid.extensions.loadList=["druid-moving-average-query"]
+```
 
 ## Configuration
 There are currently no configuration properties specific to Moving Average.
 
 ## Limitations
+* movingAverage is not supported by Druid router(including the Web Console), all queries should be sent to broker nodes directly.
 * movingAverage is missing support for the following groupBy properties: `subtotalsSpec`, `virtualColumns`.
 * movingAverage is missing support for the following timeseries properties: `descending`.
 * movingAverage is missing support for [SQL-compatible null handling](https://github.com/apache/druid/issues/4349) (So setting druid.generic.useDefaultValueForNull in configuration will give an error).
diff --git a/website/.spelling b/website/.spelling
index 5aed913..eeba3cb 100644
--- a/website/.spelling
+++ b/website/.spelling
@@ -584,6 +584,7 @@ longSum
 movingAverage
 postAggregations
 postAveragers
+pull-deps
  - ../docs/development/extensions-contrib/opentsdb-emitter.md
 defaultMetrics.json
 namespacePrefix

---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@druid.apache.org
For additional commands, e-mail: commits-help@druid.apache.org