Skip to content

Conversation

@lockewritesdocs
Copy link
Contributor

@lockewritesdocs lockewritesdocs commented May 24, 2021

The current docs for audit event types are currently in a tabular format, which makes the descriptions difficult to read and the log examples challenging to parse. This change:

  • Puts the event types into a description list for better readability
  • Puts examples into a collapsible section, which is easier to read and parse
  • Adds system_access_granted as an event type
  • Includes cross links within the page and to external resources

Preview link: https://elasticsearch_73352.docs-preview.app.elstc.co/guide/en/elasticsearch/reference/master/audit-event-types.html

@lockewritesdocs lockewritesdocs added >docs General docs changes :Security/Audit X-Pack Audit logging v8.0.0 v7.13.0 v7.14.0 labels May 24, 2021
@lockewritesdocs lockewritesdocs self-assigned this May 24, 2021
@elasticmachine elasticmachine added Team:Security Meta label for security team Team:Docs Meta label for docs team labels May 24, 2021
@elasticmachine
Copy link
Collaborator

Pinging @elastic/es-security (Team:Security)

@elasticmachine
Copy link
Collaborator

Pinging @elastic/es-docs (Team:Docs)

@lockewritesdocs
Copy link
Contributor Author

@elasticmachine update branch

Copy link
Contributor

@albertzaharovits albertzaharovits left a comment

Choose a reason for hiding this comment

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

LGTM
This is a very nice improvement to our audit docs! Thank you Adam!

@lockewritesdocs lockewritesdocs merged commit 4e73d2a into elastic:master May 26, 2021
@lockewritesdocs lockewritesdocs deleted the docs__audit-settings-list branch May 26, 2021 20:57
lockewritesdocs pushed a commit to lockewritesdocs/elasticsearch that referenced this pull request May 26, 2021
* [DOCS] Changing event table to a list for easier viewing

* Make audit event types more readable

* Adding system_access_granted user and cross-links

Co-authored-by: Elastic Machine <[email protected]>
lockewritesdocs pushed a commit that referenced this pull request May 26, 2021
* [DOCS] Changing event table to a list for easier viewing

* Make audit event types more readable

* Adding system_access_granted user and cross-links

Co-authored-by: Elastic Machine <[email protected]>

Co-authored-by: Elastic Machine <[email protected]>
lockewritesdocs pushed a commit that referenced this pull request May 26, 2021
* [DOCS] Changing event table to a list for easier viewing

* Make audit event types more readable

* Adding system_access_granted user and cross-links

Co-authored-by: Elastic Machine <[email protected]>

Co-authored-by: Elastic Machine <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

>docs General docs changes :Security/Audit X-Pack Audit logging Team:Docs Meta label for docs team Team:Security Meta label for security team v7.13.0 v7.14.0 v8.0.0-alpha1

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants