[ci skip] Autodoc commit for 0cfa52d.

develop/_sources/reference/files/ondemand-d-ymls.rst.txt

@@ -637,25 +637,26 @@ Configuration Properties
 
       module_file_dir: "/etc/reporting/modules"
 
+.. _user_settings_file:
 .. describe:: user_settings_file (String, '.ood')
 
-  The name of the file to store user settings. This file is used to store the selected profile.
-  The path to the file is managed by the configuration variable ``Configuration.dataroot``.
-  This is usually: ``~/ondemand/data/sys/dashboard``
+  The full path of the file to store user settings. This file is used to store
+  any user defined settings.
 
   Default
     A file called '.ood'.
 
     .. code-block:: yaml
 
-      user_settings_file: ".ood"
+      user_settings_file: "~/.config/ondemand/settings.yml"
 
   Example
-    Use ``user_settings.txt`` as the file name for user settings.
+    Use ``user_settings.txt`` as the file name for user settings
+    and change the path slightly.
 
     .. code-block:: yaml
 
-      user_settings_file: "user_settings.txt"
+      user_settings_file: "~/.config/local/open-ondemand/user_settings.txt"
 
 .. describe:: facl_domain (String, null)
 

develop/_sources/release-notes/v3.1-release-notes.rst.txt

@@ -6,6 +6,7 @@ v3.1 Release Notes
 Administrative changes
 ----------------------
 
+- `Breaking Changes`_
 - `Deprecations`_
 - `Dependency updates`_
 - `Upgrade directions`_
@@ -27,6 +28,25 @@ New Features
 Details of administrative changes
 ---------------------------------
 
+Breaking Changes
+................
+
+User Settings File Change
+*************************
+
+We had to change the location of the :ref:`user settings file <user_settings_file>`
+off of the ``DATAROOT`` which is cluster specific and problematic for sites that
+have separate HOME directories for each cluster.
+
+The new default location is under the ``XDG_CONFIG_HOME``. This change was made
+to accomidate sites that have separate HOME directories for each cluster.
+
+Sites who have never used this configuration do not need to do anything.
+
+Sites that have reconfigured the :ref:`user settings file <user_settings_file>`
+need to provide the full path for this file.  It's recommended that you do not
+use a path in the ``DATAROOT`` as that is cluster specific.
+
 Deprecations
 ............
 

develop/reference/files/ondemand-d-ymls.html

@@ -845,20 +845,20 @@
 </dl>
 </dd></dl>
 
-<dl class="describe">
+<span class="target" id="user-settings-file"></span><dl class="describe">
 <dt>
 <code class="sig-name descname">user_settings_file (String, '.ood')</code></dt>
-<dd><p>The name of the file to store user settings. This file is used to store the selected profile.
-The path to the file is managed by the configuration variable <code class="docutils literal notranslate"><span class="pre">Configuration.dataroot</span></code>.
-This is usually: <code class="docutils literal notranslate"><span class="pre">~/ondemand/data/sys/dashboard</span></code></p>
+<dd><p>The full path of the file to store user settings. This file is used to store
+any user defined settings.</p>
 <dl>
 <dt>Default</dt><dd><p>A file called ‘.ood’.</p>
-<div class="highlight-yaml notranslate"><div class="highlight"><pre><span></span><span class="nt">user_settings_file</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;.ood&quot;</span><span class="w"></span>
+<div class="highlight-yaml notranslate"><div class="highlight"><pre><span></span><span class="nt">user_settings_file</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;~/.config/ondemand/settings.yml&quot;</span><span class="w"></span>
 </pre></div>
 </div>
 </dd>
-<dt>Example</dt><dd><p>Use <code class="docutils literal notranslate"><span class="pre">user_settings.txt</span></code> as the file name for user settings.</p>
-<div class="highlight-yaml notranslate"><div class="highlight"><pre><span></span><span class="nt">user_settings_file</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;user_settings.txt&quot;</span><span class="w"></span>
+<dt>Example</dt><dd><p>Use <code class="docutils literal notranslate"><span class="pre">user_settings.txt</span></code> as the file name for user settings
+and change the path slightly.</p>
+<div class="highlight-yaml notranslate"><div class="highlight"><pre><span></span><span class="nt">user_settings_file</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;~/.config/local/open-ondemand/user_settings.txt&quot;</span><span class="w"></span>
 </pre></div>
 </div>
 </dd>

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

@@ -132,6 +132,7 @@
 <li class="toctree-l3"><a class="reference internal" href="#administrative-changes">Administrative changes</a></li>
 <li class="toctree-l3"><a class="reference internal" href="#new-features">New Features</a></li>
 <li class="toctree-l3"><a class="reference internal" href="#details-of-administrative-changes">Details of administrative changes</a><ul>
+<li class="toctree-l4"><a class="reference internal" href="#breaking-changes">Breaking Changes</a></li>
 <li class="toctree-l4"><a class="reference internal" href="#deprecations">Deprecations</a></li>
 <li class="toctree-l4"><a class="reference internal" href="#dependency-updates">Dependency updates</a></li>
 <li class="toctree-l4"><a class="reference internal" href="#upgrade-directions">Upgrade directions</a></li>
@@ -242,6 +243,7 @@
 <div class="section" id="administrative-changes">
 <h2>Administrative changes<a class="headerlink" href="#administrative-changes" title="Permalink to this headline">¶</a></h2>
 <ul class="simple">
+<li><p><a class="reference internal" href="#breaking-changes">Breaking Changes</a></p></li>
 <li><p><a class="reference internal" href="#deprecations">Deprecations</a></p></li>
 <li><p><a class="reference internal" href="#dependency-updates">Dependency updates</a></p></li>
 <li><p><a class="reference internal" href="#upgrade-directions">Upgrade directions</a></p></li>
@@ -264,6 +266,21 @@ <h2>New Features<a class="headerlink" href="#new-features" title="Permalink to t
 </div>
 <div class="section" id="details-of-administrative-changes">
 <h2>Details of administrative changes<a class="headerlink" href="#details-of-administrative-changes" title="Permalink to this headline">¶</a></h2>
+<div class="section" id="breaking-changes">
+<h3>Breaking Changes<a class="headerlink" href="#breaking-changes" title="Permalink to this headline">¶</a></h3>
+<div class="section" id="user-settings-file-change">
+<h4>User Settings File Change<a class="headerlink" href="#user-settings-file-change" title="Permalink to this headline">¶</a></h4>
+<p>We had to change the location of the <a class="reference internal" href="../reference/files/ondemand-d-ymls.html#user-settings-file"><span class="std std-ref">user settings file</span></a>
+off of the <code class="docutils literal notranslate"><span class="pre">DATAROOT</span></code> which is cluster specific and problematic for sites that
+have separate HOME directories for each cluster.</p>
+<p>The new default location is under the <code class="docutils literal notranslate"><span class="pre">XDG_CONFIG_HOME</span></code>. This change was made
+to accomidate sites that have separate HOME directories for each cluster.</p>
+<p>Sites who have never used this configuration do not need to do anything.</p>
+<p>Sites that have reconfigured the <a class="reference internal" href="../reference/files/ondemand-d-ymls.html#user-settings-file"><span class="std std-ref">user settings file</span></a>
+need to provide the full path for this file.  It’s recommended that you do not
+use a path in the <code class="docutils literal notranslate"><span class="pre">DATAROOT</span></code> as that is cluster specific.</p>
+</div>
+</div>
 <div class="section" id="deprecations">
 <h3>Deprecations<a class="headerlink" href="#deprecations" title="Permalink to this headline">¶</a></h3>
 <div class="section" id="redhat-centos-7-packages-deprecated">