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

Migrate documentation to the new documentation system #277

Open
4 tasks
AlexRuiz7 opened this issue Feb 14, 2025 · 0 comments · May be fixed by #280
Open
4 tasks

Migrate documentation to the new documentation system #277

AlexRuiz7 opened this issue Feb 14, 2025 · 0 comments · May be fixed by #280
Assignees
Labels
level/task Task issue type/enhancement Enhancement issue

Comments

@AlexRuiz7
Copy link
Member

AlexRuiz7 commented Feb 14, 2025

Description

Following the initialization of the new documentation system (#254), we need to start migrating our documentation to this new system based on mdbookand Markdown format.

During the initialization, a set of Markdown files were created under the docs/ folder. The goal of this issue is to fill these documents with the existing documentation, currently stored on Drive and READMEs scattered across the repositories.

Functional requirements

  • The Markdown files under the docs/ folder are filled with appropriate documentation.

Implementation restrictions

  • mdbook must be used.

Plan

  • Migrate development documentation.
  • Migrate reference manual.
  • Redact new sections that may not exist in the current documentation.
  • Improve ECS documentation.
@AlexRuiz7 AlexRuiz7 added level/task Task issue type/enhancement Enhancement issue labels Feb 14, 2025
@wazuhci wazuhci moved this to Backlog in XDR+SIEM/Release 5.0.0 Feb 14, 2025
@abbonno abbonno self-assigned this Feb 14, 2025
@Jorgesnchz Jorgesnchz assigned Jorgesnchz and unassigned abbonno Feb 14, 2025
@abbonno abbonno self-assigned this Feb 14, 2025
@wazuhci wazuhci moved this from Backlog to In progress in XDR+SIEM/Release 5.0.0 Feb 14, 2025
@abbonno abbonno linked a pull request Feb 14, 2025 that will close this issue
4 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
level/task Task issue type/enhancement Enhancement issue
Projects
Status: In progress
Development

Successfully merging a pull request may close this issue.

3 participants