From 43f368dfc4a0192c1e4772f535e6be59bbcdee50 Mon Sep 17 00:00:00 2001
From: Bruno Quaresma <bruno@coder.com>
Date: Sun, 11 Sep 2022 22:04:56 -0300
Subject: [PATCH] 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>
---
 docs/admin/audit-logs.md                       | 18 ++++++++++++++++++
 docs/manifest.json                             |  5 +++++
 .../components/Tooltips/AuditHelpTooltip.tsx   | 14 +++++++++++++-
 3 files changed, 36 insertions(+), 1 deletion(-)
 create mode 100644 docs/admin/audit-logs.md

diff --git a/docs/admin/audit-logs.md b/docs/admin/audit-logs.md
new file mode 100644
index 0000000000..09c25962d4
--- /dev/null
+++ b/docs/admin/audit-logs.md
@@ -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).
diff --git a/docs/manifest.json b/docs/manifest.json
index 3960d9f0b5..3441d8bab6 100644
--- a/docs/manifest.json
+++ b/docs/manifest.json
@@ -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.",
diff --git a/site/src/components/Tooltips/AuditHelpTooltip.tsx b/site/src/components/Tooltips/AuditHelpTooltip.tsx
index 33305668f2..05c5f816f4 100644
--- a/site/src/components/Tooltips/AuditHelpTooltip.tsx
+++ b/site/src/components/Tooltips/AuditHelpTooltip.tsx
@@ -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>
   )
 }