docs: add docs for the available query filter for workspaces and users (#7875)

BrunoQuaresma · matifali · web-flow · commit 944c42dcb604 · 2023-06-06T15:12:10.000Z
* Add docs for user filtering

* Add filter for workspace

* Apply suggestions from code review

Co-authored-by: Muhammad Atif Ali &lt;atif@coder.com&gt;

---------

Co-authored-by: Muhammad Atif Ali &lt;atif@coder.com&gt;
diff --git a/docs/admin/users.md b/docs/admin/users.md
@@ -129,3 +129,15 @@ kubectl exec -it deployment/coder /bin/bash -n coder
 
 coder reset-password <username>
 ```
+
+## User filtering
+
+In the Coder UI, you can filter your users using pre-defined filters or by utilizing the Coder's filter query. The examples provided below demonstrate how to use the Coder's filter query:
+
+- To find active users, use the filter `status:active`.
+- To find admin users, use the filter `role:admin`.
+
+The following filters are supported:
+
+- `status` - Indicates the status of the user. It can be either `active` or `suspended`.
+- `role` - Represents the role of the user. You can refer to the [TemplateRole documentation](https://pkg.go.dev/github.com/coder/coder/codersdk#TemplateRole) for a list of supported user roles.
diff --git a/docs/workspaces.md b/docs/workspaces.md
@@ -90,6 +90,19 @@ Coder stores macOS and Linux logs at the following locations:
 
 > Note: Logs are truncated once they reach 5MB in size.
 
+## Workspace filtering
+
+In the Coder UI, you can filter your workspaces using pre-defined filters or employing the Coder's filter query. Take a look at the following examples to understand how to use the Coder's filter query:
+
+- To find the workspaces that you own, use the filter `owner:me`.
+- To find workspaces that are currently running, use the filter `status:running`.
+
+The following filters are supported:
+
+- `owner` - Represents the `username` of the owner. You can also use `me` as a convenient alias for the logged-in user.
+- `template` - Specifies the name of the template.
+- `status` - Indicates the status of the workspace. For a list of supported statuses, please refer to the [WorkspaceStatus documentation](https://pkg.go.dev/github.com/coder/coder/codersdk#WorkspaceStatus).
+
 ---
 
 ## Up next
