From 1cefa9353115509c789e90db6762a532d904a187 Mon Sep 17 00:00:00 2001 From: Eric Beahan Date: Tue, 15 Dec 2020 13:09:49 -0600 Subject: [PATCH] Artifacts docs page (#1189) --- CHANGELOG.next.md | 1 + docs/additional.asciidoc | 2 ++ docs/artifacts.asciidoc | 6 ++++++ docs/index.asciidoc | 2 ++ docs/using-conventions.asciidoc | 2 +- 5 files changed, 12 insertions(+), 1 deletion(-) create mode 100644 docs/artifacts.asciidoc diff --git a/CHANGELOG.next.md b/CHANGELOG.next.md index 8ca8f9e915..265e88ebf8 100644 --- a/CHANGELOG.next.md +++ b/CHANGELOG.next.md @@ -53,6 +53,7 @@ Thanks, you're awesome :-) --> * Added a notice highlighting that the `tracing` fields are not nested under the namespace `tracing.` #1162 * ES 6.x template data types will fallback to supported types. #1171, #1176, #1186 +* Add a documentation page discussing the experimental artifacts. #1189 #### Deprecated diff --git a/docs/additional.asciidoc b/docs/additional.asciidoc index d42bcfbeec..f6796174d8 100644 --- a/docs/additional.asciidoc +++ b/docs/additional.asciidoc @@ -4,8 +4,10 @@ * <> * <> * <> +* <> // include::use-cases.asciidoc[] include::faq.asciidoc[] include::glossary.asciidoc[] include::contributing.asciidoc[] +include::artifacts.asciidoc[] diff --git a/docs/artifacts.asciidoc b/docs/artifacts.asciidoc new file mode 100644 index 0000000000..77df53de17 --- /dev/null +++ b/docs/artifacts.asciidoc @@ -0,0 +1,6 @@ +[[ecs-artifacts]] +=== Generated Artifacts + +ECS maintains a collection of artifacts which are generated based on the schema. Examples include Elasticsearch index templates, CSV, and Beats field mappings. The maintained artifacts can be found in the {ecs_github_repo_link}/generated#artifacts-generated-from-ecs[ECS Github repo]. + +Users can generate custom versions of these artifacts using the ECS project's tooling. See the tooling {ecs_github_repo_link}/USAGE.md[usage documentation] for more detail. diff --git a/docs/index.asciidoc b/docs/index.asciidoc index 198abfce07..8141abcec7 100644 --- a/docs/index.asciidoc +++ b/docs/index.asciidoc @@ -5,6 +5,8 @@ include::{asciidoc-dir}/../../shared/versions/stack/current.asciidoc[] include::{asciidoc-dir}/../../shared/attributes.asciidoc[] +:ecs_github_repo_link: https://github.com/elastic/ecs/blob/master + [[ecs-reference]] == Overview diff --git a/docs/using-conventions.asciidoc b/docs/using-conventions.asciidoc index 2972a0df68..f321b26765 100644 --- a/docs/using-conventions.asciidoc +++ b/docs/using-conventions.asciidoc @@ -42,7 +42,7 @@ Elasticsearch can index text using datatypes: ===== Default Elasticsearch convention for indexing text fields Unless your index mapping or index template specifies otherwise -(as the ECS index template does), +(as the <> does), Elasticsearch indexes a text field as `text` at the canonical field name, and indexes a second time as `keyword`, nested in a multi-field.