From b773048031731366424bee268f87192ec5c9a4e9 Mon Sep 17 00:00:00 2001 From: Alya Abbott Date: Mon, 20 Sep 2021 11:51:38 -0700 Subject: [PATCH] user docs: Add documentation for configuring new user defaults. Also remove a redundant link on customize-settings-for-new-users page. --- .../organization_user_settings_defaults.hbs | 6 ++- .../configure-default-new-user-settings.md | 40 +++++++++++++++++++ .../help/customize-settings-for-new-users.md | 1 - .../customize-settings-for-new-users.md | 2 + .../zerver/help/include/sidebar_index.md | 1 + zerver/lib/markdown/help_settings_links.py | 5 +++ zerver/openapi/zulip.yaml | 14 ++++--- 7 files changed, 62 insertions(+), 7 deletions(-) create mode 100644 templates/zerver/help/configure-default-new-user-settings.md diff --git a/static/templates/settings/organization_user_settings_defaults.hbs b/static/templates/settings/organization_user_settings_defaults.hbs index 5b3c7395dc..9c04b18b19 100644 --- a/static/templates/settings/organization_user_settings_defaults.hbs +++ b/static/templates/settings/organization_user_settings_defaults.hbs @@ -1,6 +1,10 @@
- {{t "Configure the default personal preference settings for new users joining your organization." }} + {{#tr}} + Configure the default personal preference settings + for new users joining your organization. + {{#*inline "z-link"}}{{> @partial-block }}{{/inline}} + {{/tr}}
{{> display_settings prefix="realm_" for_realm_settings=true}} diff --git a/templates/zerver/help/configure-default-new-user-settings.md b/templates/zerver/help/configure-default-new-user-settings.md new file mode 100644 index 0000000000..0a50e87ad5 --- /dev/null +++ b/templates/zerver/help/configure-default-new-user-settings.md @@ -0,0 +1,40 @@ +# Configure default settings for new users + +{!admin-only.md!} + +Organization administrators can configure the default values of +personal preference settings for new users joining the +organization. This can help seemlessly customize the Zulip experience +to match how the organization in question is using Zulip. + +Existing users' preferences cannot be modified by administrators, and +users will be able to customize their own settings once they +join. Administrators can customize defaults for all personal +preference settings, including the following: + +* Display settings, including: + * Default view ([Recent topics](/help/recent-topics) vs. [All messages](/help/reading-strategies#all-messages)) + * [Light mode vs. dark mode](/help/night-mode) + * [Emoji theme](/help/emoji-and-emoticons#change-your-emoji-set) +* Notification settings, including: + * [What types of messages trigger notifications][default-notifications] + * [Configurations for email notifications](/help/configure-message-notification-emails) + +[default-notifications]: /help/stream-notifications#set-default-notifications-for-all-streams + +## How to configure default settings for new users + +{start_tabs} + +{settings_tab|default-user-settings} + +2. Review all settings and adjust as needed. + +{end_tabs} + +## Related articles + +* [Setting up your organization](/help/getting-your-organization-started-with-zulip) +* [Customize settings for new users](/help/customize-settings-for-new-users) +* [Set default streams for new users](/help/set-default-streams-for-new-users) +* [Invite users to join](/help/invite-users-to-join) diff --git a/templates/zerver/help/customize-settings-for-new-users.md b/templates/zerver/help/customize-settings-for-new-users.md index 1e3fba174e..544a75faa8 100644 --- a/templates/zerver/help/customize-settings-for-new-users.md +++ b/templates/zerver/help/customize-settings-for-new-users.md @@ -5,6 +5,5 @@ ## Related articles * [Setting up your organization](/help/getting-your-organization-started-with-zulip) -* [Set default streams for new users](/help/set-default-streams-for-new-users) * [Invite users to join](/help/invite-users-to-join) * [Getting started with Zulip](/help/getting-started-with-zulip) diff --git a/templates/zerver/help/include/customize-settings-for-new-users.md b/templates/zerver/help/include/customize-settings-for-new-users.md index 9f07d20da6..6187dd86aa 100644 --- a/templates/zerver/help/include/customize-settings-for-new-users.md +++ b/templates/zerver/help/include/customize-settings-for-new-users.md @@ -1,8 +1,10 @@ Customize settings for new users to get them off to a great start. * [Add custom profile fields](/help/add-custom-profile-fields). +* [Configure default new user settings][default-user-settings]. * [Set default streams for new users](/help/set-default-streams-for-new-users). * [Set the default language for new users][change-default-language], if it should be something other than US English. [change-default-language]: /help/change-the-default-language-for-your-organization +[default-user-settings]: /help/configure-default-new-user-settings diff --git a/templates/zerver/help/include/sidebar_index.md b/templates/zerver/help/include/sidebar_index.md index 6636bd3b44..15bf19ae77 100644 --- a/templates/zerver/help/include/sidebar_index.md +++ b/templates/zerver/help/include/sidebar_index.md @@ -146,6 +146,7 @@ * [Allow anyone to join](/help/allow-anyone-to-join-without-an-invitation) * [Deactivate or reactivate a user](/help/deactivate-or-reactivate-a-user) * [Add custom profile fields](/help/add-custom-profile-fields) +* [Configure default new user settings](/help/configure-default-new-user-settings) * [Set default language for new users](/help/change-the-default-language-for-your-organization) * [User groups](/help/user-groups) * [Restrict visibility of email addresses](/help/restrict-visibility-of-email-addresses) diff --git a/zerver/lib/markdown/help_settings_links.py b/zerver/lib/markdown/help_settings_links.py index ae5f8917b2..768f969191 100644 --- a/zerver/lib/markdown/help_settings_links.py +++ b/zerver/lib/markdown/help_settings_links.py @@ -46,6 +46,11 @@ link_mapping = { "Organization permissions", "/#organization/organization-permissions", ], + "default-user-settings": [ + "Manage organization", + "Default user settings", + "/#organization/organization-level-user-defaults", + ], "emoji-settings": ["Manage organization", "Custom emoji", "/#organization/emoji-settings"], "auth-methods": [ "Manage organization", diff --git a/zerver/openapi/zulip.yaml b/zerver/openapi/zulip.yaml index 2533cfb80b..d4e6900fdd 100644 --- a/zerver/openapi/zulip.yaml +++ b/zerver/openapi/zulip.yaml @@ -3889,8 +3889,10 @@ paths: additionalProperties: false description: | Event sent to all users in a Zulip organization when the - default settings for new users of the organization - (realm) have changed. + [default settings for new users][new-user-defaults] + of the organization (realm) have changed. + + [new-user-defaults]: /help/configure-default-new-user-settings **Changes**: New in Zulip 5.0 (feature level 95). properties: @@ -7524,9 +7526,9 @@ paths: tags: ["server_and_organizations"] x-requires-administrator: true description: | - Change the the default/initial values of - [personal preference settings](/api/update-settings) for new users - created in the organization. + Change the [default values of settings][new-user-defaults] for new users + joining the organization. Essentially all + [personal preference settings](/api/update-settings) are supported. `PATCH {{ api_url }}/v1/realm/user_settings_defaults` @@ -7541,6 +7543,8 @@ paths: settings for existing users in any way. **Changes**: New in Zulip 5.0 (feature level 96). + + [new-user-defaults]: /help/configure-default-new-user-settings x-curl-examples-parameters: oneOf: - type: include