mirror of https://github.com/coder/coder.git
docs: Add audit logs docs (#3975)
* docs: Add audit logs docs * Apply suggestions from code review Co-authored-by: Joe Previte <jjprevite@gmail.com> * Add contact link Co-authored-by: Joe Previte <jjprevite@gmail.com>
This commit is contained in:
parent
e5e1ed2f9c
commit
43f368dfc4
|
@ -0,0 +1,18 @@
|
|||
# Audit Logs
|
||||
|
||||
This is an enterprise feature that allows **Admins** and **Auditors** to monitor what is happening in their deployment.
|
||||
|
||||
## Tracked Events
|
||||
|
||||
This feature tracks **create, update and delete** events for the following resources:
|
||||
|
||||
- GitSSHKey
|
||||
- Template
|
||||
- TemplateVersion
|
||||
- Workspace
|
||||
- APIKey
|
||||
- User
|
||||
|
||||
## Enabling this feature
|
||||
|
||||
This feature is autoenabled for all enterprise deployments. An Admin can contact us to purchase a license [here](https://coder.com/contact?note=I%20want%20to%20upgrade%20my%20license).
|
|
@ -166,6 +166,11 @@
|
|||
"description": "Learn how to upgrade Coder.",
|
||||
"path": "./admin/upgrade.md"
|
||||
},
|
||||
{
|
||||
"title": "Audit Logs",
|
||||
"description": "Learn how to use Audit Logs in your Coder deployment.",
|
||||
"path": "./admin/audit-logs.md"
|
||||
},
|
||||
{
|
||||
"title": "Enterprise",
|
||||
"description": "Learn how to enable Enterprise features.",
|
||||
|
|
|
@ -1,9 +1,16 @@
|
|||
import { FC } from "react"
|
||||
import { HelpTooltip, HelpTooltipText, HelpTooltipTitle } from "./HelpTooltip"
|
||||
import {
|
||||
HelpTooltip,
|
||||
HelpTooltipLink,
|
||||
HelpTooltipLinksGroup,
|
||||
HelpTooltipText,
|
||||
HelpTooltipTitle,
|
||||
} from "./HelpTooltip"
|
||||
|
||||
export const Language = {
|
||||
title: "What is an audit log?",
|
||||
body: "An audit log is a record of events and changes made throughout a system.",
|
||||
docs: "Events we track",
|
||||
}
|
||||
|
||||
export const AuditHelpTooltip: FC = () => {
|
||||
|
@ -11,6 +18,11 @@ export const AuditHelpTooltip: FC = () => {
|
|||
<HelpTooltip>
|
||||
<HelpTooltipTitle>{Language.title}</HelpTooltipTitle>
|
||||
<HelpTooltipText>{Language.body}</HelpTooltipText>
|
||||
<HelpTooltipLinksGroup>
|
||||
<HelpTooltipLink href="https://coder.com/docs/coder-oss/latest/admin/audit-logs">
|
||||
{Language.docs}
|
||||
</HelpTooltipLink>
|
||||
</HelpTooltipLinksGroup>
|
||||
</HelpTooltip>
|
||||
)
|
||||
}
|
||||
|
|
Loading…
Reference in New Issue