Skip to content

Commit

Permalink
Artifacts docs page (#1189)
Browse files Browse the repository at this point in the history
  • Loading branch information
ebeahan authored Dec 15, 2020
1 parent 583b6df commit 0954a5f
Show file tree
Hide file tree
Showing 5 changed files with 12 additions and 1 deletion.
1 change: 1 addition & 0 deletions CHANGELOG.next.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,6 +54,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

Expand Down
2 changes: 2 additions & 0 deletions docs/additional.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,10 @@
* <<ecs-faq>>
* <<ecs-glossary>>
* <<ecs-contributing>>
* <<ecs-artifacts>>

// include::use-cases.asciidoc[]
include::faq.asciidoc[]
include::glossary.asciidoc[]
include::contributing.asciidoc[]
include::artifacts.asciidoc[]
6 changes: 6 additions & 0 deletions docs/artifacts.asciidoc
Original file line number Diff line number Diff line change
@@ -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.
2 changes: 2 additions & 0 deletions docs/index.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
2 changes: 1 addition & 1 deletion docs/using-conventions.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -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 <<ecs-artifacts, ECS index template>> 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.

Expand Down

0 comments on commit 0954a5f

Please sign in to comment.