Skip to content

[System Audit] - Improved documentation #6418

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 4 commits into from
Jun 1, 2023
Merged

[System Audit] - Improved documentation #6418

merged 4 commits into from
Jun 1, 2023

Conversation

ShourieG
Copy link
Contributor

@ShourieG ShourieG commented Jun 1, 2023

Type of change

Please label this PR with one of the following labels, depending on the scope of your change:

  • Enhancement

What does this PR do?

This PR improves the documentation a bit and clearly mentions that Windows systems are not supported at the moment.

Checklist

  • I have reviewed tips for building integrations and this pull request is aligned with them.
  • I have verified that all data streams collect metrics or logs.
  • I have added an entry to my package's changelog.yml file.
  • I have verified that Kibana version constraints are current according to guidelines.

@ShourieG ShourieG requested a review from a team as a code owner June 1, 2023 09:46
@ShourieG ShourieG self-assigned this Jun 1, 2023
@elasticmachine
Copy link

Pinging @elastic/security-external-integrations (Team:Security-External Integrations)

@ShourieG ShourieG added the documentation Improvements or additions to documentation. Applied to PRs that modify *.md files. label Jun 1, 2023
@elasticmachine
Copy link

elasticmachine commented Jun 1, 2023 •
edited
Loading

💚 Build Succeeded

the below badges are clickable and redirect to their specific view in the CI or DOCS
Pipeline View Test View Changes Artifacts preview preview

Expand to view the summary

Build stats

  • Start Time: 2023-06-01T10:17:19.096+0000

  • Duration: 14 min 19 sec

Test stats 🧪

Test Results
Failed 0
Passed 16
Skipped 0
Total 16

🤖 GitHub comments

Expand to view the GitHub comments

To re-run your PR in the CI, just comment with:

  • /test : Re-trigger the build.

@elasticmachine
Copy link

elasticmachine commented Jun 1, 2023 •
edited
Loading

🌐 Coverage report

Name Metrics % (covered/total) Diff
Packages 100.0% (1/1) 💚
Files 100.0% (1/1) 💚
Classes 100.0% (1/1) 💚
Methods 100.0% (5/5) 💚 6.25
Lines 100.0% (33/33) 💚
Conditionals 100.0% (0/0) 💚

bhapas
bhapas approved these changes Jun 1, 2023
View reviewed changes
Copy link
Contributor

@bhapas bhapas left a comment

Choose a reason for hiding this comment

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

LGTM

@ShourieG ShourieG added the bugfix Pull request that fixes a bug issue label Jun 1, 2023
@bhapas
Copy link
Contributor

bhapas commented Jun 1, 2023

LGTM

@ShourieG ShourieG merged commit 094bb08 into elastic:main Jun 1, 2023
@ShourieG ShourieG deleted the system_audit/docFix branch June 1, 2023 11:03
@elasticmachine
Copy link

Package system_audit - 1.2.1 containing this change is available at https://epr.elastic.co/search?package=system_audit

sodhikirti07 pushed a commit that referenced this pull request Jun 15, 2023
@ShourieG @sodhikirti07
[System Audit] - Improved documentation (#6418)
1f1ae0b 
* updated dev docs

* improved documentation

* updated changelog and docs

* changed type from enhancement to bugfix
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@bhapas bhapas bhapas approved these changes

Assignees

@ShourieG ShourieG

Labels
bugfix Pull request that fixes a bug issue documentation Improvements or additions to documentation. Applied to PRs that modify *.md files. Integration:system_audit System Audit
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@ShourieG @elasticmachine @bhapas @andrewkroh