[#716] update datastore documentation (#742)

ethyca · Jun 28, 2022 · fa92615 · fa92615
1 parent 25ced5a
commit fa92615
Show file tree

Hide file tree

Showing 10 changed files with 44 additions and 5 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -25,6 +25,7 @@ The types of changes are:
 
 * ### Docs
 * Updated the tutorial installation to use main in fidesdemo [#715](https://github.com/ethyca/fidesops/pull/715)
+* Added a page on how to use the datastore UI [#742](https://github.com/ethyca/fidesops/pull/742)
 
 ### Fixed
 * Make reading of environment variables case insensitive [712](https://github.com/ethyca/fidesops/pull/712)

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/datastore_list.png b/docs/fidesops/docs/img/admin_ui/datastore_list.png
diff --git a/docs/fidesops/docs/img/admin_ui/datastore_options.png b/docs/fidesops/docs/img/admin_ui/datastore_options.png
diff --git a/docs/fidesops/docs/img/admin_ui/delete_datastore.png b/docs/fidesops/docs/img/admin_ui/delete_datastore.png
diff --git a/docs/fidesops/docs/img/admin_ui/failed_test.png b/docs/fidesops/docs/img/admin_ui/failed_test.png
diff --git a/docs/fidesops/docs/ui/request_denial.png → ...sops/docs/img/admin_ui/request_denial.png b/docs/fidesops/docs/ui/request_denial.png → ...sops/docs/img/admin_ui/request_denial.png
diff --git a/docs/fidesops/docs/postman/using_postman.md b/docs/fidesops/docs/postman/using_postman.md
@@ -18,7 +18,7 @@ A minimal Postman collection is included to assist in setting up your fidesops c
       ![Open Fidesops Variables](../img/postman_images/open_fidesops_variables.png)
 
 5. Add your `OAUTH_ROOT_CLIENT_ID` and `OAUTH_ROOT_CLIENT_SECRET` under `CURRENT VALUE`.  
-      - `fidesopsadmin` and `fidesopsadmin` are default configurations for testing, found in your `fidesops.toml`. Add the appropriate values for your instance if they differ.
+      - `fidesopsadmin` and `fidesopsadminsecret` are default configurations for testing, found in your `fidesops.toml`. Add the appropriate values for your instance if they differ.
       - **Important:** Click `Save`!
 
       ![Add root client id and secret](../img/postman_images/add_root_client_id_and_secret.png)

diff --git a/docs/fidesops/docs/ui/datastores.md b/docs/fidesops/docs/ui/datastores.md
@@ -1,6 +1,44 @@
 # 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.
+Datastores represent connections to third party applications, databases and datasets, or manual storage locations.
 
-![datastore](../img/admin_ui/datastore.png)
+![datastore](../img/admin_ui/datastore_list.png)
 
+
+## Viewing Datastores
+
+All currently configured datastores will appear in the paginated Datastore Connections panel. Search options are available to filter the datastore list.
+
+`Active` datastores are included when fulfilling privacy requests.
+
+`Disabled` datastores have their connection information saved, but are not included when privacy requests are executed.
+### Panel Options
+| Option | Description |
+|----|----|
+| Search | Retrieve a datastore by name. |
+| Datastore Type | Filter datastores by type: SaaS, Postgres, Mongo, etc. |
+| System Type | Filter datastores by system: SaaS, Database, or Manual. |
+| Testing Status | Filter stores by the result of their last test: Passed, Failed, or Untested. |
+| Status | Filter datastores by status: Active or Disabled. |
+
+## Testing datastores
+Each configured datastore includes an option to `Test` its connection. Fidesops will record the last tested time to the datastore's card, and update the current connection status. 
+
+`Green` connections have passed their most recent test. 
+
+`Red` connections have failed.
+
+`Grey` connections have not been tested.
+
+![failed test](../img/admin_ui/failed_test.png)
+
+
+## Disabling and deleting datastores
+
+Selecting the three dots menu `[...]` beside a datastore's connection status will bring up `Disable` and `Delete` options for that datastore.
+
+![datastore options](../img/admin_ui/datastore_options.png)
+
+Selecting either Disable or Delete will display a warning to confirm the action. Deleted datastores will have their connection information removed entirely from Fidesops, while Disabled datastores may be enabled again from the same menu at a later date.
+
+![delete datastore](../img/admin_ui/delete_datastore.png)
diff --git a/docs/fidesops/docs/ui/subject_requests.md b/docs/fidesops/docs/ui/subject_requests.md
@@ -7,7 +7,7 @@ The FidesOps Admin UI is designed to provide easy, at-a-glance access to submitt
 ### Panel Options
 | Option | Description |
 |----|----|
-| Status | Requests can be filtered by their current status: **Error**, **Denied**, **In Progress**, **New**, *Cancelled*, and **Complete**.|
+| Status | Requests can be filtered by their current status: **Error**, **Denied**, **In Progress**, **New**, **Canceled**, 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. |
@@ -24,7 +24,7 @@ Hovering over a request row will provide access to the **approve** and **deny**
 
 **Denying** a request allows the user to input a denial reason before confirming the action.
 
-![request denial](request_denial.png)
+![request denial](../img/admin_ui/request_denial.png)
 
 ## View Request Details
 ![subject request details](../img/admin_ui/subject_request_details.png)