Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Artifacts docs page #1189

Merged
merged 10 commits into from
Dec 15, 2020
Merged

Artifacts docs page #1189

Show file tree
Hide file tree
Changes from 8 commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
68e7fee
add github_repo_link attribute
ebeahan Dec 11, 2020
098aa4c
add docs pages for ECS artifacts
ebeahan Dec 11, 2020
6a2e137
correct hierarchy
ebeahan Dec 11, 2020
ebda5cf
add a link
ebeahan Dec 11, 2020
9a9bda6
fix anchor
ebeahan Dec 11, 2020
c8e9b4d
tweaks
ebeahan Dec 11, 2020
e6cc940
link conventions to new page
ebeahan Dec 11, 2020
3ce9750
add changelog
ebeahan Dec 11, 2020
a266039
remove experimental wording
ebeahan Dec 14, 2020
9839e98
further reworking
ebeahan Dec 14, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions CHANGELOG.next.md
View file
Open in desktop
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
View file
Open in desktop
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[]
8 changes: 8 additions & 0 deletions docs/artifacts.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
[[ecs-artifacts]]
=== ECS Experimental Artifacts
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why call the artifacts experimental?

The tooling I consider experimental, but the reference ECS artifacts themselves.

Copy link
Member Author

@ebeahan ebeahan Dec 14, 2020 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A fair point. I was thinking too narrowly about the Elasticsearch templates being provided as an experimental starting point. The other artifacts are not.

I'll adjust the wording a bit with this in mind.


ECS maintains a collection of experimental artifacts. These artifacts are various files generated directly based on the ECS schema, such as index templates and CSV files.

The artifacts can be found in the {ecs_github_repo_link}/generated#artifacts-generated-from-ecs[ECS Github repo].

Users can generate their own custom artifacts using the project's tooling. See the ECS tooling {ecs_github_repo_link}/USAGE.md[usage documentation] for more detail.
2 changes: 2 additions & 0 deletions docs/index.asciidoc
View file
Open in desktop
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
View file
Open in desktop
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