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 upgrading-wazuh-docker.rst #7025

Draft
wants to merge 1 commit into
base: 4.7
Choose a base branch
from
Draft

Conversation

cladkins
Copy link

@cladkins cladkins commented Feb 7, 2024

Description

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.

@rauldpm rauldpm self-requested a review February 7, 2024 18:13
Comment on lines +25 to +29
#. Update the local git repository with the current versions of wazuh-docker:

.. code-block::

# git fetch
Copy link
Member

Choose a reason for hiding this comment

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

Hello @cladkins

I agree with this change, as it is necessary to enter a git command to update the repository and be able to checkout the tag, if not, it gives the following error:

error: pathspec 'branch' did not match any file(s) known to git

But before accepting these changes, I need to ask you for other changes:

  1. Create an issue explaining the problem and that you have created this PR to solve it since every PR must be linked to an issue, it doesn't need to be large, just the issue you found and the proposed solution, also, please add a small description to the pull request description section
  2. Modify your changes as follows
    2.1 Fix the indentation so that it follows the established indentation (the git checkout is also wrong, if you can fix it in the process I would appreciate it) (blue line) Note that this must include the .. code-block:: and the # git... lines
    2.2 Add a line break to separate git fetch from the next point (red line)

image

@rauldpm rauldpm marked this pull request as draft February 7, 2024 21:12
@rauldpm rauldpm linked an issue Feb 19, 2024 that may be closed by this pull request
@rauldpm
Copy link
Member

rauldpm commented Feb 19, 2024

Hello @cladkins, due to inactivity the following issue has been opened so the team can work on the requested changes

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Improve the wazuh-docker upgrade guide
2 participants