You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@cloudstack.apache.org by we...@apache.org on 2026/09/01 18:36:30 UTC

(cloudstack-documentation) branch main updated: ui: note on section advisories (#627)

This is an automated email from the ASF dual-hosted git repository.

weizhouapache pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/cloudstack-documentation.git


The following commit(s) were added to refs/heads/main by this push:
     new d140a8bd ui: note on section advisories (#627)
d140a8bd is described below

commit d140a8bd01e3c688d82e4c78e963e18a7151bb56
Author: Abhishek Kumar <ab...@gmail.com>
AuthorDate: Wed Sep 2 00:06:24 2026 +0530

    ui: note on section advisories (#627)
    
    * ui: not on section advisories
    
    Related: https://github.com/apache/cloudstack/pull/11763
    
    Signed-off-by: Abhishek Kumar <ab...@gmail.com>
    
    * missing screenshot
    
    Signed-off-by: Abhishek Kumar <ab...@gmail.com>
    
    ---------
    
    Signed-off-by: Abhishek Kumar <ab...@gmail.com>
---
 source/_static/images/ui-section-advisories.png | Bin 0 -> 77974 bytes
 source/adminguide/ui.rst                        |  24 ++++++++++++++++++++++--
 2 files changed, 22 insertions(+), 2 deletions(-)

diff --git a/source/_static/images/ui-section-advisories.png b/source/_static/images/ui-section-advisories.png
new file mode 100644
index 00000000..87ecbf6f
Binary files /dev/null and b/source/_static/images/ui-section-advisories.png differ
diff --git a/source/adminguide/ui.rst b/source/adminguide/ui.rst
index 047d2f82..f77ddfcc 100644
--- a/source/adminguide/ui.rst
+++ b/source/adminguide/ui.rst
@@ -190,7 +190,7 @@ Users can customize the CloudStack's user interface by means of a configuration
 To change the logo, login banner, error page icon, etc. the following details can be edited in config.json:
 
 ======================================= ==================================================================================================================================================================
-Property                      Description
+Property                                Description
 ======================================= ==================================================================================================================================================================
 apiBase                                 Changes the suffix for the API endpoint
 docBase                                 Changes the base URL for the documentation
@@ -570,7 +570,7 @@ Based on the configuration above, the following banner is shown in the user inte
 
 
 Instance Image Selection Customisation
--------------------------------------
+======================================
 
 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).
 
@@ -585,6 +585,23 @@ The *legacy* interface will display images based on templatefilter/isofilter, i.
 |ui-legacy-image-selection.png|
 
 
+Advisories for Users
+====================
+
+UI shows advisories to logged-in users along with quick actions to resolve issues or fulfill prerequisites. These advisories are meant to give information to users if a prerequisite is missing or a configuration needs to be updated to allow use of a particular functionality. In the UI, they are displayed along with some actions to fix or fulfill those prerequisites.
+
+|ui-section-advisories.png|
+
+Advisories can be disabled by updating the property ``advisoriesDisabled`` to ``true`` in config.json:
+
+.. parsed-literal::
+
+   {
+      ...
+      "advisoriesDisabled": true
+      ...
+   }
+
 Advanced UI Customisation
 ~~~~~~~~~~~~~~~~~~~~~~~~~
 
@@ -708,3 +725,6 @@ The following features are no longer supported or available in the UI but are st
 
 .. |ui-login-project-view.png| image:: /_static/images/ui-login-project-view.png
    :alt: Enabling the Project field on login
+
+.. |ui-section-advisories.png| image:: /_static/images/ui-section-advisories.png
+   :alt: Advisories in the UI