-
Notifications
You must be signed in to change notification settings - Fork 363
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
Create a troubleshooting guide for vulnerability detector module #8014
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Partial review
source/user-manual/capabilities/vulnerability-detection/FAQ.rst
Outdated
Show resolved
Hide resolved
source/user-manual/capabilities/vulnerability-detection/FAQ.rst
Outdated
Show resolved
Hide resolved
source/user-manual/capabilities/vulnerability-detection/FAQ.rst
Outdated
Show resolved
Hide resolved
source/user-manual/capabilities/vulnerability-detection/known-issues.rst
Outdated
Show resolved
Hide resolved
source/user-manual/capabilities/vulnerability-detection/known-issues.rst
Outdated
Show resolved
Hide resolved
source/user-manual/capabilities/vulnerability-detection/known-issues.rst
Outdated
Show resolved
Hide resolved
Co-authored-by: Sebastian Falcone <[email protected]>
I've compiled the documentation and it looks really good, great work with the tables and highlights in the code blocks! |
LGTM, assigned to @wazuh/devel-qa team for final review. @sebasfalcone push this. |
The base branch was changed.
source/user-manual/capabilities/vulnerability-detection/known-issues.rst
Show resolved
Hide resolved
source/user-manual/capabilities/vulnerability-detection/known-issues.rst
Show resolved
Hide resolved
There was a problem hiding this 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
Description
This PR proposes a new troubleshooting module section that contains:
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
Checks
Docs building
Code formatting and web optimization
redirects.js
script if necessary (check this guide).Writing style
code
font for Bash commands, file names, REST paths, and code.