[ci skip] Autodoc commit for 9775782.

develop/_sources/release-notes/v4.0-release-notes.rst.txt

@@ -13,11 +13,13 @@ Acknowledgments
 
 Thank you to all of the community members who contributed code, suggestions, bug reports, and other assistance across the project!
 
-We want to thank Lenoard Wisniewski, Aday Bujeda, and Michael Reekie at Harvard University: Institute for Quantitative Social Science for their contributions around widgets for saved settings and XDMoD, required and dismissible announcements, a configurable number of applications in the apps table, modular support for custom Javascript files, and additional support for OnDemand extensions and customizations. 
+We want to thank: 
 
-Additionally, we want to thank Robin Karlsson at CSC - IT Center for Science for his contributions around application cards, improving large file upload and allowlist handling, bug fixes for partial file paths and the file browser, and file success if chown fails. And Simon Westersund at CSC - IT Center for Science for his contributions around cleaning PUNs and associated files of disabled users. 
+Leonard Wisniewski, Aday Bujeda, and Michael Reekie at Harvard University: Institute for Quantitative Social Science for their contributions around widgets for saved settings and XDMoD, required and dismissible announcements, a configurable number of applications in the apps table, modular support for custom Javascript files, and additional support for OnDemand extensions and customizations.
 
-We'd also like to give a big thank you to those listed below for their first time contributing to this release:
+Robin Karlsson at CSC - IT Center for Science for his contributions around application cards, improving large file upload and allowlist handling, bug fixes for partial file paths and the file browser, and file success if chown fails and Simon Westersund at CSC - IT Center for Science for his contributions around cleaning PUNs and associated files of disabled users. 
+
+We'd also like to give a big thank you to those listed below for their first time contributing to Open OnDemand in this release:
 
 * ``NucciTheBoss`` made their first contribution in #3371
 * ``codecat555`` made their first contribution in #3424
@@ -44,16 +46,16 @@ NavConfig Has Been Removed.
 
 .. include:: navconfig.inc
 
-Configurations whitelist and blacklist Have Been Removed.
-.........................................................
+Configurations "whitelist" and "blacklist" Have Been Removed.
+.............................................................
 
 .. include:: allowlist.inc
 
 Announcements Are Dismissible by Default.
 .........................................
 
-In version 4.0, :ref:`configure_announcements` now have the ability to be ``dismissible``.
-Meaning users can press ``OK`` on the announcement and it will no longer appear
+In version 4.0, :ref:`configure_announcements` now have the ability to be ``dismissible``,
+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.
@@ -89,7 +91,7 @@ Root-Owned Configuration Files
 ..............................
 
 In an effort to increase the security of the Open OnDemand platform,
-the system will now start to only respond to root-owned configuration
+the system will now only respond to root-owned configuration
 files.
 
 This means that all configuration files in ``/etc/ood/config``
@@ -155,10 +157,10 @@ breaking change above.
 Along with that breaking change, there is also a very exciting feature you now use:
 *required* announcements.
 
-*Required* annoucements must be accepted before any page can be loaded. This is useful
+*Required* announcements must be accepted before any page can be loaded. This is useful
 to present users with a Terms of Service (TOS) or End User License Agreement (EULA)
 or similar.  The users will not be able to do anything with Open OnDemand until they've
-accepted this annoucments.
+accepted these announcements.
 
 Global Batch Connect Items
 ..........................
@@ -201,7 +203,7 @@ System Status Application
 
 Your center may have deployed the `OSC System Status Application`_.
 
-Version 4.0 now includes this application natively, though it
+Version 4.0 now includes this application natively, although it
 currently supports only Slurm clusters.
 
 Here's an example image from OSC detailing the system status of
@@ -223,14 +225,14 @@ the form item or ``false`` to show the form item.
 
 Responding to ``false`` is new feature in version 4.0.
 
-This was added as a convenience for some forms 
+This was added as a convenience for some forms.
 
 New data-label Directive
 ........................
 
 Version 4.0 adds the ``data-label`` directive.  This is used to update
 the help text on a given form when certain choices are made. An example of
-may be a ``node_type`` select widget that can change it's help text based
+this may be a ``node_type`` select widget that can change its help text based
 on which node type the user has selected.
 
 :ref:`dynamic-bc-apps-data-label` is the complete documentation for this
@@ -271,7 +273,7 @@ as head nodes, where the Lmod environment modules are set up.
 XDMoD Efficiency Widget Update
 ..............................
 
-XDMoD job details widget now displays job efficiency calculations
+The XDMoD job details widget now displays job efficiency calculations
 for CPU usage, memory usage and elapsed time.
 
 Prior versions of Open OnDemand only showed efficiency calculations

develop/release-notes/v3.0-release-notes.html

@@ -297,8 +297,8 @@ <h4>NavConfig is deprecated<a class="headerlink" href="#navconfig-is-deprecated"
 <section id="whitelist-blacklist-configurations-are-deprecated">
 <h4>whitelist &amp; blacklist configurations are deprecated<a class="headerlink" href="#whitelist-blacklist-configurations-are-deprecated" title="Link to this heading"></a></h4>
 <p>These configurations have been updated to use more inclusive language.</p>
-<p>Configurations that have whitelist or blacklist in the name have been deprecated
-in version 3.0 and replaced with allowlist or blocklist respectively in version 4.0.</p>
+<p>Configurations that have “whitelist” or “blacklist” in the name have been deprecated
+in version 3.0 and replaced with “allowlist” or “blocklist” respectively in version 4.0.</p>
 <p>The configurations <code class="docutils literal notranslate"><span class="pre">maintenance_ip_whitelist</span></code> for configuring maintenance IPs
 has been replaced by <code class="docutils literal notranslate"><span class="pre">maintenance_ip_allowlist</span></code>.</p>
 <p>The <code class="docutils literal notranslate"><span class="pre">WHITELIST_PATH</span></code> environment variable for configuring inaccessible paths

develop/release-notes/v4.0-release-notes.html

@@ -94,7 +94,7 @@
 <li class="toctree-l3"><a class="reference internal" href="#breaking-changes">Breaking Changes</a><ul>
 <li class="toctree-l4"><a class="reference internal" href="#autoloading-during-initialization-has-been-removed">Autoloading During Initialization Has Been Removed.</a></li>
 <li class="toctree-l4"><a class="reference internal" href="#navconfig-has-been-removed">NavConfig Has Been Removed.</a></li>
-<li class="toctree-l4"><a class="reference internal" href="#configurations-whitelist-and-blacklist-have-been-removed">Configurations whitelist and blacklist Have Been Removed.</a></li>
+<li class="toctree-l4"><a class="reference internal" href="#configurations-whitelist-and-blacklist-have-been-removed">Configurations “whitelist” and “blacklist” Have Been Removed.</a></li>
 <li class="toctree-l4"><a class="reference internal" href="#announcements-are-dismissible-by-default">Announcements Are Dismissible by Default.</a></li>
 <li class="toctree-l4"><a class="reference internal" href="#batch-connect-form-identifiers-are-now-lowercase">Batch Connect Form Identifiers Are Now Lowercase.</a></li>
 <li class="toctree-l4"><a class="reference internal" href="#root-owned-configuration-files">Root-Owned Configuration Files</a></li>
@@ -179,7 +179,7 @@
 <ul>
 <li><p><a class="reference internal" href="#autoloading-during-initialization-has-been-removed" id="id4">Autoloading During Initialization Has Been Removed.</a></p></li>
 <li><p><a class="reference internal" href="#navconfig-has-been-removed" id="id5">NavConfig Has Been Removed.</a></p></li>
-<li><p><a class="reference internal" href="#configurations-whitelist-and-blacklist-have-been-removed" id="id6">Configurations whitelist and blacklist Have Been Removed.</a></p></li>
+<li><p><a class="reference internal" href="#configurations-whitelist-and-blacklist-have-been-removed" id="id6">Configurations “whitelist” and “blacklist” Have Been Removed.</a></p></li>
 <li><p><a class="reference internal" href="#announcements-are-dismissible-by-default" id="id7">Announcements Are Dismissible by Default.</a></p></li>
 <li><p><a class="reference internal" href="#batch-connect-form-identifiers-are-now-lowercase" id="id8">Batch Connect Form Identifiers Are Now Lowercase.</a></p></li>
 <li><p><a class="reference internal" href="#root-owned-configuration-files" id="id9">Root-Owned Configuration Files</a></p></li>
@@ -216,9 +216,10 @@
 <section id="acknowledgments">
 <h2><a class="toc-backref" href="#id2" role="doc-backlink">Acknowledgments</a><a class="headerlink" href="#acknowledgments" title="Link to this heading"></a></h2>
 <p>Thank you to all of the community members who contributed code, suggestions, bug reports, and other assistance across the project!</p>
-<p>We want to thank Lenoard Wisniewski, Aday Bujeda, and Michael Reekie at Harvard University: Institute for Quantitative Social Science for their contributions around widgets for saved settings and XDMoD, required and dismissible announcements, a configurable number of applications in the apps table, modular support for custom Javascript files, and additional support for OnDemand extensions and customizations.</p>
-<p>Additionally, we want to thank Robin Karlsson at CSC - IT Center for Science for his contributions around application cards, improving large file upload and allowlist handling, bug fixes for partial file paths and the file browser, and file success if chown fails. And Simon Westersund at CSC - IT Center for Science for his contributions around cleaning PUNs and associated files of disabled users.</p>
-<p>We’d also like to give a big thank you to those listed below for their first time contributing to this release:</p>
+<p>We want to thank:</p>
+<p>Leonard Wisniewski, Aday Bujeda, and Michael Reekie at Harvard University: Institute for Quantitative Social Science for their contributions around widgets for saved settings and XDMoD, required and dismissible announcements, a configurable number of applications in the apps table, modular support for custom Javascript files, and additional support for OnDemand extensions and customizations.</p>
+<p>Robin Karlsson at CSC - IT Center for Science for his contributions around application cards, improving large file upload and allowlist handling, bug fixes for partial file paths and the file browser, and file success if chown fails and Simon Westersund at CSC - IT Center for Science for his contributions around cleaning PUNs and associated files of disabled users.</p>
+<p>We’d also like to give a big thank you to those listed below for their first time contributing to Open OnDemand in this release:</p>
 <ul class="simple">
 <li><p><code class="docutils literal notranslate"><span class="pre">NucciTheBoss</span></code> made their first contribution in #3371</p></li>
 <li><p><code class="docutils literal notranslate"><span class="pre">codecat555</span></code> made their first contribution in #3424</p></li>
@@ -270,10 +271,10 @@ <h3><a class="toc-backref" href="#id5" role="doc-backlink">NavConfig Has Been Re
 <a class="reference internal" href="../reference/files/ondemand-d-ymls.html#nav-categories"><span class="std std-ref">nav_categories configuration property</span></a> for more details.</p>
 </section>
 <section id="configurations-whitelist-and-blacklist-have-been-removed">
-<h3><a class="toc-backref" href="#id6" role="doc-backlink">Configurations whitelist and blacklist Have Been Removed.</a><a class="headerlink" href="#configurations-whitelist-and-blacklist-have-been-removed" title="Link to this heading"></a></h3>
+<h3><a class="toc-backref" href="#id6" role="doc-backlink">Configurations “whitelist” and “blacklist” Have Been Removed.</a><a class="headerlink" href="#configurations-whitelist-and-blacklist-have-been-removed" title="Link to this heading"></a></h3>
 <p>These configurations have been updated to use more inclusive language.</p>
-<p>Configurations that have whitelist or blacklist in the name have been deprecated
-in version 3.0 and replaced with allowlist or blocklist respectively in version 4.0.</p>
+<p>Configurations that have “whitelist” or “blacklist” in the name have been deprecated
+in version 3.0 and replaced with “allowlist” or “blocklist” respectively in version 4.0.</p>
 <p>The configurations <code class="docutils literal notranslate"><span class="pre">maintenance_ip_whitelist</span></code> for configuring maintenance IPs
 has been replaced by <code class="docutils literal notranslate"><span class="pre">maintenance_ip_allowlist</span></code>.</p>
 <p>The <code class="docutils literal notranslate"><span class="pre">WHITELIST_PATH</span></code> environment variable for configuring inaccessible paths
@@ -284,8 +285,8 @@ <h3><a class="toc-backref" href="#id6" role="doc-backlink">Configurations whitel
 </section>
 <section id="announcements-are-dismissible-by-default">
 <h3><a class="toc-backref" href="#id7" role="doc-backlink">Announcements Are Dismissible by Default.</a><a class="headerlink" href="#announcements-are-dismissible-by-default" title="Link to this heading"></a></h3>
-<p>In version 4.0, <a class="reference internal" href="../customizations.html#configure-announcements"><span class="std std-ref">Announcements</span></a> now have the ability to be <code class="docutils literal notranslate"><span class="pre">dismissible</span></code>.
-Meaning users can press <code class="docutils literal notranslate"><span class="pre">OK</span></code> on the announcement and it will no longer appear
+<p>In version 4.0, <a class="reference internal" href="../customizations.html#configure-announcements"><span class="std std-ref">Announcements</span></a> now have the ability to be <code class="docutils literal notranslate"><span class="pre">dismissible</span></code>,
+meaning users can press <code class="docutils literal notranslate"><span class="pre">OK</span></code> on the announcement and it will no longer appear
 on the pages.</p>
 <p>In prior versions of Open OnDemand, there was no way to dismiss or get rid of announcements.
 Now in version 4.0, not only is there a way to dismiss announcements, announcements
@@ -313,7 +314,7 @@ <h3><a class="toc-backref" href="#id8" role="doc-backlink">Batch Connect Form Id
 <section id="root-owned-configuration-files">
 <h3><a class="toc-backref" href="#id9" role="doc-backlink">Root-Owned Configuration Files</a><a class="headerlink" href="#root-owned-configuration-files" title="Link to this heading"></a></h3>
 <p>In an effort to increase the security of the Open OnDemand platform,
-the system will now start to only respond to root-owned configuration
+the system will now only respond to root-owned configuration
 files.</p>
 <p>This means that all configuration files in <code class="docutils literal notranslate"><span class="pre">/etc/ood/config</span></code>
 will need to be owned by the <code class="docutils literal notranslate"><span class="pre">root</span></code> user (uid 0) in order to be used.</p>
@@ -375,10 +376,10 @@ <h3><a class="toc-backref" href="#id15" role="doc-backlink">Required Announcemen
 breaking change above.</p>
 <p>Along with that breaking change, there is also a very exciting feature you now use:
 <em>required</em> announcements.</p>
-<p><em>Required</em> annoucements must be accepted before any page can be loaded. This is useful
+<p><em>Required</em> announcements must be accepted before any page can be loaded. This is useful
 to present users with a Terms of Service (TOS) or End User License Agreement (EULA)
 or similar.  The users will not be able to do anything with Open OnDemand until they’ve
-accepted this annoucments.</p>
+accepted these announcements.</p>
 </section>
 <section id="global-batch-connect-items">
 <h3><a class="toc-backref" href="#id16" role="doc-backlink">Global Batch Connect Items</a><a class="headerlink" href="#global-batch-connect-items" title="Link to this heading"></a></h3>
@@ -412,7 +413,7 @@ <h3><a class="toc-backref" href="#id18" role="doc-backlink">Batch Connect Sessio
 <section id="system-status-application">
 <h3><a class="toc-backref" href="#id19" role="doc-backlink">System Status Application</a><a class="headerlink" href="#system-status-application" title="Link to this heading"></a></h3>
 <p>Your center may have deployed the <a class="reference external" href="https://github.com/osc/osc-systemstatus.">OSC System Status Application</a>.</p>
-<p>Version 4.0 now includes this application natively, though it
+<p>Version 4.0 now includes this application natively, although it
 currently supports only Slurm clusters.</p>
 <p>Here’s an example image from OSC detailing the system status of
 our clusters.</p>
@@ -428,13 +429,13 @@ <h3><a class="toc-backref" href="#id20" role="doc-backlink">data-hide Directives
 <p><code class="docutils literal notranslate"><span class="pre">data-hide</span></code> directives now respond to both <code class="docutils literal notranslate"><span class="pre">true</span></code> to hide
 the form item or <code class="docutils literal notranslate"><span class="pre">false</span></code> to show the form item.</p>
 <p>Responding to <code class="docutils literal notranslate"><span class="pre">false</span></code> is new feature in version 4.0.</p>
-<p>This was added as a convenience for some forms</p>
+<p>This was added as a convenience for some forms.</p>
 </section>
 <section id="new-data-label-directive">
 <h3><a class="toc-backref" href="#id21" role="doc-backlink">New data-label Directive</a><a class="headerlink" href="#new-data-label-directive" title="Link to this heading"></a></h3>
 <p>Version 4.0 adds the <code class="docutils literal notranslate"><span class="pre">data-label</span></code> directive.  This is used to update
 the help text on a given form when certain choices are made. An example of
-may be a <code class="docutils literal notranslate"><span class="pre">node_type</span></code> select widget that can change it’s help text based
+this may be a <code class="docutils literal notranslate"><span class="pre">node_type</span></code> select widget that can change its help text based
 on which node type the user has selected.</p>
 <p><a class="reference internal" href="../how-tos/app-development/interactive/dynamic-form-widgets.html#dynamic-bc-apps-data-label"><span class="std std-ref">Dynamic Element Labels</span></a> is the complete documentation for this
 feature.</p>
@@ -467,7 +468,7 @@ <h3><a class="toc-backref" href="#id24" role="doc-backlink">Removed Runtime Depe
 </section>
 <section id="xdmod-efficiency-widget-update">
 <h3><a class="toc-backref" href="#id25" role="doc-backlink">XDMoD Efficiency Widget Update</a><a class="headerlink" href="#xdmod-efficiency-widget-update" title="Link to this heading"></a></h3>
-<p>XDMoD job details widget now displays job efficiency calculations
+<p>The XDMoD job details widget now displays job efficiency calculations
 for CPU usage, memory usage and elapsed time.</p>
 <p>Prior versions of Open OnDemand only showed efficiency calculations
 for CPU.</p>