help: Document option to display custom profile fields in profile summary.

Adds a section explaining what this option is and how to manage it
via the settings table.

Fixes: #23018.
This commit is contained in:
David Rosa 2022-10-04 20:00:58 -04:00 committed by Tim Abbott
parent 0c80eeffd4
commit 79084d0b47
1 changed files with 31 additions and 0 deletions

View File

@ -1,5 +1,7 @@
# Add custom profile fields # Add custom profile fields
{!admin-only.md!}
By default, user profiles show their name, email, date they joined, and when By default, user profiles show their name, email, date they joined, and when
they were last active. You can also add custom profile fields like country they were last active. You can also add custom profile fields like country
of residence, birthday, manager, Twitter handle, and more. of residence, birthday, manager, Twitter handle, and more.
@ -40,6 +42,35 @@ There are several different types of fields available.
* **Person picker**: For selecting other users, like "Manager" or * **Person picker**: For selecting other users, like "Manager" or
"Direct reports". "Direct reports".
## Display custom fields in user profile summaries
Organizations may find it useful to display additional fields in a user's
profile summary, such as pronouns, GitHub username, job title, team, etc.
All field types other than "Long text" or "Person" have a checkbox option
that controls whether to display a custom field in a user's profile summary.
There's a limit to the number of custom profile fields that can be displayed
at a time. If the maximum number of fields is already selected, all unselected
checkboxes will be disabled.
{start_tabs}
{settings_tab|profile-field-settings}
1. Click the **pencil** (<i class="fa fa-pencil"></i>) icon on the profile field
you want to edit.
1. Toggle **Display in profile summary**.
4. Click **Save changes**.
!!! tip ""
You can also choose which custom profile fields will be displayed by toggling
the checkboxes in the **Summary** column of the **Custom profile fields** table.
{end_tabs}
## Related articles ## Related articles
* [Edit your profile](/help/edit-your-profile) * [Edit your profile](/help/edit-your-profile)