diff --git a/source/_static/images/content-author/maintenance-mode-on-fullscreen.webp b/source/_static/images/content-author/maintenance-mode-on-fullscreen.webp new file mode 100644 index 000000000..ea05e755c Binary files /dev/null and b/source/_static/images/content-author/maintenance-mode-on-fullscreen.webp differ diff --git a/source/_static/images/content-author/maintenance-mode-on-login.webp b/source/_static/images/content-author/maintenance-mode-on-login.webp new file mode 100644 index 000000000..51432864e Binary files /dev/null and b/source/_static/images/content-author/maintenance-mode-on-login.webp differ diff --git a/source/_static/images/content-author/maintenance-mode-on-while-working.webp b/source/_static/images/content-author/maintenance-mode-on-while-working.webp new file mode 100644 index 000000000..3187d3319 Binary files /dev/null and b/source/_static/images/content-author/maintenance-mode-on-while-working.webp differ diff --git a/source/_static/images/system-admin/main-menu/main-menu-cluster.webp b/source/_static/images/system-admin/main-menu/main-menu-cluster.webp index edb5871aa..1f8271ad1 100644 Binary files a/source/_static/images/system-admin/main-menu/main-menu-cluster.webp and b/source/_static/images/system-admin/main-menu/main-menu-cluster.webp differ diff --git a/source/_static/images/system-admin/main-menu/main-menu-settings.webp b/source/_static/images/system-admin/main-menu/main-menu-settings.webp new file mode 100644 index 000000000..1ea148090 Binary files /dev/null and b/source/_static/images/system-admin/main-menu/main-menu-settings.webp differ diff --git a/source/_static/images/system-admin/main-menu/maintenance-mode-on-confirmation.webp b/source/_static/images/system-admin/main-menu/maintenance-mode-on-confirmation.webp new file mode 100644 index 000000000..992d7de04 Binary files /dev/null and b/source/_static/images/system-admin/main-menu/maintenance-mode-on-confirmation.webp differ diff --git a/source/_static/images/system-admin/main-menu/maintenance-mode-on.webp b/source/_static/images/system-admin/main-menu/maintenance-mode-on.webp new file mode 100644 index 000000000..22bc1d1c9 Binary files /dev/null and b/source/_static/images/system-admin/main-menu/maintenance-mode-on.webp differ diff --git a/source/by-role/author/index.rst b/source/by-role/author/index.rst index 0e0388ad0..9740071c5 100644 --- a/source/by-role/author/index.rst +++ b/source/by-role/author/index.rst @@ -1,5 +1,5 @@ :is-up-to-date: True -:last-updated: 4.2.0 +:last-updated: 4.5.0 .. _author: @@ -594,6 +594,49 @@ width on your browser :width: 9% :alt: Item Types Icons - Live +| + +.. _author-maintenance-mode: + +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +Maintenance Mode |enterpriseOnly| +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +.. version_tag:: + :label: Since + :version: 4.5.0 + +Maintenance mode is a status that tells authors that Crafter Studio is under maintenance and temporarily unavailable. + +When maintenance mode is enabled while an author is working on a project, a popup informing the author that the system is +in maintenance mode will appear like below: + +.. image:: /_static/images/content-author/maintenance-mode-on-while-working.webp + :width: 65 % + :align: center + :alt: Navigating Studio - Maintenance mode on popup while working + +| + +When maintenance mode is enabled, the login screen indicates to the user that the system is under maintenance: + +.. image:: /_static/images/content-author/maintenance-mode-on-login.webp + :width: 65 % + :align: center + :alt: Navigating Studio - Maintenance mode on full screen message + +| + +After logging in when the system is in maintenance mode, this is the screen displayed: + +.. image:: /_static/images/content-author/maintenance-mode-on-fullscreen.webp + :width: 95 % + :align: center + :alt: Navigating Studio - Maintenance mode on full screen message + +| + +For more information on enabling/disabling maintenance mode, see :ref:`System Settings `. + |hr| .. _author-experience-builder-xb: diff --git a/source/includes/available-permissions-system-scope.rst b/source/includes/available-permissions-system-scope.rst index d73164f5b..7cb9743bd 100644 --- a/source/includes/available-permissions-system-scope.rst +++ b/source/includes/available-permissions-system-scope.rst @@ -106,4 +106,19 @@ The system level (global) permissions are defined in the file ``global-permissio - :base_url:`Get the local Studio instance cluster mode <_static/api/studio.html#tag/cluster/operation/getClusterMode>` - :base_url:`Get all the members of the cluster <_static/api/studio.html#tag/cluster/operation/getClusterMembers>` * - write_global_configuration - - User is permitted to write global configuration content for Studio \ No newline at end of file + - User is permitted to write global configuration content for Studio + * - system_properties_manage + - User is allowed to update, write or delete system properties. |br| + Required when using the following APIs: + + - :base_url:`Update system properties <_static/api/studio.html#tag/system/operation/updateSystemProperties>` + - :base_url:`Set system maintenance mode status <_static/api/studio.html#tag/system/operation/setMaintenanceMode>` |enterpriseOnly| + + * - system_properties_read + - User is allowed to read system properties. |br| + Required when using the following API: + + - :base_url:`Read system properties <_static/api/studio.html#tag/system/operation/getSystemProperties>` + + * - allowed_in_maintenance |enterpriseOnly| + - User is allowed to access the system APIs during maintenance mode |br| diff --git a/source/reference/modules/studio.rst b/source/reference/modules/studio.rst index a6f16b8f2..3871134e5 100644 --- a/source/reference/modules/studio.rst +++ b/source/reference/modules/studio.rst @@ -1,5 +1,5 @@ :is-up-to-date: True -:last-updated: 4.4.3 +:last-updated: 4.5.0 .. highlight:: xml @@ -5846,6 +5846,7 @@ To access the Global Config, click on the ``Navigation Menu`` icon at the top ri To find out more on what you can configure from the Global Config, see :ref:`studio-config`. +| .. _main-menu-tool-encryption-tool: @@ -5863,6 +5864,8 @@ The ``Encryption Tool`` allows the user to encrypt sensitive data such as access For more information on how to use the encryption tool, see :ref:`studio-encryption-tool`. +| + .. _nav-menu-token-management: """""""""""""""" @@ -5878,6 +5881,8 @@ create tokens for accessing a project/site in Preview. | +For more information on configuring settings for the Studio access tokens, see :ref:`studio-access-tokens` + .. _api-token: ~~~~~~~~~ @@ -5950,6 +5955,8 @@ To disable/enable a token, simply click on the slider on the right side of the t .. note:: Users needs the ``manage_access_token`` permission to create access tokens +| + .. _preview-token: ~~~~~~~~~~~~~ @@ -6008,6 +6015,58 @@ Here's an example of using the token with Curl, where ``{Generated-Preview-Token The dialog above that shows the preview token generated also shows other examples on how to use the preview token. +| + +.. _settings: + +""""""""""""""""""""""""" +Settings |enterpriseOnly| +""""""""""""""""""""""""" +.. version_tag:: + :label: Since + :version: 4.5.0 + +The ``Settings Tool`` allows the user to configure system settings, such as enabling/disabling maintenance mode. + +.. image:: /_static/images/system-admin/main-menu/main-menu-settings.webp + :alt: System Administrator - Navigation Menu Settings Tool + :align: center + :width: 70% + +| + +~~~~~~~~~~~~~~~~ +Maintenance Mode +~~~~~~~~~~~~~~~~ +Maintenance mode is a status that tells users that your CrafterCMS install is under maintenance and temporarily unavailable. +Turning on maintenance mode when making updates, functionality modifications or design changes to your CrafterCMS install +helps prevent errors and issues and allows for a smooth user experience. + +To enable/disable maintenance mode, simply toggle the switch to on or off. + +.. image:: /_static/images/system-admin/main-menu/maintenance-mode-on.webp + :alt: System Administrator - Maintenance mode toggle switch + :align: center + :width: 70% + +| + +When turning on maintenance mode, a dialog will appear to confirm you want to turn on maintenance mode. + +.. image:: /_static/images/system-admin/main-menu/maintenance-mode-on-confirmation.webp + :alt: System Administrator - Maintenance mode on confirmation dialog + :align: center + :width: 70% + +| + +Once maintenance mode is enabled, the UI will show a maintenance mode screen informing users that the system is +temporarily unavailable, as seen here: :ref:`author-maintenance-mode`. +For users with the ``allowed_in_maintenance`` permission, access to Crafter Studio/system APIs is still available +during maintenance mode. + +| + """"""" Account """""""