Skip to content

Commit b8adef6

Browse files
authored
Merge pull request #8563 from kenjis/docs-about-config-classes
docs: add "What are Configuration Classes?"
2 parents 985ac9f + 5c8bc03 commit b8adef6

File tree

2 files changed

+19
-0
lines changed

2 files changed

+19
-0
lines changed

user_guide_src/source/general/configuration.rst

+17
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,23 @@ the application configuration files in the **app/Config** folder.
1515
:local:
1616
:depth: 2
1717

18+
19+
What are Configuration Classes?
20+
*******************************
21+
22+
Configuration classes are utilized to define system default configuration values.
23+
System configuration values are typically *static*. Configuration classes are
24+
intended to retain the settings that configure how the application operates,
25+
rather than responding to each user's individual settings.
26+
27+
It is not recommended to alter values set during the instantiation of a
28+
configuration class later during execution. In other words, it is recommended to
29+
treat configuration classes as immutable or readonly classes. This is especially
30+
important if you utilize :ref:`factories-config-caching`.
31+
32+
Configuration values can be hard-coded in the class files or obtained from
33+
environment variables at instantiation.
34+
1835
Working with Configuration Files
1936
********************************
2037

user_guide_src/source/libraries/official_packages.rst

+2
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,8 @@ Among the many features, it includes:
2929
* Per-user permission overrides,
3030
* and more...
3131

32+
.. _settings:
33+
3234
********
3335
Settings
3436
********

0 commit comments

Comments
 (0)