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

Fix Virustotal "How it works" documentation #6651

Merged
merged 1 commit into from
Oct 24, 2023

Conversation

tsarquis88
Copy link
Contributor

@tsarquis88 tsarquis88 commented Oct 20, 2023

Description

Closes #6649.

This PR fixes two paths in the Virustotal documentation:

  • /var/ossec/logs/integration.log --> /var/ossec/logs/integrations.log
  • /var/ossec/logs/alerts.log --> /var/ossec/logs/alerts/alerts.log

Images

Before

image

After

image

Compilation with these changes

# make html
sphinx-build -b html -d build/doctrees   source build/html
Running Sphinx v7.0.1
loading translations [en-US]... not available for built-in messages
making output directory... done
building [mo]: targets for 0 po files that are out of date
writing output... 
building [html]: targets for 672 source files that are out of date
updating environment: [new config] 672 added, 0 changed, 0 removed
reading sources... [100%] user-manual/wazuh-dashboard/troubleshooting                                                                                                                        
Copying static files for wazuh-doc-images...[100%] img/loading.gif                                                                                                                           
looking for now-outdated files... none found
pickling environment... done
checking consistency... done
preparing documents... done
writing output... [100%] user-manual/wazuh-dashboard/troubleshooting                                                                                                                         
generating indices... done
writing additional pages... not_found moved-content search done
copying images... [100%] images/kibana-app/features/settings/about.png                                                                                                                       
copying static files... done
copying extra files... done
dumping search index in English (code: en)... done
dumping object inventory... done
build succeeded.

The HTML pages are in build/html.

Build finished. The HTML pages are in build/html.

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.

@tsarquis88 tsarquis88 linked an issue Oct 20, 2023 that may be closed by this pull request
@tsarquis88 tsarquis88 self-assigned this Oct 20, 2023
@tsarquis88 tsarquis88 force-pushed the fix-6649-virustotal-documentation branch from db9e560 to 0c0c81b Compare October 20, 2023 14:31
@tsarquis88 tsarquis88 changed the base branch from master to 4.7.0 October 20, 2023 14:31
Copy link
Member

@Damian-Mangold Damian-Mangold left a comment

Choose a reason for hiding this comment

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

LGTM !

image

@Damian-Mangold Damian-Mangold added level/task Task issue type/bug Bug issue labels Oct 20, 2023
@javimed
Copy link
Member

javimed commented Oct 23, 2023

@tsarquis88 this issue seems to be present in current 4.5 prodction docs as well.

imagen

[root@centos7 vagrant]# /var/ossec/bin/wazuh-control -j info
{"error":0,"data":[{"WAZUH_VERSION":"v4.5.3"},{"WAZUH_REVISION":"40508"},{"WAZUH_TYPE":"server"}]}[root@centos7 vagrant]# ^C
[root@centos7 vagrant]# ls /var/ossec/logs/
active-responses.log  alerts  api  api.log  archives  cluster  cluster.log  firewall  integrations.log  ossec.log  wazuh
[root@centos7 vagrant]# ls /var/ossec/logs/alerts/
2023  alerts.json  alerts.log
[root@centos7 vagrant]# 

What if we change the base branch to 4.5?

@Damian-Mangold
Copy link
Member

Hello @javimed, since this is a low-impact bug, it has been decided that the fix will remain in 4.7.0.

CC: @davidjiglesias

@javimed javimed merged commit fbf33fc into 4.7.0 Oct 24, 2023
3 checks passed
@javimed javimed deleted the fix-6649-virustotal-documentation branch October 24, 2023 11:26
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
level/task Task issue type/bug Bug issue
Projects
No open projects
Status: Done
Development

Successfully merging this pull request may close these issues.

Incorrect paths for log files mentioned in Virustotal documentation
3 participants