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

Centralize wazuh agent cloud modules dependencies installation #6849

Closed
GGP1 opened this issue Dec 13, 2023 · 4 comments · Fixed by #7298
Closed

Centralize wazuh agent cloud modules dependencies installation #6849

GGP1 opened this issue Dec 13, 2023 · 4 comments · Fixed by #7298
Assignees
Labels
level/task Task issue type/enhancement Enhancement issue

Comments

@GGP1
Copy link
Member

GGP1 commented Dec 13, 2023

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 GGP1 added level/task Task issue type/enhancement Enhancement issue labels Dec 13, 2023
@javimed
Copy link
Member

javimed commented Dec 22, 2023

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:

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.

@GGP1 GGP1 self-assigned this May 7, 2024
@GGP1 GGP1 linked a pull request May 9, 2024 that will close this issue
7 tasks
@GGP1
Copy link
Member Author

GGP1 commented May 9, 2024

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
Copy link
Member Author

GGP1 commented May 14, 2024

Update

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

@wazuhci wazuhci moved this to On hold in Release 4.9.0 May 15, 2024
@GGP1
Copy link
Member Author

GGP1 commented May 15, 2024

Update

Applied suggested changes.

@wazuhci wazuhci moved this from On hold to Pending final review in Release 4.9.0 May 15, 2024
@wazuhci wazuhci moved this from Pending final review to On hold in Release 4.9.0 May 15, 2024
@wazuhci wazuhci moved this from On hold to Pending final review in Release 4.9.0 May 15, 2024
@wazuhci wazuhci moved this from Pending final review to Done in Release 4.9.0 May 16, 2024
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
No open projects
Status: Done
Development

Successfully merging a pull request may close this issue.

3 participants