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

Adapt documentation to the new side menu. #6690

Conversation

JuanGarriuz
Copy link
Member

@JuanGarriuz JuanGarriuz commented Oct 26, 2023

Description

This PR update documentation about the design of the new applications, related to:

The screenshots will be updated in another pull request.

Changes:

  • Removed the configuration of extensions.*, disabled_roles and customization.logo.sidebar settings.
  • Removed the configuration of modules visibility in the Wazuh dashboard
  • Renamed references from tab to module in the Wazuh dashboard
  • Change the old module/tab name of Wazuh plugin to the new application name in Wazuh dashboard
    • -Security events -> Threat Hunting
      -Docker listener -> Docker
    • Security Configuration Assessment -> Configuration Assessment
    • Agents -> Endpoints Summary
    • Agents -> IT Hygiene
    • Groups -> Endpoint Groups
    • Vulnerabilities -> Vulnerability Detection
    • Policy monitoring -> Malware detection
    • Integrity monitoring -> File Integrity Monitoring
    • Amazon AWS/AWS -> Amazon Web Services
    • Management > Configuration -> Settings
    • API Console -> Dev Tools
    • Settings > Configuration -> App Settings
    • Settings page
    • Settings > API configuration
    • Settings > Sample data -> Sample data
    • Settings > Logs -> App Logs
    • Settings > About -> About
    • Management > * (plugin)
    • Management > * -> Indexer/dashboard management (plaform)
  • Removed the references to old module related to the Wazuh plugin:
    • System auditing
    • OpenSCAP
    • CIS-CAT
    • Osquery
    • Settings > Modules`
  • Removed some screenshots related to the removed old Settings > Modules
  • Replaced the references to the old menu with the new one
    • Clarify the access to an app which has the same name as the another related to the platform

Considerations:

  • The home of Wazuh dashboard is app/wz-home instead of app/wazuh
  • The name of the applications uses the title case, for example. Thread Hunting.

Screenshots to update

documentation-images.csv

References:

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.

@JuanGarriuz JuanGarriuz added level/task Task issue type/enhancement Enhancement issue labels Oct 26, 2023
@JuanGarriuz JuanGarriuz self-assigned this Oct 26, 2023
@JuanGarriuz JuanGarriuz changed the title Remove modules from wazuh app update and change app/wazuh to app/wz-home Remove modules from documentation and change app/wazuh to app/wz-home Oct 26, 2023
@Desvelao
Copy link
Member

Desvelao commented Oct 30, 2023

Request changes:

  • We removed the setting customization.logo.sidebar in the pull requests related to the global menu and I didn't see any reference to this change in the pull request.
  • The references to extensions.* settings must be removed
  • The references to disabled_roles setting must be removed.

@JuanGarriuz JuanGarriuz changed the title Remove modules from documentation and change app/wazuh to app/wz-home Adapt documentation to the new side menu. Nov 2, 2023
@Desvelao
Copy link
Member

Update:

  • Some screenshots were added to the pull request

source/cloud-service/your-environment/manage-auth.rst Outdated Show resolved Hide resolved
source/user-manual/user-administration/rbac.rst Outdated Show resolved Hide resolved
source/compliance/pci-dss/log-analysis.rst Outdated Show resolved Hide resolved
source/compliance/tsc/common-criteria/cc2.1.rst Outdated Show resolved Hide resolved
source/getting-started/components/wazuh-dashboard.rst Outdated Show resolved Hide resolved
source/user-manual/wazuh-indexer/wazuh-indexer-indices.rst Outdated Show resolved Hide resolved
source/user-manual/wazuh-indexer/wazuh-indexer-indices.rst Outdated Show resolved Hide resolved
source/user-manual/wazuh-indexer/wazuh-indexer-indices.rst Outdated Show resolved Hide resolved
source/user-manual/wazuh-indexer/wazuh-indexer-indices.rst Outdated Show resolved Hide resolved
source/user-manual/wazuh-indexer/wazuh-indexer-indices.rst Outdated Show resolved Hide resolved
@Desvelao
Copy link
Member

Update:

I applied the requested changes and updated the branch with the last changes of the target branch.

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.

LGTM!

@Desvelao
Copy link
Member

Update:

Update branch and resolve conflicts.

@javimed javimed merged commit ac7fbbd into 4.8.0 Nov 16, 2023
@javimed javimed deleted the enhancement/wdp-5965-add-global-menu-remove-extensions-disabled-roles-setting branch November 16, 2023 11:25
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
Archived in project
Development

Successfully merging this pull request may close these issues.

Remove the visibility configuration of modules and define and implement the ability to visualize applications
4 participants