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.

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

[docs] Link documentation to the generated index template in Github #1030

Closed
a03nikki opened this issue Oct 15, 2020 · 1 comment · Fixed by #1189
Closed

[docs] Link documentation to the generated index template in Github #1030

a03nikki opened this issue Oct 15, 2020 · 1 comment · Fixed by #1189
Labels
1.8.0 documentation enhancement New feature or request ready Issues we'd like to address in the future.

Comments

@a03nikki
Copy link

Summary:

It is not easy to discover the index template for ECS from the documentation.

Motivation:

After going through the work of matching log fields to the ECS fields for a "custom" data sources, the next step is to load an index template into Elasticsearch. In order to avoid mapping conflicts in Kibana's index patterns, Elasticsearch searches, and unexpected errors in the curated Kibana UIs, the same mappings as other ECS content needs to be used.

Detailed Design:

Add a link from the documentation to the generated index template at https://github.com/elastic/ecs/blob/master/generated/elasticsearch/7/template.json. The only reference to template is at Elastic Common Schema (ECS) Reference [1.6] » Using ECS » Conventions.

@a03nikki a03nikki added enhancement New feature or request documentation labels Oct 15, 2020
@ebeahan
Copy link
Member

ebeahan commented Oct 15, 2020

Thanks @a03nikki for opening the issue and providing this feedback.

I wonder if moving some or all the ECS tooling usage and developer docs to also being on elastic.co could be help with these type of discovery issues, similar to what's done with Beats and Kibana.

One item to note - if we start simple by adding the link to the index templates, we'll need to link to the correct version branch depending on which version of the docs we're linking from (e.g. 1.6 links to https://github.com/elastic/ecs/tree/1.6/generated/elasticsearch, 1.5 links to https://github.com/elastic/ecs/tree/1.5/generated/elasticsearch, etc.)

@ebeahan ebeahan added ready Issues we'd like to address in the future. 1.8.0 labels Oct 20, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
1.8.0 documentation enhancement New feature or request ready Issues we'd like to address in the future.
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants