Skip to content

Commit

Permalink
Merge pull request #8563 from kenjis/docs-about-config-classes
Browse files Browse the repository at this point in the history
docs: add "What are Configuration Classes?"
  • Loading branch information
kenjis authored Mar 18, 2024
2 parents 985ac9f + 5c8bc03 commit b8adef6
Show file tree
Hide file tree
Showing 2 changed files with 19 additions and 0 deletions.
17 changes: 17 additions & 0 deletions user_guide_src/source/general/configuration.rst
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,23 @@ the application configuration files in the **app/Config** folder.
:local:
:depth: 2


What are Configuration Classes?
*******************************

Configuration classes are utilized to define system default configuration values.
System configuration values are typically *static*. Configuration classes are
intended to retain the settings that configure how the application operates,
rather than responding to each user's individual settings.

It is not recommended to alter values set during the instantiation of a
configuration class later during execution. In other words, it is recommended to
treat configuration classes as immutable or readonly classes. This is especially
important if you utilize :ref:`factories-config-caching`.

Configuration values can be hard-coded in the class files or obtained from
environment variables at instantiation.

Working with Configuration Files
********************************

Expand Down
2 changes: 2 additions & 0 deletions user_guide_src/source/libraries/official_packages.rst
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,8 @@ Among the many features, it includes:
* Per-user permission overrides,
* and more...

.. _settings:

********
Settings
********
Expand Down

0 comments on commit b8adef6

Please sign in to comment.