mirror of
https://github.com/optim-enterprises-bv/siembol.git
synced 2025-11-01 19:07:59 +00:00
Config-editor-ui: add management view with links and actions (#494)
This commit is contained in:
@@ -1,10 +1,12 @@
|
||||
# How to add links to the siembol ui home page
|
||||
The siembol home page has an 'Explore Siembol' section at the button of its home page, as can be seen in the screenshot below. It is used for quick access to useful resources such as documentation, ticket tracking systems etc. By default there is a link to the documentation and to the issues page on the git repo.
|
||||
# How to add links to the siembol ui home page or the management page
|
||||
|
||||
## Siembol home page
|
||||
The Siembol home page has an 'Explore Siembol' section at the button of its home page, as can be seen in the screenshot below. It is used for quick access to useful resources such as documentation, ticket tracking systems etc. By default there is a link to the documentation and to the issues page on the git repo.
|
||||
|
||||

|
||||
|
||||
New links can be added from the `ui-config.json` config file.
|
||||
Below is the default config file provided where the two default links are in "homeLinks".
|
||||
Below is the default config file provided where the two default links are in "homeLinks".
|
||||
|
||||
{
|
||||
"environment": "demo",
|
||||
@@ -30,3 +32,9 @@ To add a new link you need three things:
|
||||
- the url to which the user will be redirected on clicking the link
|
||||
- the icon to be displayed; this has to be the name of a material icon (you can find them all here: https://material.io/)
|
||||
- the title to display below the icon
|
||||
|
||||
## Siembol management page
|
||||
|
||||
The Siembol [management page](./how_to_use_the_management_page.md), which is only accessible by admins of any service, has a 'Management Links' section at the top of the page, similar to the links in the home page. This can be used to add links useful to admins.
|
||||
|
||||
Links are added by the user in the `ui-config.json` file in the same way as for home links, but the key is "managementLinks".
|
||||
|
||||
@@ -1,14 +1,15 @@
|
||||
# How to manage applications
|
||||
Admin users can manage applications from the admin panel by clicking on the top right `Manage Applications` button (see screenshot below).
|
||||
Admin users can manage applications from the actions in the [management page](./how_to_use_the_management_page.md) by clicking on the `Manage Applications` button.
|
||||
|
||||
<img src="../screenshots/admin_editor.png" alt="drawing"/>
|
||||
|
||||
|
||||
This opens up a dialog similar to the own in the screenshot below, showing all the running applications for the service with their name, id, image and attributes.
|
||||
Any application can also be restarted from there.
|
||||
This opens up a dialog similar to the own in the screenshot below, showing the running applications for all services the user is an admin for with the service name, application name, id, image and attributes.
|
||||
A single application or all applications can be restarted from here. Please wait a few minutes after restarting applications and check storm UI if the new state has been released
|
||||
|
||||
<img src="../screenshots/applications_manager.png" alt="drawing"/>
|
||||
|
||||
If there are multiple applications it is possible to search through them using a filter, like in the screenshot below.
|
||||
|
||||
<img src="../screenshots/applications_manager_multiple.png" alt="drawing"/>
|
||||
> **_note:_** The `Restart All` button will always restart ALL applications even if there is a filter.
|
||||
|
||||
<img src="../screenshots/applications_manager_filter.png" alt="drawing"/>
|
||||
|
||||
|
||||
|
||||
11
docs/siembol_ui/how-tos/how_to_use_the_management_page.md
Normal file
11
docs/siembol_ui/how-tos/how_to_use_the_management_page.md
Normal file
@@ -0,0 +1,11 @@
|
||||
# How to use the management page
|
||||
|
||||
The management page can only be accessed by an admin of any service. It has two sections: one with management links and one with various actions. It can be accessed by clicking on the cog on the top right of the navigation bar.
|
||||
|
||||
<img src="../screenshots/management_page.png" alt="drawing"/>
|
||||
|
||||
## Links
|
||||
The management links are links useful to only admins. To add management links see [here](./how_to_add_links_to_siembol_ui_home_page.md).
|
||||
|
||||
## Actions
|
||||
Currently there is only one admin action: managing the running applications. This opens up a dialog which is explained in detail [here](./how_to_manage_applications.md).
|
||||
Binary file not shown.
|
Before Width: | Height: | Size: 13 KiB After Width: | Height: | Size: 59 KiB |
BIN
docs/siembol_ui/screenshots/applications_manager_filter.png
Normal file
BIN
docs/siembol_ui/screenshots/applications_manager_filter.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 46 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 86 KiB |
BIN
docs/siembol_ui/screenshots/management_page.png
Normal file
BIN
docs/siembol_ui/screenshots/management_page.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 57 KiB |
Reference in New Issue
Block a user