Engine - Update Documentation and guides

[JcabreraC]

Wazuh version	Component	Install type	Install method	Platform
5.0.0	Engine	Manager	Packages	OS version

Update Documentation for Engine: Design Document, User Manual, Environment Setup

Description:

We need to update the documentation related to the Engine in the following documents:

• Design document
• User manual
• Environment setup

Additionally, we will create a template for creating decoder issues in our repository. This template will include a checklist of tasks that need to be followed to consider a decoder integration as valid.

Tasks:

1. • [ ] Design Document:
   • Review the current design document.
   • Update sections that describe the architecture, components, and workflows of the Engine.
   • Ensure that any recent changes or improvements to the Engine are documented.
2. • [ ] User Manual:
   • Revise the user manual to reflect the latest features and functionalities of the Engine.
   • Include new usage examples, configuration options, and troubleshooting tips.
3. • [ ] Environment Setup:
   • Check and update the environment setup instructions to ensure they are accurate and complete.
   • Add any new prerequisites or dependencies required for setting up the Engine.
   • Ensure the setup process is clear and easy to follow.
4. • [x] Quick Start Guide
   • Create a quick start guide to the engine to help you get started without having to read the entire user manual to start making a decoder. This manual should explain the basic operation of the engine without going into details on how to create an asset as that is the guide to integrations.
5. • [x] Integration tutorial
   • Update the integrations guide to the new engine features and functionality, from new tools like engine-test to the use of namespace, testing and the process of developing an integration.
6. • [ ] Decoder Issue Template:
   • Create a template for creating decoder issues in our repository.
   • Include a checklist of tasks that need to be followed for a decoder integration to be considered valid.
7. • [x] Complete Integration Example:
   • Document a complete example of an integration, detailing each step of the process.
8. • [ ] Migrate Documentation to Google Sites:
   • Migrate the current documentation to Google Sites to improve accessibility and collaboration.

[JcabreraC]

Update

• Revised 3 documents and divided work by priorities.
• Updated Enviroment Setup document.
• Working on new decoder creation guide.
• Work in template issue for decoders

[juliancnn]

Daily update

• Review, minor modifications and translation of the whole quick start guide
• Review, rewrite and updates to the new features, functionality and new tools (tester and engine-test) in the debug decoder (now called testing decoder) and check in dashboad section of the integrations tutorial.

[JavierBejMen]

Update

Updated Scafolding, Documentation and Security Policies section

[juliancnn]

Daily update

• User Manual: Review and update of sections (including subsections) Getting started, Operations guide. Skip The integrations catalog because it can be improved after the tutorial manual that is currently under development.
• Revision and update of the reference section, up to Parsers (within the standard library). Currently in progress

[JavierBejMen]

Update

Finished the Integration tutorial Reviewed Quick Guide Analyzing DD and User manual

[JcabreraC]

Update

• Improved syntax and explanations in documents
• Working on Enviroment Setup document
• Revised new decoder creation guide.
• Revised Quick Start Guide

[juliancnn]

Daily update

• Cross review and some change for review in Quick Start Guide
• Add testing integration to Integration tutorial
• Fix logical expression seccion on user manual