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.

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

winlogbeat/docs: improve event_logs.name docs #34931

Merged
merged 1 commit into from
Mar 28, 2023
Merged

winlogbeat/docs: improve event_logs.name docs #34931

merged 1 commit into from
Mar 28, 2023

Conversation

efd6
Copy link
Contributor

@efd6 efd6 commented Mar 27, 2023 •
edited
Loading

What does this PR do?

This introduces the concept of event log names earlier in the documentation and provides the preferred PowerShell cmdlet first before showing the fallback cmdlet if the preferred option is not available.

Links to the Microsoft documentation for the cmdlets are also added.

Why is it important?

This improves user on-boarding experience.

Checklist

  • My code follows the style guidelines of this project
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • I have made corresponding change to the default configuration files
  • I have added tests that prove my fix is effective or that my feature works
  • I have added an entry in CHANGELOG.next.asciidoc or CHANGELOG-developer.next.asciidoc.

Author's Checklist

  • [ ]

How to test this PR locally

Related issues

Use cases

Screenshots

Logs

@efd6 efd6 added enhancement docs Winlogbeat Team:Security-External Integrations backport-7.17 Automated backport to the 7.17 branch with mergify 8.8-candidate backport-v8.7.0 Automated backport with mergify labels Mar 27, 2023
@efd6 efd6 self-assigned this Mar 27, 2023
@botelastic botelastic bot added needs_team Indicates that the issue/PR needs a Team:* label and removed needs_team Indicates that the issue/PR needs a Team:* label labels Mar 27, 2023
@efd6 efd6 force-pushed the i5673-winlogbeat branch from 7ca79e3 to 1c2d0c6 Compare March 27, 2023 03:38
@efd6
winlogbeat/docs: improve event_logs.name docs
04a0077 
This introduces the concept of event log names earlier in the documentation and
provides the preferred PowerShell cmdlet first, before showing the fallback
cmdlet if the preferred option is not available.

Links to the Microsoft documentation for the cmdlets is also added.
@efd6 efd6 force-pushed the i5673-winlogbeat branch from 1c2d0c6 to 04a0077 Compare March 27, 2023 03:40
@elasticmachine
Copy link
Collaborator

💚 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-03-27T03:40:48.813+0000

  • Duration: 8 min 53 sec

❕ Flaky test report

No test was executed to be analysed.

🤖 GitHub comments

Expand to view the GitHub comments

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

  • /test : Re-trigger the build.

  • /package : Generate the packages and run the E2E tests.

  • /beats-tester : Run the installation tests with beats-tester.

  • run elasticsearch-ci/docs : Re-trigger the docs validation. (use unformatted text in the comment!)

@efd6 efd6 marked this pull request as ready for review March 27, 2023 04:04
@efd6 efd6 requested a review from a team as a code owner March 27, 2023 04:04
@elasticmachine
Copy link
Collaborator

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

@efd6 efd6 requested a review from 111andre111 March 27, 2023 04:04
@efd6 efd6 merged commit bd93c11 into elastic:main Mar 28, 2023
mergify bot pushed a commit that referenced this pull request Mar 28, 2023
@efd6 @mergify
winlogbeat/docs: improve event_logs.name docs (#34931)
cc04f75 
This introduces the concept of event log names earlier in the documentation and
provides the preferred PowerShell cmdlet first, before showing the fallback
cmdlet if the preferred option is not available.

Links to the Microsoft documentation for the cmdlets is also added.

(cherry picked from commit bd93c11)
mergify bot pushed a commit that referenced this pull request Mar 28, 2023
@efd6 @mergify
winlogbeat/docs: improve event_logs.name docs (#34931)
29bb008 
This introduces the concept of event log names earlier in the documentation and
provides the preferred PowerShell cmdlet first, before showing the fallback
cmdlet if the preferred option is not available.

Links to the Microsoft documentation for the cmdlets is also added.

(cherry picked from commit bd93c11)
This was referenced Mar 28, 2023
Merged
Merged
efd6 added a commit that referenced this pull request Mar 28, 2023
@mergify @efd6
[8.7](backport #34931) winlogbeat/docs: improve event_logs.name docs (#…
94d2ab7 
…34949)

* winlogbeat/docs: improve event_logs.name docs (#34931)

This introduces the concept of event log names earlier in the documentation and
provides the preferred PowerShell cmdlet first, before showing the fallback
cmdlet if the preferred option is not available.

Links to the Microsoft documentation for the cmdlets is also added.

(cherry picked from commit bd93c11)

* fix up changelog

---------

Co-authored-by: Dan Kortschak <90160302+efd6@users.noreply.github.com>
efd6 added a commit that referenced this pull request Mar 28, 2023
@mergify @efd6
[7.17](backport #34931) winlogbeat/docs: improve event_logs.name docs (…
7c36204 
…#34948)

* winlogbeat/docs: improve event_logs.name docs (#34931)

This introduces the concept of event log names earlier in the documentation and
provides the preferred PowerShell cmdlet first, before showing the fallback
cmdlet if the preferred option is not available.

Links to the Microsoft documentation for the cmdlets is also added.

(cherry picked from commit bd93c11)

* fix changelog entry

---------

Co-authored-by: Dan Kortschak <90160302+efd6@users.noreply.github.com>
chrisberkhout pushed a commit that referenced this pull request Jun 1, 2023
@efd6 @chrisberkhout
winlogbeat/docs: improve event_logs.name docs (#34931)
0a720f8 
This introduces the concept of event log names earlier in the documentation and
provides the preferred PowerShell cmdlet first, before showing the fallback
cmdlet if the preferred option is not available.

Links to the Microsoft documentation for the cmdlets is also added.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@andrewkroh andrewkroh andrewkroh approved these changes

@111andre111 111andre111 Awaiting requested review from 111andre111

Assignees

@efd6 efd6

Labels
8.8-candidate backport-7.17 Automated backport to the 7.17 branch with mergify backport-v8.7.0 Automated backport with mergify docs enhancement Winlogbeat
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@efd6 @elasticmachine @andrewkroh