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

Update documentation to include the indexer URLs #7058

Merged
merged 4 commits into from
Mar 1, 2024

Conversation

GabrielEValenzuela
Copy link
Member

@GabrielEValenzuela GabrielEValenzuela commented Feb 23, 2024

Description

This PR updates 4.8.0 VD and indexer release notes with the latest development changes.

Checks

Docs building

  • Compiles without warnings.

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.

@GabrielEValenzuela GabrielEValenzuela marked this pull request as ready for review February 23, 2024 17:45
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!

@javimed javimed added level/task Task issue type/bug Bug issue labels Feb 26, 2024
@javimed
Copy link
Member

javimed commented Feb 29, 2024

@GabrielEValenzuela take a look at my previous comments above.

In the server installation guide we can get rid of the note and put its text within the very step

imagen

and rephrase it. Also, a code block example might add clarity for the user.

In the PoC guide we are simply requiring to check enabled is set to yes but we aren't mentioning anything about indexer connection. We could require to check the URL is set correctly as well.

imagen

In the upgrading guide we're warning we have an incomplete guide which won't work by itself

imagen

And refer the user to a reference page which doesn't seem to be of much guidance either.

imagen

We could expand the steps rather than putting a warning note with a link.

@GabrielEValenzuela
Copy link
Member Author

Thanks @javimed ! I'm going to fix this first thing tomorrow morning!

@javimed
Copy link
Member

javimed commented Feb 29, 2024

@GabrielEValenzuela I added a commit with some suggestions of changes. I can modify them or revert them if you don't see them right. Please let me know if this is ok. Thanks

@GabrielEValenzuela
Copy link
Member Author

I agree @javimed ! Thanks for the corrections!

@javimed javimed merged commit 840402b into 4.8.0 Mar 1, 2024
@javimed javimed deleted the bug/7018_fix-indexer-documentation branch March 1, 2024 11:27
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
Development

Successfully merging this pull request may close these issues.

Improve Wazuh manager deployment to include the indexer URLs
3 participants