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

Improve ECS documentation #321

Open
3 tasks
Tracked by #22887
AlexRuiz7 opened this issue Mar 13, 2025 · 0 comments
Open
3 tasks
Tracked by #22887

Improve ECS documentation #321

AlexRuiz7 opened this issue Mar 13, 2025 · 0 comments
Assignees
Labels
level/task Task issue type/change Change performed in a resource or Wazuh Cloud environment type/enhancement Enhancement issue

Comments

@AlexRuiz7
Copy link
Member

AlexRuiz7 commented Mar 13, 2025

Description

Currently, our documentation for the indices and index templates are hosted in ecs/docs in Markdown format. Although this was useful during the first steps of the development of the Data Persistence Model redesign objective, it requires strong maintenance work each time we add any change to the indices. However, the ECS generator tool generates, along the index templates, CSV files that we can use as documentation. By including these files to the repository, and by adapting the ECS generator automation scripts and workflow, we can fully automate the generation of the indices templates and the documentation.

Functional requirements

  • The documentation for the indexes are generated automatically.
  • The documentation is updated each time an index definition is changed.
  • The documentation is in CSV format.

Implementation restrictions

  • Extend the existing automation to build the documentation.

Plan

  • Create a sub-folder for each of the indices. Within each folder, there is a README.md with basic information about the index a fields.csv file.
  • Update the automation to update the fields.csv accordingly on changes.
  • Clear the ecs/docs folder.
@AlexRuiz7 AlexRuiz7 changed the title Improve ECS documentation. Improve ECS documentation Mar 13, 2025
@AlexRuiz7 AlexRuiz7 added level/task Task issue type/change Change performed in a resource or Wazuh Cloud environment type/enhancement Enhancement issue labels Mar 13, 2025
@wazuhci wazuhci moved this to Backlog in XDR+SIEM/Release 5.0.0 Mar 13, 2025
@wazuhci wazuhci moved this from Backlog to In progress in XDR+SIEM/Release 5.0.0 Mar 14, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
level/task Task issue type/change Change performed in a resource or Wazuh Cloud environment type/enhancement Enhancement issue
Projects
Status: In progress
Development

No branches or pull requests

2 participants