From 2a14cd73340d3c366969bf2c550078a9015608b9 Mon Sep 17 00:00:00 2001 From: Thomas Georgios Giannos Date: Mon, 15 Jul 2024 12:48:08 +0300 Subject: [PATCH] Docusaurus fixes, added docs for usage limits --- .../administration/annotation-statuses.md | 2 +- .../administration/entity-locks.md | 2 +- .../documentation/administration/tenants.md | 2 +- .../administration/usage-limits.md | 57 +++++++++++++++++++ 4 files changed, 60 insertions(+), 3 deletions(-) create mode 100644 docs/docs/documentation/administration/usage-limits.md diff --git a/docs/docs/documentation/administration/annotation-statuses.md b/docs/docs/documentation/administration/annotation-statuses.md index 2264e2a87..a29b365aa 100644 --- a/docs/docs/documentation/administration/annotation-statuses.md +++ b/docs/docs/documentation/administration/annotation-statuses.md @@ -7,7 +7,7 @@ description: Manage all annotation statuses In this page, there is a listing where you can view details about all the available annotation statuses. You can view details about the annotation service [here](/docs/documentation/supplementary-services/annotations). -The information displayed by default is: the `label`, the `internal status` which is the system specific status, the `status` of the entity and timestamps for the `creation` and `updating` of the entites. At the top right corner of the listing you can also select which columns to display. +The information displayed by default is: the `label`, the `internal status` which is the system specific status, the `status` of the entity and timestamps for the `creation` and `updating` of the entities. At the top right corner of the listing you can also select which columns to display. :::tip diff --git a/docs/docs/documentation/administration/entity-locks.md b/docs/docs/documentation/administration/entity-locks.md index e2efcdbd6..375952df8 100644 --- a/docs/docs/documentation/administration/entity-locks.md +++ b/docs/docs/documentation/administration/entity-locks.md @@ -5,7 +5,7 @@ description: Manage all entity locks # Entity Locks -In this page, there is a listing where you can view details about all the actively locked entites. +In this page, there is a listing where you can view details about all the actively locked entities. :::info diff --git a/docs/docs/documentation/administration/tenants.md b/docs/docs/documentation/administration/tenants.md index 3376c81f5..ecb791baf 100644 --- a/docs/docs/documentation/administration/tenants.md +++ b/docs/docs/documentation/administration/tenants.md @@ -65,6 +65,6 @@ There are two ways a user can change the tenant scope. :::tip -The options to change the tenant scope are only available when the logged in user belongs to one or more tenants. Otherwise, the user is attached only to the default tenant. Also, system administrators can select from all the available tenants. +The options to change the tenant scope are only available when the logged in user belongs to one or more tenants. Otherwise, the user is attached only to the default tenant. Also, system administrators which are users having the global `Admin` role can select from all the available tenants. ::: \ No newline at end of file diff --git a/docs/docs/documentation/administration/usage-limits.md b/docs/docs/documentation/administration/usage-limits.md new file mode 100644 index 000000000..03cedcab7 --- /dev/null +++ b/docs/docs/documentation/administration/usage-limits.md @@ -0,0 +1,57 @@ +--- +sidebar_position: 15 +description: Manage all usage limits +--- + +# Usage Limits + +In this page, there is a listing where you can view details about all the usage limits set on different resourses. These limits are [tenant](/docs/documentation/administration/tenants) spesific, meaning that you view only the limits that are set on a tenant you have selected from the ones you manage. + +The information displayed by default is: the `label`, the `target metric` which is the resource metric this limit is enforced on, the `limit` value, the `status` of the entity and timestamps for the `creation` and `updating` of the entities. At the top right corner of the listing you can also select which columns to display. + +:::tip + +For usage limits, all the columns are visible by default. + +::: + +You can edit or remove a limit by clicking on the three dots on the far right corner of the records and then select `Edit` or `Delete` respectively. + +## Authorization + +Only users that have the global **Admin** role can access this page. + +## Navigation + +This view is available when the user presses the `Usage Limits` link from the side navigation menu. + +## Pagination + +Not all the records are being displayed at once. By default, there is a pagination of 10 records applied to them. + +You can control how many records are being displayed at any time, by adjusting the `items per page` control at the bottom left corner of the table. + +## Filtering + +There are some filtering options available for users. + +- **Is Active**: By toggling this control you can view only the active or only the disabled usage limits.
*By default, this option is set to true.* +- **Type**: You can filter limits by the metric they are enforced uppon. You can select one or more metrics.
*By default, no metric is selected.* + +In order for the filters to apply, you have to click the `Apply filters` button. + +You can also clear any filters already applied, by pressing the `clear all filters` option, located at the top of the popup. + +--- + +## Edit form + +You can add a limit to your selected tenant by clicking on the `Create Usage Limit` button at the top right corner of the screen, above the listing. + +In the form, you can specify the following: + +- **Label**: The label of the limit. +- **Target Metric**: The metric this limit will be enforced uppon. +- **Value**: The value of the limit. When set, the target metric will not be able to exceed this value. + +When done, you can either save your changes by pressing the `Save` button, or discard them by pressing the `Cancel` button which redirects you back to the listing page. \ No newline at end of file