diff --git a/docs/docs/documentation/administration/_category_.json b/docs/docs/documentation/administration/_category_.json index b1887e41a..6119399ee 100644 --- a/docs/docs/documentation/administration/_category_.json +++ b/docs/docs/documentation/administration/_category_.json @@ -2,6 +2,7 @@ "label": "Administration", "position": 4, "link": { - "type": "generated-index" + "type": "doc", + "id": "index" } } \ No newline at end of file diff --git a/docs/docs/documentation/administration/blueprints/_category_.json b/docs/docs/documentation/administration/blueprints/_category_.json index 4a6345c91..710f064d8 100644 --- a/docs/docs/documentation/administration/blueprints/_category_.json +++ b/docs/docs/documentation/administration/blueprints/_category_.json @@ -2,6 +2,7 @@ "label": "Blueprints", "position": 2, "link": { - "type": "generated-index" + "type": "doc", + "id": "index" } } \ No newline at end of file diff --git a/docs/docs/documentation/administration/blueprints/index.md b/docs/docs/documentation/administration/blueprints/index.md new file mode 100644 index 000000000..70a86910e --- /dev/null +++ b/docs/docs/documentation/administration/blueprints/index.md @@ -0,0 +1,5 @@ +# Blueprints + +import DocCardList from '@theme/DocCardList'; + + \ No newline at end of file diff --git a/docs/docs/documentation/administration/index.md b/docs/docs/documentation/administration/index.md new file mode 100644 index 000000000..201b509b7 --- /dev/null +++ b/docs/docs/documentation/administration/index.md @@ -0,0 +1,9 @@ +# Administration + +There are a lot of tools developed that can help administrators better manage a lot of aspects of the application or get a better idea about the usage of the platform. + +These tools will be described in this section. + +import DocCardList from '@theme/DocCardList'; + + \ No newline at end of file diff --git a/docs/docs/documentation/administration/introduction.md b/docs/docs/documentation/administration/introduction.md index 4fd6418bb..fd12980e6 100644 --- a/docs/docs/documentation/administration/introduction.md +++ b/docs/docs/documentation/administration/introduction.md @@ -2,4 +2,11 @@ sidebar_position: 1 --- -# Introduction \ No newline at end of file +# Introduction + +There are a lot of views in the application available only for users that are given elevated privileges. In the pages that follow we will discover all the configuration options available in these views for an administrator, with the most important being the following: + +- **Users**: Being able to control the users of the platform. +- **Tenants**: Being able to control the tenants of the platform. Think of tenants as different organisations that can use the application independently at the same time without the need of different deployments. +- **Notification Templates**: Being able to modify the structure of notifications sent to users based on different events. +- **Languages**: Being able to add support for more languages or modify existing ones. \ No newline at end of file diff --git a/docs/docs/documentation/administration/templates/_category_.json b/docs/docs/documentation/administration/templates/_category_.json index 2d8ec47cb..a6d5a5caa 100644 --- a/docs/docs/documentation/administration/templates/_category_.json +++ b/docs/docs/documentation/administration/templates/_category_.json @@ -2,6 +2,7 @@ "label": "Templates", "position": 4, "link": { - "type": "generated-index" + "type": "doc", + "id": "index" } } \ No newline at end of file diff --git a/docs/docs/documentation/administration/templates/index.md b/docs/docs/documentation/administration/templates/index.md new file mode 100644 index 000000000..d69a60ead --- /dev/null +++ b/docs/docs/documentation/administration/templates/index.md @@ -0,0 +1,5 @@ +# Templates + +import DocCardList from '@theme/DocCardList'; + + \ No newline at end of file diff --git a/docs/docs/documentation/administration/tenants.md b/docs/docs/documentation/administration/tenants.md index 3fde922cb..52ad512bd 100644 --- a/docs/docs/documentation/administration/tenants.md +++ b/docs/docs/documentation/administration/tenants.md @@ -2,4 +2,36 @@ sidebar_position: 7 --- -# Tenants \ No newline at end of file +# Tenants + +In this page, there is a listing where you can view details about all the available tenants. + +The information displayed by default is: the `display name` of the tenants, the `status`, the `identification code` and timestamps for the `creation` and `updates` of the records. At the top right corner of the listing you can also select which columns to display. + +:::tip + +For tenants, all the columns are visible by default. + +::: + +You can also create new or edit / remove tenants by clicking to the `Create Tenant` button at the top right of the page or to the three dots at the last column, respectively. + +## Authorization + +Only users that have the **Admin** role can access this page. + +## 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 is a filtering option available for tenants. + +- **Is Active**: By toggling this control you can view only the active or only the disabled tenants.
*By default, this option is set to true.* + +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. \ No newline at end of file diff --git a/docs/docs/documentation/administration/users.md b/docs/docs/documentation/administration/users.md index a34c624e0..e2c1d82e8 100644 --- a/docs/docs/documentation/administration/users.md +++ b/docs/docs/documentation/administration/users.md @@ -2,4 +2,37 @@ sidebar_position: 6 --- -# Users \ No newline at end of file +# Users + +In this page, there is a listing where you can view details about all the registered users. + +The information displayed by default is: the `name` of the users, the `status` of their accounts and timestamps for the `creation` and `updates` of the records. At the top right corner of the listing you can also select which columns to display. + +:::tip + +For users, there is a column for `emails`, hidden by default. + +::: + +You can also assign new or remove assigned roles from users by clicking to the icon next to the roles column. When you click it, a multiselect dropdown is made available in the roles column. + +## Authorization + +Only users that have the **Admin** role can access this page. + +## 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 users.
*By default, this option is set to true.* +- **Roles**: You can filter users by their assigned roles. You can select one or more roles.
*By default, no role 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. \ No newline at end of file diff --git a/docs/docusaurus.config.ts b/docs/docusaurus.config.ts index 4aabd740a..0a1e90f91 100644 --- a/docs/docusaurus.config.ts +++ b/docs/docusaurus.config.ts @@ -93,6 +93,22 @@ const config: Config = { label: 'Getting Started', to: '/docs/category/getting-started', }, + { + label: 'Application', + to: '/docs/category/application', + }, + { + label: 'Supplementary Services', + to: '/docs/category/supplementary-services', + }, + { + label: 'Administration', + to: '/docs/documentation/administration', + }, + { + label: 'For Developers', + to: '/docs/category/for-developers', + }, ], }, {