Management UI updates (#702)

* reorder ui docs * admi ui * subject request detail finalization, datastore stub * config edit * comment out docs not implemented * remove tracking * changelog * remove stray comment, add Canceled status
ethyca · Jun 23, 2022 · 0bb972b · 0bb972b
1 parent 9756d32
commit 0bb972b
Show file tree

Hide file tree

Showing 11 changed files with 42 additions and 7 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -65,6 +65,8 @@ The types of changes are:
 * Add celerybeat-schedule file to gitignore [#639](https://github.com/ethyca/fidesops/pull/639)
 * Use `v2.1.0` of `fideslib` [#705](https://github.com/ethyca/fidesops/pull/705)
 
+### Docs
+* Subject Request detail documentation for the UI [#702](https://github.com/ethyca/fidesops/pull/702)
 ### Fixed
 * Fixed error with running mypy on M1 Macs [#630](https://github.com/ethyca/fidesops/pull/630)
 * Fixed error with mypy on Python versions greater than 3.9.6 [#630](https://github.com/ethyca/fidesops/pull/630)

diff --git a/docs/fidesops/docs/img/admin_ui/admin_ui.png b/docs/fidesops/docs/img/admin_ui/admin_ui.png
diff --git a/docs/fidesops/docs/img/admin_ui/approve_deny.png b/docs/fidesops/docs/img/admin_ui/approve_deny.png
diff --git a/docs/fidesops/docs/img/admin_ui/datastore.png b/docs/fidesops/docs/img/admin_ui/datastore.png
diff --git a/docs/fidesops/docs/img/admin_ui/subject_request_details.png b/docs/fidesops/docs/img/admin_ui/subject_request_details.png
diff --git a/docs/fidesops/docs/ui/admin_ui.md b/docs/fidesops/docs/ui/admin_ui.md
diff --git a/docs/fidesops/docs/ui/datastores.md b/docs/fidesops/docs/ui/datastores.md
@@ -1 +1,6 @@
-# Configuring Datastores
+# Managing Datastores
+
+Datastores represent connections to third party applications, databases, or manual storage. Configuring a datastore allows Fidesops to include these connections when fulfilling privacy requests.
+
+![datastore](../img/admin_ui/datastore.png)
+
diff --git a/docs/fidesops/docs/ui/overview.md b/docs/fidesops/docs/ui/overview.md
@@ -8,6 +8,6 @@ The fidesops [Privacy Center](privacy_center.md) is a configurable webpage where
 ![privacy center](../img/admin_ui/privacy_center.png)
 
 ## Admin UI
-The [Admin UI](admin_ui.md) organizes processes like fulfilling data subject requests, customizing database connections, and managing user access into a single control panel. Once configured, the Admin UI allows [authorized users](user_management.md) to approve or deny privacy requests, manage datastores, and create or update fidesops [policies](../guides/policies.md).
+The Admin UI organizes processes like fulfilling [data subject requests](subject_requests.md), customizing [database connections](datastores.md), and [managing user access](user_management.md) into a single control panel. Once configured, the Admin UI allows authorized users to approve or deny privacy requests, manage datastores, and create or update fidesops [policies](../guides/policies.md).
 
 ![admin ui](../img/admin_ui/admin_ui.png)
diff --git a/docs/fidesops/docs/ui/request_denial.png b/docs/fidesops/docs/ui/request_denial.png
diff --git a/docs/fidesops/docs/ui/subject_requests.md b/docs/fidesops/docs/ui/subject_requests.md
@@ -0,0 +1,31 @@
+# Subject Requests
+
+The FidesOps Admin UI is designed to provide easy, at-a-glance access to submitted Subject Requests. The Subject Request panel provides search and sort capabilities, quick approve and deny functions, and in-depth details on a request's history and status.
+
+![subject requests](../img/admin_ui/admin_ui.png)
+
+### Panel Options
+| Option | Description |
+|----|----|
+| Status | Requests can be filtered by their current status: **Error**, **Denied**, **In Progress**, **New**, *Cancelled*, and **Complete**.|
+| Search | The search bar filters on a given field: status, reviewer, etc. |
+| Date Filter | Retrieve requests received within a certain date window. |
+| Reveal PII | Toggling **Reveal PII** will display all personal information for the shown requests. |
+| Download | Download a `.csv` of the shown requests. |
+| Clear | Remove all search options and filters. |
+
+## Approve or Deny Requests
+
+![approve or deny requests](../img/admin_ui/approve_deny.png)
+
+Hovering over a request row will provide access to the **approve** and **deny** options for that request.
+
+**Approving** a request will log the action, the approver's account, and begin the process of executing the request based on the associated [policy](../guides/policies.md).
+
+**Denying** a request allows the user to input a denial reason before confirming the action.
+
+![request denial](request_denial.png)
+
+## View Request Details
+![subject request details](../img/admin_ui/subject_request_details.png)
+Double-clicking a request row will display the request detail page, which allows access to additional information about the request, as well as the request ID and status. 
diff --git a/docs/fidesops/mkdocs.yml b/docs/fidesops/mkdocs.yml
@@ -45,6 +45,8 @@ nav:
       - Overview: ui/overview.md
       - Privacy Center: ui/privacy_center.md
       - Admin UI: 
+        - Subject Requests: ui/subject_requests.md
+        - Managing Datastores: ui/datastores.md
         - User Management: ui/user_management.md
   - Deployment Guide: deployment.md
   - Glossary: glossary.md