Skip to content

Commit a9421a2

Browse files
docs(config): correct/clarify entry for profile.enabled (User Profiles)
- Adds explanation of feature - Prevents confusion with the Profiler parameter(s) Signed-off-by: Josh <josh.t.richards@gmail.com>
1 parent 1682590 commit a9421a2

1 file changed

Lines changed: 16 additions & 2 deletions

File tree

config/config.sample.php

Lines changed: 16 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2829,9 +2829,23 @@
28292829
'diagnostics.logging.threshold' => 0,
28302830

28312831
/**
2832-
* Enable profiling globally.
2832+
* Toggle availability of user profiles.
28332833
*
2834-
* Defaults to ``true``
2834+
* User profile pages contain information that can be shared with other users,
2835+
* such as full name, phone number, organization, role, and similar fields.
2836+
*
2837+
* Profiles are enabled by default, and profile data may be used by other
2838+
* features (for example, the system address book).
2839+
*
2840+
* Profile visibility is layered: what is shared depends on a combination of
2841+
* system-wide and account-level privacy controls, and each field's visibility
2842+
* can be configured.
2843+
*
2844+
* When set to false, profile functionality is disabled instance-wide.
2845+
*
2846+
* Note: This affects user account profiles, not the developer performance profiler.
2847+
*
2848+
* Defaults to `true`
28352849
*/
28362850
'profile.enabled' => true,
28372851

0 commit comments

Comments
 (0)