Browse Source

[DOCS] EQL: Prepare docs for release (#59259)

Changes:

* Swaps the `dev` admonitions for `experimental` admonitions
* Removes `ifdef` statements preventing the docs from appearing in
  released branches
James Rodewig 5 years ago
parent
commit
747e61508a

+ 1 - 1
docs/reference/eql/delete-async-eql-search-api.asciidoc

@@ -7,7 +7,7 @@
 <titleabbrev>Delete async EQL search</titleabbrev>
 ++++
 
-dev::[]
+experimental::[]
 
 Deletes an <<eql-search-async,async EQL search>> or a
 <<eql-search-store-sync-eql-search,stored synchronous EQL search>>. The API also

+ 1 - 1
docs/reference/eql/eql-search-api.asciidoc

@@ -7,7 +7,7 @@
 <titleabbrev>EQL search</titleabbrev>
 ++++
 
-dev::[]
+experimental::[]
 
 Returns search results for an <<eql,Event Query Language (EQL)>> query.
 

+ 1 - 1
docs/reference/eql/functions.asciidoc

@@ -6,7 +6,7 @@
 <titleabbrev>Function reference</titleabbrev>
 ++++
 
-dev::[]
+experimental::[]
 
 {es} supports the following EQL functions:
 

+ 1 - 1
docs/reference/eql/get-async-eql-search-api.asciidoc

@@ -7,7 +7,7 @@
 <titleabbrev>Get async EQL search</titleabbrev>
 ++++
 
-dev::[]
+experimental::[]
 
 Returns the current status and available results for an <<eql-search-async,async
 EQL search>> or a <<eql-search-store-sync-eql-search,stored synchronous EQL

+ 1 - 1
docs/reference/eql/index.asciidoc

@@ -6,7 +6,7 @@
 <titleabbrev>EQL</titleabbrev>
 ++++
 
-dev::[]
+experimental::[]
 
 {eql-ref}/index.html[Event Query Language (EQL)] is a query language used for
 logs and other event-based data.

+ 1 - 1
docs/reference/eql/limitations.asciidoc

@@ -6,7 +6,7 @@
 <titleabbrev>Limitations</titleabbrev>
 ++++
 
-dev::[]
+experimental::[]
 
 [discrete]
 [[eql-nested-fields]]

+ 1 - 1
docs/reference/eql/pipes.asciidoc

@@ -6,7 +6,7 @@
 <titleabbrev>Pipe reference</titleabbrev>
 ++++
 
-dev::[]
+experimental::[]
 
 {es} supports the following EQL pipes:
 

+ 1 - 1
docs/reference/eql/requirements.asciidoc

@@ -6,7 +6,7 @@
 <titleabbrev>Requirements</titleabbrev>
 ++++
 
-dev::[]
+experimental::[]
 
 EQL is schema-less and works well with most common log formats.
 

+ 1 - 1
docs/reference/eql/search.asciidoc

@@ -3,7 +3,7 @@
 [[eql-search]]
 == Run an EQL search
 
-dev::[]
+experimental::[]
 
 To start using EQL in {es}, first ensure your event data meets
 <<eql-requirements,EQL requirements>>. You can then use the <<eql-search-api,EQL

+ 1 - 1
docs/reference/eql/syntax.asciidoc

@@ -6,7 +6,7 @@
 <titleabbrev>Syntax reference</titleabbrev>
 ++++
 
-dev::[]
+experimental::[]
 
 [IMPORTANT]
 ====

+ 0 - 2
docs/reference/index.asciidoc

@@ -25,9 +25,7 @@ include::search/index.asciidoc[]
 
 include::query-dsl.asciidoc[]
 
-ifdef::permanently-unreleased-branch[]
 include::eql/index.asciidoc[]
-endif::[]
 
 include::sql/index.asciidoc[]
 

+ 0 - 4
docs/reference/search.asciidoc

@@ -168,16 +168,12 @@ include::search/suggesters.asciidoc[]
 
 include::search/multi-search.asciidoc[]
 
-ifdef::permanently-unreleased-branch[]
-
 include::eql/eql-search-api.asciidoc[]
 
 include::eql/get-async-eql-search-api.asciidoc[]
 
 include::eql/delete-async-eql-search-api.asciidoc[]
 
-endif::[]
-
 include::search/count.asciidoc[]
 
 include::search/validate.asciidoc[]