Skip to content

Commit

Permalink
add a note about this chagne to the RNs (#929)
Browse files Browse the repository at this point in the history
  • Loading branch information
johrstrom authored Feb 7, 2024
1 parent c326384 commit 0cfa52d
Show file tree
Hide file tree
Showing 2 changed files with 27 additions and 6 deletions.
13 changes: 7 additions & 6 deletions source/reference/files/ondemand-d-ymls.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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)

Expand Down
20 changes: 20 additions & 0 deletions source/release-notes/v3.1-release-notes.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ v3.1 Release Notes
Administrative changes
----------------------

- `Breaking Changes`_
- `Deprecations`_
- `Dependency updates`_
- `Upgrade directions`_
Expand All @@ -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
............

Expand Down

0 comments on commit 0cfa52d

Please sign in to comment.