Skip to content

Commit bfc9ffe

Browse files
committed
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 f7777c3 commit bfc9ffe

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
@@ -2830,9 +2830,23 @@
28302830
'diagnostics.logging.threshold' => 0,
28312831

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

0 commit comments

Comments
 (0)