wazuh-documentation icon indicating copy to clipboard operation
wazuh-documentation copied to clipboard

Centralize wazuh agent cloud modules dependencies installation

Open GGP1 opened this issue 1 year ago • 2 comments

Description

We have 3 (1, 2, 3) almost identical pages that describe the steps to install the dependencies necessary to run the cloud modules in a Wazuh agent. We often have to modify all of them to avoid setup differences.

They could be unified in a single page called something in the lines of "Wazuh agent dependencies installation" that contains:

We should review if this change makes sense or if we should keep the guides separate.

GGP1 avatar Dec 13 '23 15:12 GGP1

We could use a template and keep all those pages divided.

We can use the docutils directive include to re-use dependency installation templates containing the repeating blocks of texts with a syntax like:

.. include:: _templates/.../dependency1_template.rst

For example, we do currently use templates with steps to add the Wazuh repository for the different installation alternatives like here:

  • https://github.com/wazuh/wazuh-documentation/blob/v4.7.1/source/installation-guide/wazuh-indexer/step-by-step.rst?plain=1#L103-L119
    • https://github.com/wazuh/wazuh-documentation/blob/v4.7.1/source/_templates/installations/common/yum/add-repository.rst?plain=1
    • https://github.com/wazuh/wazuh-documentation/blob/v4.7.1/source/_templates/installations/common/deb/add-repository.rst?plain=1

What do you think of this alternative approach? It allows keeping dedicated pages while avoiding maintaining multiple copies of the same blocks. In our case we could use a pyhton3 installation template and a pip installation template.

javimed avatar Dec 22 '23 18:12 javimed

Update

Added templates for the python and pip installations as suggested by the documentation team. The PR also includes some changes to eliminate style and spelling differences between the documents.

GGP1 avatar May 09 '24 13:05 GGP1

Update

Applied the changes suggested and explained why the template does not contain part of the text repeated.

GGP1 avatar May 14 '24 13:05 GGP1

Update

Applied suggested changes.

GGP1 avatar May 15 '24 12:05 GGP1