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

Improved offline installation steps #6686

Conversation

davidcr01
Copy link
Contributor

Description

Related: wazuh/wazuh-packages#1874
The aim of this PR is to change the offline installation steps of the documentation.

The ./wazuh-install.sh -dw <deb|rpm> command may lead to confusion. So it is split into two alternatives.

Checks

Docs building

  • Compiles without warnings.

Code formatting and web optimization

  • Uses three spaces indentation.
  • Adds or updates meta descriptions accordingly.
  • Updates the redirects.js script if necessary (check this guide).

Writing style

  • Uses present tense, active voice, and semi-formal registry.
  • Uses short, simple sentences.
  • Uses bold for user interface elements, italics for key terms or emphasis, and code font for Bash commands, file names, REST paths, and code.

@@ -22,13 +22,24 @@ Prerequisites
Download the packages and configuration files
---------------------------------------------

#. Replace ``<deb|rpm>`` in the following command with your choice of package format and run it from a Linux system with Internet connection. This action executes a script that downloads all required files for the offline installation on x86_64 architectures.
#. Run the following commands with your choice and execute them from a Linux system with Internet connection. This action executes a script that downloads all required files for the offline installation on x86_64 architectures.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggestion for:

Run the following commands with your choice and execute them from a Linux system with Internet connection

Change it to:

Run the following commands with your choice from a Linux system with Internet connection

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done in bae4dcc.


.. code-block:: console

# curl -sO https://packages.wazuh.com/|WAZUH_CURRENT_MINOR|/wazuh-install.sh
# chmod 744 wazuh-install.sh
# ./wazuh-install.sh -dw <deb|rpm>

If your system is RPM-based, run the following command:
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We can change this section to use tabs for RPM and Debian options.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done in bae4dcc.

@javimed javimed added level/task Task issue type/enhancement Enhancement issue labels Oct 25, 2023
@davidcr01 davidcr01 force-pushed the bug/1874-wazuh-install-offline-must-improve-the-argument-management-when-selecting-rpm-or-deb branch from aec5995 to bae4dcc Compare October 26, 2023 08:13
@davidcr01 davidcr01 force-pushed the bug/1874-wazuh-install-offline-must-improve-the-argument-management-when-selecting-rpm-or-deb branch from 0ed5d8a to b2ec947 Compare October 27, 2023 13:01
@javimed javimed merged commit 6de9313 into 4.7.1 Oct 27, 2023
@javimed javimed deleted the bug/1874-wazuh-install-offline-must-improve-the-argument-management-when-selecting-rpm-or-deb branch October 27, 2023 13:06
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 this pull request may close these issues.

wazuh-install.sh offline must improve the argument management when selecting rpm or deb
4 participants