From 712d518dec2758d02a1243926a332dd3699347b0 Mon Sep 17 00:00:00 2001 From: Bruno Quaresma Date: Fri, 9 Sep 2022 13:47:47 +0000 Subject: [PATCH 1/4] docs: Add audit logs docs --- docs/admin/audit-logs.md | 24 +++++++++++++++++++ docs/manifest.json | 6 ++++- .../components/Tooltips/AuditHelpTooltip.tsx | 14 ++++++++++- 3 files changed, 42 insertions(+), 2 deletions(-) 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 0000000000000..fe69ee5ebd431 --- /dev/null +++ b/docs/admin/audit-logs.md @@ -0,0 +1,24 @@ +# Audit Logs + +Audit logs is an enterprise feature that allows **Admins** and **Auditors** to monitoring what is happening on their deployment. + +## Tracked Events + +The following events are tracked by this feature: + +- Create +- Update +- Delete + +For the following resources: + +- GitSSHKey +- Template +- TemplateVersion +- Workspace +- APIKey +- User + +## Enabling this feature + +To enable this feature an Admin needs to purchase an enterprise license. diff --git a/docs/manifest.json b/docs/manifest.json index 6ff4206ebe498..84f6716b8a42d 100644 --- a/docs/manifest.json +++ b/docs/manifest.json @@ -148,7 +148,6 @@ { "title": "Users", "description": "Learn about user roles available in Coder and how to create and manage users", - "icon_path": "./images/icons/users.svg", "path": "./admin/users.md" }, { @@ -165,6 +164,11 @@ "title": "Upgrading", "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" } ] }, diff --git a/site/src/components/Tooltips/AuditHelpTooltip.tsx b/site/src/components/Tooltips/AuditHelpTooltip.tsx index 33305668f2f9f..05c5f816f4992 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 = () => { {Language.title} {Language.body} + + + {Language.docs} + + ) } From 3f508217225dcb3f0456c0661156f696ef789909 Mon Sep 17 00:00:00 2001 From: Bruno Quaresma Date: Fri, 9 Sep 2022 16:55:08 -0300 Subject: [PATCH 2/4] Apply suggestions from code review Co-authored-by: Joe Previte --- docs/admin/audit-logs.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/admin/audit-logs.md b/docs/admin/audit-logs.md index fe69ee5ebd431..cd49346843cc5 100644 --- a/docs/admin/audit-logs.md +++ b/docs/admin/audit-logs.md @@ -1,10 +1,10 @@ # Audit Logs -Audit logs is an enterprise feature that allows **Admins** and **Auditors** to monitoring what is happening on their deployment. +This is an enterprise feature that allows **Admins** and **Auditors** to monitor what is happening in their deployment. ## Tracked Events -The following events are tracked by this feature: +The following events are tracked: - Create - Update @@ -21,4 +21,4 @@ For the following resources: ## Enabling this feature -To enable this feature an Admin needs to purchase an enterprise license. +This feature is autoenabled for all enterprise deployments. An Admin can purchase a license [here](link) From 4460f750578d64ae62696dd761ddbcb569f4dfa8 Mon Sep 17 00:00:00 2001 From: Bruno Quaresma Date: Fri, 9 Sep 2022 19:59:33 +0000 Subject: [PATCH 3/4] Add contact link --- docs/admin/audit-logs.md | 10 ++-------- 1 file changed, 2 insertions(+), 8 deletions(-) diff --git a/docs/admin/audit-logs.md b/docs/admin/audit-logs.md index cd49346843cc5..09c25962d458c 100644 --- a/docs/admin/audit-logs.md +++ b/docs/admin/audit-logs.md @@ -4,13 +4,7 @@ This is an enterprise feature that allows **Admins** and **Auditors** to monitor ## Tracked Events -The following events are tracked: - -- Create -- Update -- Delete - -For the following resources: +This feature tracks **create, update and delete** events for the following resources: - GitSSHKey - Template @@ -21,4 +15,4 @@ For the following resources: ## Enabling this feature -This feature is autoenabled for all enterprise deployments. An Admin can purchase a license [here](link) +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). From 10d037b5b7767e5041cdb5c0e274c300c39cfa4b Mon Sep 17 00:00:00 2001 From: Geoffrey Huntley Date: Mon, 12 Sep 2022 00:57:40 +0000 Subject: [PATCH 4/4] resolve merge conflicts --- docs/manifest.json | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/docs/manifest.json b/docs/manifest.json index 84f6716b8a42d..3441d8bab686f 100644 --- a/docs/manifest.json +++ b/docs/manifest.json @@ -148,6 +148,7 @@ { "title": "Users", "description": "Learn about user roles available in Coder and how to create and manage users", + "icon_path": "./images/icons/users.svg", "path": "./admin/users.md" }, { @@ -169,6 +170,11 @@ "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.", + "path": "./admin/enterprise.md" } ] },