Add documentation for Wazuh Indexer Packages generation #7297
Conversation
There was a problem hiding this comment.
Please add a new entry in redirects.js for the new generate-indexer-package page. For example:
/* Pages added in 4.9 */
newUrls['4.9'] = [
'/release-notes/release-4-9-0.html',
'/deployment-options/offline-installation/index.html',
'/deployment-options/offline-installation/step-by-step.html',
'/deployment-options/offline-installation/installation-assistant.html',
'/development/packaging/generate-indexer-package.html',
];
/* Pages no longer available in 4.9 */
| ============= | ||
| Wazuh Indexer | ||
| ============= |
There was a problem hiding this comment.
Please include the copyright notice and a meta description for search engines. For example
.. Copyright (C) 2015, Wazuh, Inc.
.. meta::
:description: Wazuh provides an automated way of building packages for the Wazuh components. Learn how to build your own Wazuh indeer package in this section of our documentation.
Wazuh Indexer
=============
There was a problem hiding this comment.
Please don't break sentences in multiple lines use one line paragraphs. For example
The packages' generation process is orchestrated by two scripts, which are found within the ``packaging_scripts`` folder of the repository:
| .. tabs:: | ||
|
|
||
| .. group-tab:: RPM | ||
| .. code-block:: console | ||
|
|
||
| # docker exec -it wi-build_|WAZUH_CURRENT| bash packaging_scripts/build.sh -a x64 -d rpm | ||
|
|
||
| .. group-tab:: DEB | ||
| .. code-block:: console | ||
|
|
||
| # docker exec -it wi-build_|WAZUH_CURRENT| bash packaging_scripts/build.sh -a x64 -d deb | ||
|
|
||
| .. group-tab:: TAR | ||
| .. code-block:: console | ||
|
|
||
| # docker exec -it wi-build_|WAZUH_CURRENT| bash packaging_scripts/build.sh -a x64 -d tar |
There was a problem hiding this comment.
| .. tabs:: | |
| .. group-tab:: RPM | |
| .. code-block:: console | |
| # docker exec -it wi-build_|WAZUH_CURRENT| bash packaging_scripts/build.sh -a x64 -d rpm | |
| .. group-tab:: DEB | |
| .. code-block:: console | |
| # docker exec -it wi-build_|WAZUH_CURRENT| bash packaging_scripts/build.sh -a x64 -d deb | |
| .. group-tab:: TAR | |
| .. code-block:: console | |
| # docker exec -it wi-build_|WAZUH_CURRENT| bash packaging_scripts/build.sh -a x64 -d tar | |
| .. tabs:: | |
| .. group-tab:: RPM | |
| .. code-block:: console | |
| # docker exec -it wi-build_|WAZUH_CURRENT| bash packaging_scripts/build.sh -a x64 -d rpm | |
| .. group-tab:: DEB | |
| .. code-block:: console | |
| # docker exec -it wi-build_|WAZUH_CURRENT| bash packaging_scripts/build.sh -a x64 -d deb | |
| .. group-tab:: TAR | |
| .. code-block:: console | |
| # docker exec -it wi-build_|WAZUH_CURRENT| bash packaging_scripts/build.sh -a x64 -d tar |
There was a problem hiding this comment.
Three spaces indentation for neat alignment
| For local package generation, use the ``build.sh`` script. Take a look | ||
| at the ``build.yml`` workflow file for an example of usage. | ||
|
|
||
| .. code:: bash |
There was a problem hiding this comment.
| .. code:: bash | |
| .. code:: console |
| .. | ||
|
|
||
| ``rpmbuild`` is invoked from ``wazuh-indexer/artifacts/tmp/rpm``. | ||
| It creates the {BUILD,RPMS,SOURCES,SRPMS,SPECS,TMP} folders and |
There was a problem hiding this comment.
{BUILD,RPMS,SOURCES,SRPMS,SPECS,TMP} seems to need text formatting such as code font style.
There was a problem hiding this comment.
Use .. code-block:: none rather than simply :: for consistency and clarity
| | -- prerm | ||
| | -- postinst | ||
|
|
||
| .. _rpm-1: |
There was a problem hiding this comment.
What's the purpose of .. _rpm-1: here?
|
|
||
| # bash packaging_scripts/assemble.sh -a x64 -d tar -r 1 | ||
|
|
||
| .. _deb-1: |
| The packages' generation process is guided through bash scripts. Below | ||
| is a reference of their inputs, outputs and code: | ||
|
|
||
| .. code:: console |
There was a problem hiding this comment.
This block doesn't seem to be for the terminal (console). Use proper syntax highlighting or none for just a code style formatted block.
|
Please use the correct branch convention, and create a new PR with the correct branch naming, check the following documentation: @javimed when request changes are finished please close this PR and ask to open a new one with the latest changes |
|
@javimed, @rauldpm, @AlexRuiz7: I'm renaming the branch which closes this PR. I'll create a new one with your suggested changes. |
|
Superseded by #7355 |
Description
This PR adds documentation for the generation of Wazuh Indexer packages.
Checks
Docs building
Code formatting and web optimization
redirects.jsscript if necessary (check this guide).Writing style
codefont for Bash commands, file names, REST paths, and code.