Upgrade documentation according to the new interface look #7280

Tostti · 2024-05-02T14:24:02Z

Description

From version 4.8.0, the interface of Wazuh Dashboard had a big change.
This PR aims to replace all the images to match the new interface, as well as reviewing the references to changed sections.

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.

Co-authored-by: Javier Medeot <[email protected]>

source/_static/js/redirects.js

source/user-manual/ruleset/mitre.rst

Co-authored-by: Javier Medeot <[email protected]>

source/_static/js/redirects.js

source/images/cloud-security/github/use-case-github-members-monitoring-alerts-dashboard.png

source/images/cloud-security/github/use-case-github-repository-monitoring-alerts-dashboard.png

source/images/manual/fim/expand-the-alert.png

source/user-manual/capabilities/file-integrity/interpreting-fim-module-analysis.rst

source/images/manual/fim/expanded-alert-entry.png

source/images/compliance/gdpr/fim-file-mod-who1.png

source/images/compliance/gdpr/fim-file-mod-who2.png

source/images/compliance/hipaa/06-vulnerability-detection.png

source/images/compliance/nist/alert-of-rule-id-550.png

source/images/compliance/nist/expand-alert.png

source/images/compliance/nist/the-full-log-field.png

source/images/compliance/nist/alert-of-rule-id-550.png

source/images/compliance/nist/expand-alert.png

source/images/compliance/nist/the-full-log-field.png

source/images/compliance/pci/select-discover-2.png

source/images/getting-started/use-cases/fim/fim-ar-virustotal-alerts.png

source/images/getting-started/use-cases/fim/fim-modified-registry-key-alert-details.png

source/images/getting-started/use-cases/incident-response/ar-module-blocks-dos-attack.png

source/images/getting-started/use-cases/it-hygiene/pci-dss-requirement-violations.png

source/images/getting-started/use-cases/log-data-analysis/alerts-in-index-pattern.png

source/images/getting-started/use-cases/log-data-analysis/cloud-provider-modules.png

source/images/getting-started/use-cases/sca/sca-checks-status-changed.png

source/images/getting-started/use-cases/threat-hunting/security-events.png

source/images/kibana-app/features/settings/api.png

source/images/manual/command-monitoring/memory-utilization-alert.png

source/images/manual/managing-agents/endpoints-summary-dashboard.png

source/images/manual/system-inventory/download-csv.png

source/images/manual/system-inventory/inventory-data.png

source/images/manual/wazuh-indexer/status-evolution-agents-dashboard.png

source/images/poc/fim-alerts-windows.png

source/images/poc/virustotal-remove-malware-linux-alert.png

source/images/sca/macos-sca-check-results.png

javimed · 2024-05-27T17:53:14Z

source/images/single-sign-on/azure-active-directory/Wazuh-role-mapping.png

The image doesn't show the Save role mapping button. It would be a plus since it's to be clicked in next step and it was visible in previous image. This happens to the similar images that follow. These images appear cropped and look incomplete to my eyes at least.

javimed · 2024-05-27T18:20:29Z

source/images/wazuh-dashboard/custom-dashboards/create-area-visualization-update-button.png

Improvement suggestion: Higher used memory value and lower available memory value could make the graph standout. Currently the used memory in the graph is little visible.

javimed · 2024-05-27T19:01:30Z

source/images/wazuh-dashboard/custom-dashboards/create-heat-map-visualization-update-button.png

Can we display the X-axis form in the right as well? Can we use a different time range to add variety to the heat map? Currently we just show two tactics and two techniques only, unlike the previous image.

javimed · 2024-05-27T19:06:50Z

source/images/wazuh-dashboard/custom-dashboards/create-line-visualization-update-button.png

If we could show the Y-axis form on the right as well, it would be a plus.

javimed · 2024-05-27T19:18:20Z

source/images/wazuh-dashboard/custom-dashboards/create-new-dashboard-save.png

Similar to one of the previous comments: A higher memory usage relative to the available memory would improve the memory size metric graph here showing two areas. Currently, yellow area is little visible.

source/images/wodles-oscap/pci-oscap.png

javimed · 2024-05-28T13:51:27Z

source/images/manual/mitre/events-filters.png

Text is about rule ID 92154 and MITRE ID T1053.005

javimed · 2024-05-28T14:00:34Z

source/images/poc/docker-alerts.png

The PoC is specific to Ubuntu 22 and it's about pulling the NGINX image, running the container, stopping and removing the container. Some alerts are missing (and some others are not relevant).

javimed · 2024-05-28T14:23:36Z

source/images/compliance/tsc/common-criteria/ruleid-2902-filtering.gif

Step 3 is "Ensure the Ubuntu endpoint is selected". The previous image showed how to ensure the Ubuntu was selected but this is not present in the new image.

javimed · 2024-05-28T14:26:32Z

source/images/getting-started/use-cases/fim/fim-modified-file-alert.png

Question: Is it ok to see the syscheck.event field empty for rule ID 550 alert while we see it with value modified in the previous image?

javimed · 2024-05-28T15:41:09Z

source/images/getting-started/use-cases/log-data-analysis/agent-monitoring-information.png

Previous image with

Data on the Evolution panel

masOS endpoint
looked better than this one. The getting started guide is aimed mainly for new users so the nicer the better if possible.

javimed · 2024-05-28T15:50:05Z

source/images/getting-started/use-cases/log-data-analysis/performance-related-events.png

This image is cropped at the bottom and graphs look empty

source/user-manual/agent/agent-management/query-configuration.rst

javimed · 2024-05-28T18:29:39Z

source/images/kibana-app/features/query-configuration/cluster.png

An additional image showing the specific configuration for the master node like in the previous image could be useful.

javimed · 2024-05-28T18:46:10Z

source/user-manual/manager/wazuh-archives.rst

Line #77 says Stack management > ...

javimed · 2024-05-28T18:52:52Z

source/images/manual/wazuh-indexer/create-custom-alerts-index-pattern.gif

Missing last hyphen. The index pattern name must be my-custom-alerts-*.

javimed · 2024-05-28T19:10:31Z

source/images/sca/macos-sca-use-case.png

macOS use case uses 10005 check instead

Co-authored-by: Javier Medeot <[email protected]>

javimed · 2024-05-28T20:34:26Z

source/images/manual/command-monitoring/memory-utilization-alert.png

full_log value doesn't match with document text custom rule definition.

javimed · 2024-05-28T20:42:21Z

source/images/manual/system-inventory/download-csv.png

Document text says Download CSV in

wazuh-documentation/source/user-manual/capabilities/system-inventory/generating-system-inventory-reports.rst

Line 16 in 3032bbd

To download this report, click on the **Download CSV** beneath the specific property you are interested in on the **Inventory data** page of the endpoint.

Tostti added 2 commits May 2, 2024 11:18

Update POC documentation

7f748f6

Update POC images

9f19152

Tostti mentioned this pull request May 2, 2024

Change the default theme in Wazuh Dashboard advanced settings wazuh/wazuh-dashboard#173

Closed

2 tasks

Tostti linked an issue May 2, 2024 that may be closed by this pull request

Change the default theme in Wazuh Dashboard advanced settings wazuh/wazuh-dashboard#173

Closed

2 tasks

Tostti added 7 commits May 2, 2024 11:59

Edit NIST docu

b517c5d

Edit NIST and TSC images

ecbfad3

Update PCI-DSS and GDPR docu

8571f5f

Update PCI-DSS, GDPR and HIPAA images

26fa043

Update cloud security images

cde0c9d

Update Cloud Security Docu

48c5b9f

Fix minor errors

b011257

asteriscos assigned Tostti May 2, 2024

asteriscos changed the title ~~Upgrade documentation according to the new inteface look~~ Upgrade documentation according to the new interface look May 2, 2024

Tostti marked this pull request as draft May 2, 2024 19:48

Tostti and others added 16 commits May 6, 2024 12:50

Update getting started images

77c5c03

Update getting started documentation

675385e

Update installation guide images

8fa85a4

Update vulnerability detection docu

fe8ea45

Modify Wazuh Archives images

101dc8a

Modify Wazuh Archives documentation

e6033fb

Fix emphasized lines

42510cf

Update custom dashboard images

c590996

Update custom dashboard docu

7012ea2

Update indexer docu

29fa704

change settings to management

b026fbc

Update wazuh dashboard documentation

7127e0f

Update wazuh dashboard images

3b1ae4a

Update user manual agent images

c4a405c

Update user manual agent docu

6339d23

Update screenshots User manual - Capabilities - AGentless - Use cases

517ecb4

Tostti and others added 5 commits May 20, 2024 15:12

Update source/user-manual/wazuh-dashboard/management.rst

4e84c27

Co-authored-by: Javier Medeot <[email protected]>

Update source/user-manual/wazuh-dashboard/management.rst

78b8f76

Co-authored-by: Javier Medeot <[email protected]>

Update source/user-manual/wazuh-dashboard/management.rst

e83ebf7

Co-authored-by: Javier Medeot <[email protected]>

Modify redirect.js file

6a6dfa0

Merge branch '4.8.0' into upgrade-documentation-new-interface-look

14d3621

javimed requested changes May 20, 2024

View reviewed changes

source/_static/js/redirects.js Outdated Show resolved Hide resolved

source/_static/js/redirects.js Outdated Show resolved Hide resolved

source/_static/js/redirects.js Show resolved Hide resolved

source/user-manual/ruleset/mitre.rst Outdated Show resolved Hide resolved

Tostti and others added 4 commits May 21, 2024 08:32

Update source/_static/js/redirects.js

f760c1d

Co-authored-by: Javier Medeot <[email protected]>

Update source/_static/js/redirects.js

51b8061

Co-authored-by: Javier Medeot <[email protected]>

Update source/_static/js/redirects.js

0680cf0

Co-authored-by: Javier Medeot <[email protected]>

Change spacing of block

12f046a

javimed requested changes May 21, 2024

View reviewed changes

source/images/compliance/gdpr/fim-file-mod-who1.png Outdated Show resolved Hide resolved

source/images/compliance/gdpr/fim-file-mod-who2.png Outdated Show resolved Hide resolved

source/images/compliance/hipaa/06-vulnerability-detection.png Outdated Show resolved Hide resolved

Apply suggested changes

b92ea1a

javimed requested changes May 22, 2024

View reviewed changes

source/images/compliance/nist/alert-of-rule-id-550.png Outdated Show resolved Hide resolved

source/images/compliance/nist/expand-alert.png Outdated Show resolved Hide resolved

source/images/compliance/nist/the-full-log-field.png Outdated Show resolved Hide resolved

javimed requested changes May 23, 2024

View reviewed changes

source/images/getting-started/use-cases/incident-response/ar-module-blocks-dos-attack.png Outdated Show resolved Hide resolved

Tostti added 2 commits May 23, 2024 18:14

Apply suggested changes

50c471d

Modify FIM registry key image

784fba3

javimed requested changes May 23, 2024

View reviewed changes

Apply suggested changes

ea9207c

javimed requested changes May 27, 2024

View reviewed changes

javimed requested changes May 28, 2024

View reviewed changes

Apply suggested changes

8546cad

javimed requested changes May 28, 2024

View reviewed changes

Update source/user-manual/agent/agent-management/query-configuration.rst

3032bbd

Co-authored-by: Javier Medeot <[email protected]>

javimed requested changes May 28, 2024

View reviewed changes

javimed merged commit 80f9000 into 4.8.0 May 31, 2024
3 checks passed

javimed deleted the upgrade-documentation-new-interface-look branch May 31, 2024 20:42

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Upgrade documentation according to the new interface look #7280

Upgrade documentation according to the new interface look #7280

Tostti commented May 2, 2024 •

edited by javimed

Loading

javimed May 27, 2024

javimed May 27, 2024

javimed May 27, 2024

javimed May 27, 2024

javimed May 27, 2024

javimed May 28, 2024

javimed May 28, 2024 •

edited

Loading

javimed May 28, 2024

javimed May 28, 2024

javimed May 28, 2024

javimed May 28, 2024

javimed May 28, 2024

javimed May 28, 2024

javimed May 28, 2024

javimed May 28, 2024

javimed May 28, 2024

javimed May 28, 2024

Upgrade documentation according to the new interface look #7280

Upgrade documentation according to the new interface look #7280

Conversation

Tostti commented May 2, 2024 • edited by javimed Loading

Description

Checks

Docs building

Code formatting and web optimization

Writing style

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

javimed May 28, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Tostti commented May 2, 2024 •

edited by javimed

Loading

javimed May 28, 2024 •

edited

Loading