4.9 KiB
Contributing to the Wazuh documentation
This document explains how to set up a Python virtual environment, clone the repository, contribute changes, and submit a pull request. It also explains how to report issues clearly so that we can resolve them quickly.
Note: These contribution guidelines might change in the future as we improve or change how we organize, create, and compile the documentation.
How to report issues in the Wazuh documentation
The community is important to us. We value your feedback on bugs or typos in the documentation. When reporting an issue, include the URL or section where the error occurs and provide all relevant details to help us resolve it.
This repository is dedicated to Wazuh documentation. In some cases, your issue might be more effectively addressed if it's reported in the appropriate repository. Here you can find some tips if you have doubts about the right place for your issue:
- If Wazuh works fine but something in the documentation seems inaccurate, unclear, or confusing, let us know by creating an issue here.
- If you encounter problems, bugs, or unexpected results when using any of the Wazuh components, create the issue in its respective repository:
In any case, don't worry if you create an issue here, we'll assist you with your problem.
How to collaborate with the Wazuh documentation
Contribute by forking the repository, creating a new branch, making your changes, and submitting a pull request.
Installing a Python virtual environment
The Digital Ocean guides below provide an overview of installing Python 3 and configuring a virtual environment. This approach lets you install the required dependencies without altering your primary environment, making it easier to manage and remove development setups.
After completing one of these guides, your Python environment will be ready.
How to fork this repository
Follow the GitHub forking model for collaborating on the documentation. This model assumes that you have a remote called upstream which points to the official repository.
Setting up the virtual environment
Assuming you have created and activated a virtual environment named wazuh_venv, proceed with the following steps:
- Clone the repository:
(wazuh_venv) $ git clone https://github.com/<YOUR_USERNAME>/wazuh-documentation.git
The (wazuh_venv) label indicates that the virtual environment is active.
- Change to the repository folder and install the dependencies.
(wazuh_venv) $ cd wazuh-documentation
(wazuh_venv) $ pip install -r requirements.txt
- Compile the documentation:
(wazuh_venv) $ make html
You can view the compiled documentation at wazuh-documentation/build/html/index.html as if it were served by web server.
- Clean the documentation.
(wazuh_venv) $ make clean
This command deletes the contents of wazuh-documentation/build/html/.
How the branches work
- The latest stable documentation is on the
mainbranch. Do not submit pull requests directly to this branch. - We actively work on version numbered branches (4.10, 4.11, x.y) for new additions, improvements of existing documentation, or typo fixes.
- All new additions to a version branch will be compatible with the latest stable release. We won't include documentation for a future release that is incompatible with the current official version.
- Work for a future release is merged into a separate branch until we make the final decision on the next release.
- All branches other than
mainor version branches (e.g., 4.x) are feature branches under development and will be merged later. - Where appropriate, we'll backport changes into older release branches.
Commits, pull requests and merging
- Feel free to make as many commits as you want while working on a branch.
- Please use your commit messages to include helpful information on your changes, and an explanation of why you made them.
- Also include an explanation of your changes in your PR description.
- Make sure to resolve merge conflicts so we can continue reviewing your pull request.
- In your PR description, add links to relevant issues, external resources, or related PRs that are useful.
Thank you for contributing!