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.

Sign up for GitHub

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

Jump to bottom

Add documentation for Wazuh Indexer Packages generation #7297

Open
wants to merge 7 commits into
base: 4.9.0
Choose a base branch
from
Open

Add documentation for Wazuh Indexer Packages generation #7297

wants to merge 7 commits into from

Conversation

f-galland
Copy link
Member

Description

This PR adds documentation for the generation of Wazuh Indexer packages.

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.

@f-galland f-galland requested a review from AlexRuiz7 May 8, 2024 19:12
@AlexRuiz7 AlexRuiz7 linked an issue May 9, 2024 that may be closed by this pull request
Document the generation of wazuh-indexer packages wazuh/wazuh-indexer#224
Open
AlexRuiz7
AlexRuiz7 requested changes May 10, 2024
View reviewed changes
Copy link
Member

@AlexRuiz7 AlexRuiz7 left a comment

Choose a reason for hiding this comment

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

We should guide the user towards the wazuh-indexer repo, instructing them to clone the repo and lead them to the appropriate folder containing the tools to build packages.

source/development/packaging/generate-indexer-package.rst Outdated Show resolved Hide resolved
source/development/packaging/generate-indexer-package.rst Outdated Show resolved Hide resolved
source/development/packaging/generate-indexer-package.rst Outdated Show resolved Hide resolved
AlexRuiz7
AlexRuiz7 previously approved these changes May 13, 2024
View reviewed changes
source/development/packaging/generate-indexer-package.rst Outdated Show resolved Hide resolved
@AlexRuiz7 AlexRuiz7 marked this pull request as ready for review May 13, 2024 15:56
@javimed javimed added level/task Task issue type/enhancement Enhancement issue labels May 14, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@AlexRuiz7 AlexRuiz7 AlexRuiz7 approved these changes

Assignees

@f-galland f-galland

Labels
level/task Task issue type/enhancement Enhancement issue
Projects
Release 4.9.0
Status: Backlog
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Document the generation of wazuh-indexer packages
3 participants
@f-galland @AlexRuiz7 @javimed