Skip to content

Commit b5a72fc

Browse files
authored
UI: Announcement banner documentation (#517)
* UI: Announcement Banner documentation * update banner image * restructure announcement banner * add notes for announcement banner
1 parent b02ec91 commit b5a72fc

File tree

2 files changed

+59
-1
lines changed

2 files changed

+59
-1
lines changed
42.6 KB
Loading

source/adminguide/ui.rst

Lines changed: 59 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -508,7 +508,64 @@ For displaying a custom HTML in the plugin, HTML file can be stored in the Cloud
508508
|ui-custom-plugin.png|
509509

510510

511-
Instance Image Selction Customisation
511+
Announcement Banner
512+
===================
513+
514+
Admin can configure an **announcement banner** in `config.json` to display alerts or messages to all users.
515+
This banner is useful for communicating important notices such as performance issues, scheduled maintenance, or general announcements.
516+
To enable and customize the banner, use the `announcementBanner` section in the config.json file.
517+
518+
This section supports the following properties:
519+
520+
**Configuration Example**
521+
522+
.. parsed-literal::
523+
524+
"announcementBanner": {
525+
"enabled": true,
526+
"showIcon": true,
527+
"closable": true,
528+
"persistDismissal": true,
529+
"type": "warning",
530+
"message": "<strong>Performance Notice:</strong> We're experiencing high load. Some operations may be slower than usual.",
531+
"startDate": "2025-06-01T00:00:00Z",
532+
"endDate": "2025-07-16T00:00:00Z"
533+
}
534+
535+
**Banner Display Example**
536+
537+
Based on the configuration above, the following banner is shown in the user interface:
538+
539+
.. image:: /_static/images/ui-announcement-banner.png
540+
:align: center
541+
:alt: UI Announcement banner
542+
543+
--------
544+
545+
**Properties Description**
546+
547+
- **enabled**: Enables or disables the announcement banner (`true` or `false`).
548+
- **showIcon**: Displays an icon alongside the message. The icon corresponds to the banner `type`.
549+
- **closable**: Allows users to close the banner.
550+
- **persistDismissal**: Remembers the user's dismissal of the banner, so it doesn't reappear.
551+
- **type**: Specifies the type of banner. Supported values are:
552+
553+
- `info`
554+
- `warning`
555+
- `error`
556+
- `success`
557+
558+
- **message**: The HTML-formatted content displayed in the banner.
559+
- **startDate** / **endDate**: Define the visibility window for the banner using ISO 8601 format (`YYYY-MM-DDTHH:MM:SSZ`).
560+
561+
.. note::
562+
563+
- The `message` property supports basic HTML, allowing styled content such as `<strong>` tags for emphasis.
564+
- Banner's background color changes based on `type` property value. White color is used for banner if `type` is not defined or has invalid value.
565+
- Multi-line message is supported, however recommendation is to limit it to 2 lines. Content may overlap banner for more than 2 lines.
566+
567+
568+
Instance Image Selection Customisation
512569
-------------------------------------
513570

514571
In the UI, there are several forms where the user needs to select an image (template/ISO) for an instance, such as deploying an instance, reinstalling an instance, creating a VNF appliance, etc. The image selection interface for these forms can be selected by the operator based on preference by specifying properties in the UI configuration file (config.json).
@@ -523,6 +580,7 @@ The *legacy* interface will display images based on templatefilter/isofilter, i.
523580

524581
|ui-legacy-image-selection.png|
525582

583+
526584
Advanced UI Customisation
527585
~~~~~~~~~~~~~~~~~~~~~~~~~
528586

0 commit comments

Comments
 (0)