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

Improving step-by-step guide for vulnerability detector #7149

Merged
merged 6 commits into from
Apr 3, 2024

Conversation

pereyra-m
Copy link
Member

@pereyra-m pereyra-m commented Mar 28, 2024

Closes #7124 , wazuh/wazuh/issues/22532

Description

This PR improves the step-by-step guide for vulnerability detector and the its connection with the indexer nodes:

  • More details were added for multi-node environments. Also, the same words and expressions than the Filebeat section were used to improve consistency

2024-03-28_01-09

  • The start of the manager was moved after the certificates deployment to avoid warning messages during the installation

2024-03-28_01-15

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.

sebasfalcone
sebasfalcone previously approved these changes Mar 28, 2024
Copy link
Member

@sebasfalcone sebasfalcone left a comment

Choose a reason for hiding this comment

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

LGTM! Looks much better

Copy link
Member

@GabrielEValenzuela GabrielEValenzuela left a comment

Choose a reason for hiding this comment

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

Great job Mati!

@sebasfalcone sebasfalcone dismissed stale reviews from GabrielEValenzuela and themself via ff24a6c April 2, 2024 11:58
- Re-phrased example
@sebasfalcone sebasfalcone force-pushed the dev-7124-improve-step-by-step-indexer-steps branch from cfb6ef0 to 1c4dbaf Compare April 2, 2024 12:01
@sebasfalcone sebasfalcone requested a review from rauldpm April 2, 2024 12:01
sebasfalcone
sebasfalcone previously approved these changes Apr 2, 2024
- Fixed typo
rauldpm
rauldpm previously approved these changes Apr 2, 2024
Copy link
Member

@rauldpm rauldpm left a comment

Choose a reason for hiding this comment

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

LGTM, @javimed please review it when you come back

sebasfalcone
sebasfalcone previously approved these changes Apr 2, 2024
@sebasfalcone sebasfalcone requested review from GabrielEValenzuela and removed request for GabrielEValenzuela April 2, 2024 12:26
@javimed javimed added level/task Task issue type/bug Bug issue labels Apr 3, 2024
@@ -1,12 +1,14 @@
.. Copyright (C) 2015, Wazuh, Inc.

By default, the host is set to localhost: ``<host>https://0.0.0.0:9200</host>``. Replace ``0.0.0.0`` with your Wazuh indexer node IP address or hostname.
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
By default, the host is set to localhost: ``<host>https://0.0.0.0:9200</host>``. Replace ``0.0.0.0`` with your Wazuh indexer node IP address or hostname.
By default, the indexer settings have one host configured. It's set to localhost as highlighted below. Replace ``0.0.0.0`` with your Wazuh indexer node IP address or hostname.

Copy link
Member Author

Choose a reason for hiding this comment

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

Done!

source/installation-guide/wazuh-server/step-by-step.rst Outdated Show resolved Hide resolved
source/installation-guide/wazuh-server/step-by-step.rst Outdated Show resolved Hide resolved
@pereyra-m pereyra-m force-pushed the dev-7124-improve-step-by-step-indexer-steps branch from 77fceb5 to 43dd71a Compare April 3, 2024 19:30
@pereyra-m pereyra-m requested a review from javimed April 3, 2024 19:31
@javimed javimed merged commit 96b5976 into 4.8.0 Apr 3, 2024
3 checks passed
@javimed javimed deleted the dev-7124-improve-step-by-step-indexer-steps branch April 3, 2024 19:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
level/task Task issue type/bug Bug issue
Projects
No open projects
Status: Done
5 participants