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

Create a troubleshooting guide for vulnerability detector module #8014

Conversation

pereyra-m
Copy link
Member

@pereyra-m pereyra-m commented Dec 5, 2024

Description

This PR proposes a new troubleshooting module section that contains:

  • FAQ: we can include here all the problems we find regularly solving communities question that aren't related to a problem in the module but a configuration issue.
  • Known issues: the description of the problems that have a fix released an a workaround.

If the proposal is out of scope or requires more revision/approval, I can simply add the already written guide to the upgrade guide (as the issue proposes) and create another issue.
I think that the upgrade guide isn't the best place to add this vulnerability detector problems, and a proper label and description of each situation is required (see each table).

I've added a communication problem with the Indexer as an example of a FAQ.

The final result can be seen by compiling the branch, here I upload some snapshots

Details

2024-12-05_15-45

2024-12-05_15-46

2024-12-05_15-47

2024-12-05_15-48

2024-12-05_15-48_1

2024-12-05_15-48_2

2024-12-05_15-48_3

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.

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.

Partial review

sebasfalcone
sebasfalcone previously approved these changes Dec 10, 2024
@sebasfalcone
Copy link
Member

I've compiled the documentation and it looks really good, great work with the tables and highlights in the code blocks!

@Dwordcito Dwordcito requested a review from javimed December 18, 2024 13:54
@Dwordcito
Copy link
Member

LGTM, assigned to @wazuh/devel-qa team for final review.

@sebasfalcone push this.

@javimed javimed added level/task Task issue type/enhancement Enhancement issue labels Dec 18, 2024
@Dwordcito Dwordcito changed the base branch from 4.10.0 to 4.10.1 December 19, 2024 11:21
@Dwordcito Dwordcito dismissed sebasfalcone’s stale review December 19, 2024 11:21

The base branch was changed.

@sebasfalcone sebasfalcone changed the base branch from 4.10.1 to 4.10.0 December 19, 2024 17:21
javimed
javimed previously approved these changes Dec 23, 2024
sebasfalcone
sebasfalcone previously approved these changes Dec 23, 2024
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!

I've compiled the documentation, looks good in the browser

@javimed javimed dismissed stale reviews from sebasfalcone and themself via 4201668 December 23, 2024 12:53
@javimed javimed merged commit bc367d2 into 4.10.0 Dec 23, 2024
3 checks passed
@javimed javimed deleted the enhancement/7991-vulnerability-detector-add-troubleshooting-steps branch December 23, 2024 12:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
level/task Task issue type/enhancement Enhancement issue
Projects
No open projects
Status: Done
Development

Successfully merging this pull request may close these issues.

Vulnerability Detector - Add troubleshooting steps for "Increment in Vulnerability Detector Index Size"
4 participants