Release 4 updates (#1058)

* Updated announcements documentation for dismissible and required

* Updated XDMod and Announcements info in release 4.0 notes

source/customizations.rst

@@ -69,16 +69,22 @@ If the announcement file has the extension ``yml`` and is a yaml file it is firs
    * - Key
      - Description
    * - type
-     - The type of announcment. Values can be ``warning``, ``info``, ``success``, or ``danger``.
+     - The type of announcement. Values can be ``warning``, ``info``, ``success``, or ``danger``.
    * - msg
      - The announcement's message.
-   * - dismissable
-     - Specify if the announcment is dismissable or not with ``true`` or ``false``.
+   * - id
+     - Optional unique identifier for the announcement. This is useful for managing changes to announcements that are used as ToS or EULA that users need to agree to.
+       When provided, it will be used to validate if the announcement has been dismissed regardless of the content. Changing the ``id`` will make the announcement appear again.
+   * - dismissible
+     - Specify if the announcement is dismissible or not with ``true`` or ``false``.
        Defaults to ``true``.
    * - required
-     - Specify if the announcment is required or not with ``true`` or ``false``.
-       Defaults to ``false``. When this is set to ``true``, the user will not be
-       do anything until the announcment has been accepted.
+     - Specify if the announcement is required or not with ``true`` or ``false``.
+       Defaults to ``false``. When this is set to ``true``, the OOD UI will only render the announcement and the user will not be able
+       to submit jobs until the announcement has been accepted.
+   * - button_text
+     - Optional parameter to customize the text content for the button to dismiss the announcement.
+       Defaults to ``Accept`` for required and ``OK`` for dismissible.
 
 .. tip::
   You can use ``required`` announcements to present users with a ToS (terms of service),

source/release-notes/v4.0-release-notes.rst

@@ -37,7 +37,7 @@ Announcements are Dismissible by Default.
 .........................................
 
 In 4.0, :ref:`configure_announcements` now have the ability to be ``dismissible``.
-Meaning users can press ``OK`` on the announment and it will no longer appear
+Meaning users can press ``OK`` on the announcement and it will no longer appear
 on the pages.
 
 In prior versions of Open OnDemand, there was no way to dismiss or get rid of announcements.
@@ -76,7 +76,7 @@ In an effort to increase the security of the Open OnDemand platform,
 the system will now start to only respond to root-owned configuration
 files.
 
-This means that all configfuration files in ``/etc/ood/config``
+This means that all configuration files in ``/etc/ood/config``
 will need to be owned by the ``root`` user (uid 0) in order to be used.
 
 While these files need to be root-owned, they can continue to have any
@@ -149,7 +149,7 @@ Batch Connect Sessions Poll Delay
 .................................
 
 When a user lands on ``My Interactive Sessions`` page,
-the client browswer will request updates by default
+the client browser will request updates by default
 every 10 seconds.
 
 Sites wanting to change this had do use the hidden environment
@@ -198,9 +198,9 @@ username collisions.
 Interactive Apps can have a Text Header
 .......................................
 
-The item ``form_header`` can be added to intereactive applications
+The item ``form_header`` can be added to interactive applications
 to display additional text in the form. Note this is different from
-the ``manifest.yml``'s ``description`` field becuase it will not be
+the ``manifest.yml``'s ``description`` field because it will not be
 displayed on hoverover.
 
 See the :ref:`form documentation for form_header <bc_form_header>`
@@ -217,7 +217,7 @@ as a head node where the Lmod environment modules are setup.
 XDMoD Efficiency Widget Update
 ..............................
 
-XDMoD job efficiency panels now show efficiency calculations
+XDMoD job details widget now show job efficiency calculations
 for CPU usage, memory and time.
 
 Edit and Delete Interactive Application Saved Settings