QADOCS tool

Introduction

qa-docs is a tool that allows you to parse documentation blocks within the wazuh-qa tests, to index that parsed data to ElasticSearch, and visualize it using a search engine via search-ui.

When it performs a parse, it generates the documentation within the temporal directory, which could be used to create the index and then visualize it.

Table of contents

• QA-DOCS tool
  • Installation guide
    • Supported OS
      • Linux dependencies
        • System dependencies
      • Windows dependencies
        • System dependencies
    • How to install qa-docs
  • Use guide
    • How to use qa-docs tool
    • Parameter restrictions
    • Examples
    • Docker deployment
  • How to document a test
    • Introduction
    • Documentation structure
    • Schema blocks
      • Module block
      • Test block
      • Remarks
    • Pre-defined values