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

Add documentation for Wazuh as a custom source ASL integration #7310

Merged
merged 7 commits into from
May 31, 2024

Conversation

AlexRuiz7
Copy link
Member

@AlexRuiz7 AlexRuiz7 commented May 14, 2024

Description

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.

@AlexRuiz7 AlexRuiz7 requested a review from javimed May 14, 2024 16:29
@javimed javimed added level/task Task issue type/enhancement Enhancement issue labels May 14, 2024
@AlexRuiz7 AlexRuiz7 marked this pull request as draft May 15, 2024 06:52
@AlexRuiz7 AlexRuiz7 marked this pull request as ready for review May 16, 2024 15:07
f-galland
f-galland previously approved these changes May 16, 2024
Copy link
Member

Choose a reason for hiding this comment

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

Consider using code font style in tables for attribute names, attribute values, class names, data types, etc. For example ``200101``, ``type_uid``, ``Wazuh, Inc.``, ``time`` (if we mean a key, field, etc. named "time")

Copy link
Member

Choose a reason for hiding this comment

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

You can specify the prompt symbol. For example

   .. code-block:: console

      $ sudo /usr/share/logstash/bin/logstash-plugin install logstash-input-opensearch

Copy-to-clipboard discards leading $ and # so no worries about that.

@javimed javimed merged commit df086a8 into 4.9.0 May 31, 2024
3 checks passed
@javimed javimed deleted the wazuh-indexer-211-asl-integration-documentation branch May 31, 2024 20:02
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
Status: Done
Development

Successfully merging this pull request may close these issues.

Amazon Security Lake integration - Technical documentation and user manual
3 participants