Audit activities (#12807)

- Add note about Windows MDM features being in production
- Update doc generator to generate new title and meta tag
This commit is contained in:
Noah Talerman 2023-07-18 09:25:19 -04:00 committed by GitHub
parent 04beb67f75
commit e51ff9aa16
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
3 changed files with 9 additions and 7 deletions

View file

@ -1,5 +1,5 @@
<!-- DO NOT EDIT. This document is automatically generated. -->
# Audit Activities
# Audit activities
Fleet logs the following information for administrative actions (in JSON):
@ -828,13 +828,13 @@ This activity contains the following fields:
### Type `enabled_windows_mdm`
Generated when a user turns on MDM features for all Windows hosts (servers excluded).
Windows MDM features are not ready for production and are currently in development. These features are disabled by default. Generated when a user turns on MDM features for all Windows hosts (servers excluded).
This activity does not contain any detail fields.
### Type `disabled_windows_mdm`
Generated when a user turns off MDM features for all Windows hosts.
Windows MDM features are not ready for production and are currently in development. These features are disabled by default. Generated when a user turns off MDM features for all Windows hosts.
This activity does not contain any detail fields.

View file

@ -1019,7 +1019,7 @@ func (a ActivityTypeEnabledWindowsMDM) ActivityName() string {
}
func (a ActivityTypeEnabledWindowsMDM) Documentation() (activity, details, detailsExample string) {
return `Generated when a user turns on MDM features for all Windows hosts (servers excluded).`,
return `Windows MDM features are not ready for production and are currently in development. These features are disabled by default. Generated when a user turns on MDM features for all Windows hosts (servers excluded).`,
`This activity does not contain any detail fields.`, ``
}
@ -1030,7 +1030,7 @@ func (a ActivityTypeDisabledWindowsMDM) ActivityName() string {
}
func (a ActivityTypeDisabledWindowsMDM) Documentation() (activity, details, detailsExample string) {
return `Generated when a user turns off MDM features for all Windows hosts.`,
return `Windows MDM features are not ready for production and are currently in development. These features are disabled by default. Generated when a user turns off MDM features for all Windows hosts.`,
`This activity does not contain any detail fields.`, ``
}

View file

@ -15,7 +15,7 @@ func main() {
var b strings.Builder
b.WriteString(`<!-- DO NOT EDIT. This document is automatically generated. -->
# Audit Activities
# Audit activities
Fleet logs the following information for administrative actions (in JSON):
@ -65,7 +65,9 @@ Example:
}
b.WriteString(`
<meta name="pageOrderInSection" value="1400">`)
<meta name="pageOrderInSection" value="1400">
<meta name="description" value="Learn how Fleet logs administrative actions in JSON format.">
`)
if err := os.WriteFile(os.Args[1], []byte(b.String()), 0600); err != nil {
panic(err)