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

Upgrade documentation according to the new interface look #7280

Open
wants to merge 114 commits into
base: 4.8.0
Choose a base branch
from

Conversation

Tostti
Copy link
Member

@Tostti Tostti commented May 2, 2024

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.

@asteriscos asteriscos changed the title Upgrade documentation according to the new inteface look Upgrade documentation according to the new interface look May 2, 2024
@Tostti Tostti marked this pull request as draft May 2, 2024 19:48
Tostti and others added 10 commits May 20, 2024 10:48
Co-authored-by: Javier Medeot <javier.medeot@wazuh.com>
Co-authored-by: Javier Medeot <javier.medeot@wazuh.com>
Co-authored-by: Javier Medeot <javier.medeot@wazuh.com>
Co-authored-by: Javier Medeot <javier.medeot@wazuh.com>
Co-authored-by: Javier Medeot <javier.medeot@wazuh.com>
Co-authored-by: Javier Medeot <javier.medeot@wazuh.com>
Co-authored-by: Javier Medeot <javier.medeot@wazuh.com>
Co-authored-by: Javier Medeot <javier.medeot@wazuh.com>
Copy link
Member

@javimed javimed left a comment

Choose a reason for hiding this comment

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

We need to update the redirects.js file with the files removed, the ones added and the necessary redirections. For example

newUrls['4.8'] = [
  ...
  '/user-manual/wazuh-dashboard/management.html',
];

removedUrls['4.8'] = [
  ...
  '/user-manual/wazuh-dashboard/settings.html'.
];

/* Redirections from 4.7 to 4.8  */

redirections.push(
  {
    'target': ['4.7=>4.8', '4.8=>4.7'],
    '4.7': '/user-manual/wazuh-dashboard/settings.html',
    '4.8': '/user-manual/wazuh-dashboard/management.html',
  },
  ...

source/user-manual/wazuh-dashboard/management.rst Outdated Show resolved Hide resolved
source/user-manual/wazuh-dashboard/management.rst Outdated Show resolved Hide resolved
source/user-manual/wazuh-dashboard/management.rst Outdated Show resolved Hide resolved
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
Co-authored-by: Javier Medeot <javier.medeot@wazuh.com>
Co-authored-by: Javier Medeot <javier.medeot@wazuh.com>
Co-authored-by: Javier Medeot <javier.medeot@wazuh.com>
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
Copy link
Member

Choose a reason for hiding this comment

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

CentOS endpoint text with an Ubuntu endpoint image

Copy link
Member

@javimed javimed May 23, 2024

Choose a reason for hiding this comment

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

We should highlight 11.2.1 on the right instead, since next text and image are about 11.2.1.

Copy link
Member

Choose a reason for hiding this comment

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

text says Threat hunting while new image shows Discover.

Copy link
Member

Choose a reason for hiding this comment

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

Text says "the various cloud provider modules" while the image highlights only a partial selection of some of the cloud security modules available

Copy link
Member

Choose a reason for hiding this comment

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

Highlighting test 3003's result would be a plus

Copy link
Member

Choose a reason for hiding this comment

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

Maybe if we shrinked the time range bars would spread along the graph

Copy link
Member

@javimed javimed May 23, 2024

Choose a reason for hiding this comment

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

Having multiple connections, in varied connection and update status, besides the starred one, would improve the image.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
level/task Task issue type/change Change requested
Projects
Status: In progress
Development

Successfully merging this pull request may close these issues.

Change the default theme in Wazuh Dashboard advanced settings
4 participants