Describe the enhancement:
The Beats field reference docs (for example, Exported fields ) were put together before ECS came along. They need to be adapted to make sense in the context of ECS.
We need to fix this programmatically because updating the individual field.yml files manually would be crazy making. I also think the field descriptions should be single-sourced with the ECS docs rather than duplicated.
Describe a specific use case for the enhancement or feature:
When users want to understand what an event field contains, they might turn to the docs. However, it's not always easy to find field descriptions because the docs use the older field names rather than the ECSs name. Often the ECS names appear in the description. For example:
This is hard on users for a couple of reasons:
- When they scan the page, they can't find the field easily.
- It's not clear what "alias to" even means.
- There's no mention of ECS or link to the ECS docs.
We should show the ECS name. I'm not even sure it still makes sense to show the older field names, especially since the aliases are going away in 8.0.
Describe the enhancement:
The Beats field reference docs (for example, Exported fields ) were put together before ECS came along. They need to be adapted to make sense in the context of ECS.
We need to fix this programmatically because updating the individual field.yml files manually would be crazy making. I also think the field descriptions should be single-sourced with the ECS docs rather than duplicated.
Describe a specific use case for the enhancement or feature:
When users want to understand what an event field contains, they might turn to the docs. However, it's not always easy to find field descriptions because the docs use the older field names rather than the ECSs name. Often the ECS names appear in the description. For example:
This is hard on users for a couple of reasons:
We should show the ECS name. I'm not even sure it still makes sense to show the older field names, especially since the aliases are going away in 8.0.