Skip to content

Commit 43f368d

Browse files
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>
1 parent e5e1ed2 commit 43f368d

File tree

3 files changed

+36
-1
lines changed

3 files changed

+36
-1
lines changed

docs/admin/audit-logs.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
# Audit Logs
2+
3+
This is an enterprise feature that allows **Admins** and **Auditors** to monitor what is happening in their deployment.
4+
5+
## Tracked Events
6+
7+
This feature tracks **create, update and delete** events for the following resources:
8+
9+
- GitSSHKey
10+
- Template
11+
- TemplateVersion
12+
- Workspace
13+
- APIKey
14+
- User
15+
16+
## Enabling this feature
17+
18+
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).

docs/manifest.json

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -166,6 +166,11 @@
166166
"description": "Learn how to upgrade Coder.",
167167
"path": "./admin/upgrade.md"
168168
},
169+
{
170+
"title": "Audit Logs",
171+
"description": "Learn how to use Audit Logs in your Coder deployment.",
172+
"path": "./admin/audit-logs.md"
173+
},
169174
{
170175
"title": "Enterprise",
171176
"description": "Learn how to enable Enterprise features.",
Lines changed: 13 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,28 @@
11
import { FC } from "react"
2-
import { HelpTooltip, HelpTooltipText, HelpTooltipTitle } from "./HelpTooltip"
2+
import {
3+
HelpTooltip,
4+
HelpTooltipLink,
5+
HelpTooltipLinksGroup,
6+
HelpTooltipText,
7+
HelpTooltipTitle,
8+
} from "./HelpTooltip"
39

410
export const Language = {
511
title: "What is an audit log?",
612
body: "An audit log is a record of events and changes made throughout a system.",
13+
docs: "Events we track",
714
}
815

916
export const AuditHelpTooltip: FC = () => {
1017
return (
1118
<HelpTooltip>
1219
<HelpTooltipTitle>{Language.title}</HelpTooltipTitle>
1320
<HelpTooltipText>{Language.body}</HelpTooltipText>
21+
<HelpTooltipLinksGroup>
22+
<HelpTooltipLink href="https://coder.com/docs/coder-oss/latest/admin/audit-logs">
23+
{Language.docs}
24+
</HelpTooltipLink>
25+
</HelpTooltipLinksGroup>
1426
</HelpTooltip>
1527
)
1628
}

0 commit comments

Comments
 (0)
pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy