From e25ac1dd6cd20d5b64be303f93408fc731c66e1d Mon Sep 17 00:00:00 2001 From: Rishi Gupta Date: Tue, 14 Aug 2018 12:45:17 -0700 Subject: [PATCH] user docs: Add custom profile field docs. --- .../zerver/help/add-custom-profile-fields.md | 36 +++++++++++++++++++ templates/zerver/help/edit-your-profile.md | 24 +++++++++++++ templates/zerver/help/include/sidebar.md | 3 ++ .../zerver/help/view-someones-profile.md | 27 ++++++++++++++ 4 files changed, 90 insertions(+) create mode 100644 templates/zerver/help/add-custom-profile-fields.md create mode 100644 templates/zerver/help/edit-your-profile.md create mode 100644 templates/zerver/help/view-someones-profile.md diff --git a/templates/zerver/help/add-custom-profile-fields.md b/templates/zerver/help/add-custom-profile-fields.md new file mode 100644 index 0000000000..409ac6df8c --- /dev/null +++ b/templates/zerver/help/add-custom-profile-fields.md @@ -0,0 +1,36 @@ +# Add custom profile fields + +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 +of residence, birthday, manager, Twitter handle, and more. + +Custom profile fields are always optional, and do not appear in users' +profiles until they fill them out. + +## Add a custom profile field + +{settings_tab|profile-field-settings} + +1. Under **Add a new profile field**, enter a **Label**, **Hint**, and **Type**. + +1. Click **Add profile field**. + +1. Click and drag the vertical dots on the left to order the fields. + +## Profile field types + +There are several different types of fields available. + +* **Short text**: For one line responses, like "Twitter handle" or + "Job title". Responses are limited to 50 characters. +* **Long text**: For multiline responses, like "Biography". +* **Date picker**: For dates, like "Birthday". +* **Link**: For links to websites, like "LinkedIn profile". +* **List of options**: Creates a dropdown with a list of options. +* **Person picker**: For selecting other users, like "Manager" or + "Direct reports". + +## Related articles + +* [Edit your profile](/help/edit-your-profile) +* [View someone's profile](/help/view-someones-profile) diff --git a/templates/zerver/help/edit-your-profile.md b/templates/zerver/help/edit-your-profile.md new file mode 100644 index 0000000000..a797e8c0f7 --- /dev/null +++ b/templates/zerver/help/edit-your-profile.md @@ -0,0 +1,24 @@ +# Edit your profile + +By default, your profile includes your name, email, the date you joined, and +when you were last active. + +Organization administrators can also +[add custom profile fields](/help/add-custom-profile-fields). Custom profile +fields are always optional, and will not appear in your profile unless you +fill them out. + +## Edit your profile + +{settings_tab|your-account} + +1. Edit the fields under **Profile**. + +Note: The **Profile** section will only appear if an organization +administrator has added custom profile fields. + +## Related articles + +* [Change your name](/help/change-your-name) +* [Change your email address](/help/change-your-email-address) +* [View someone's profile](/help/view-someones-profile) diff --git a/templates/zerver/help/include/sidebar.md b/templates/zerver/help/include/sidebar.md index 671ed469d7..6cbd62e9b5 100644 --- a/templates/zerver/help/include/sidebar.md +++ b/templates/zerver/help/include/sidebar.md @@ -7,6 +7,7 @@ ## Account basics * [Change your name](/help/change-your-name) * [Change your email address](/help/change-your-email-address) +* [Edit your profile](/help/edit-your-profile) * [Manage your password](/help/change-your-password) * [Edit your settings](/help/change-your-settings) * [Set your avatar](/help/change-your-avatar) @@ -62,6 +63,7 @@ ## People * [Check whether someone is on-line](/help/check-whether-someone-is-here-or-away) * [Invite another user](/help/invite-a-friend-to-zulip) +* [View someone's profile](/help/view-someones-profile) ## Streams & topics * [About streams and topics](/help/about-streams-and-topics) @@ -131,6 +133,7 @@ * [Community topic edits](/help/community-topic-edits) * [Require topics in stream messages](/help/require-topics) * [Add custom emoji](/help/add-custom-emoji) +* [Add custom profile fields](/help/add-custom-profile-fields) * [Configure authentication methods](/help/configure-authentication-methods) * [Add a custom linkification filter](/help/add-a-custom-linkification-filter) diff --git a/templates/zerver/help/view-someones-profile.md b/templates/zerver/help/view-someones-profile.md new file mode 100644 index 0000000000..e3ffe0eeb6 --- /dev/null +++ b/templates/zerver/help/view-someones-profile.md @@ -0,0 +1,27 @@ +# View someone's profile + +A user's profile includes their name, email, the date they joined, when they +were last active, and any +[custom profile fields](/help/add-custom-profile-fields) they've filled out. + +## View someone's profile + +### Via the message list + +1. Click on a user's avatar. + +1. Click **View user profile**. + +### Via the right sidebar + +1. Hover over a user's name in the right sidebar. + +1. Click on the down chevron () to + the right of their name. + +1. Click **View user profile**. + +## Related articles + +* [Edit your profile](/help/edit-your-profile) +* [Add custom profile fields](/help/add-custom-profile-fields)