Browse Source

refactor matrix agg documentation from modules to main agg section

Nicholas Knize 9 years ago
parent
commit
371c73e140

+ 7 - 0
docs/reference/aggregations.asciidoc

@@ -23,6 +23,11 @@ it is often easier to break them into three main families:
 <<search-aggregations-metrics, _Metric_>>::
 				Aggregations that keep track and compute metrics over a set of documents.
 
+<<search-aggregations-matrix, _Matrix_>>::
+                A family of aggregations that operate on multiple fields and produce a matrix result based on the
+                values extracted from the requested document fields. Unlike metric and bucket aggregations, this
+                aggregation family does not yet support scripting.
+
 <<search-aggregations-pipeline, _Pipeline_>>::
 				Aggregations that aggregate the output of other aggregations and their associated metrics
 
@@ -100,4 +105,6 @@ include::aggregations/bucket.asciidoc[]
 
 include::aggregations/pipeline.asciidoc[]
 
+include::aggregations/matrix.asciidoc[]
+
 include::aggregations/misc.asciidoc[]

+ 2 - 2
docs/reference/modules/aggregations-matrix.asciidoc → docs/reference/aggregations/matrix.asciidoc

@@ -1,4 +1,4 @@
-[[modules-aggregations-matrix]]
+[[search-aggregations-matrix]]
 == Matrix Aggregations
 
 experimental[]
@@ -6,4 +6,4 @@ experimental[]
 The aggregations in this family operate on multiple fields and produce a matrix result based on the values extracted from
 the requested document fields. Unlike metric and bucket aggregations, this aggregation family does not yet support scripting.
 
-include::aggregations/matrix/stats.asciidoc[]
+include::matrix/stats-aggregation.asciidoc[]

+ 1 - 1
docs/reference/modules/aggregations/matrix/stats.asciidoc → docs/reference/aggregations/matrix/stats-aggregation.asciidoc

@@ -1,4 +1,4 @@
-[[modules-matrix-aggregations-stats]]
+[[search-aggregations-matrix-stats-aggregation]]
 === Matrix Stats
 
 The `matrix_stats` aggregation is a numeric aggregation that computes the following statistics over a set of document fields:

+ 0 - 6
docs/reference/modules.asciidoc

@@ -18,10 +18,6 @@ These settings can be dynamically updated on a live cluster with the
 
 The modules in this section are:
 
-<<modules-aggregations-matrix,Matrix Aggregations>>::
-
-    A family of aggregations that operate on multiple document fields and produce a matrix as output.
-
 <<modules-cluster,Cluster-level routing and shard allocation>>::
 
     Settings to control where, when, and how shards are allocated to nodes.
@@ -84,8 +80,6 @@ The modules in this section are:
 --
 
 
-include::modules/aggregations-matrix.asciidoc[]
-
 include::modules/cluster.asciidoc[]
 
 include::modules/discovery.asciidoc[]